Skip to content

DOCS-1852 - Document colon-delimited Metric Rules match expressions - #7096

Open
JV0812 wants to merge 5 commits into
mainfrom
DOCS-1852
Open

DOCS-1852 - Document colon-delimited Metric Rules match expressions#7096
JV0812 wants to merge 5 commits into
mainfrom
DOCS-1852

Conversation

@JV0812

@JV0812 JV0812 commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator

Purpose of this pull request

Documents the colon-delimiter support for Metric Rules match expressions and variable extractions, per SUMO-292913 (enabling the metrics.rules.parser.enable.extended.delimiters flag).

  • Renamed "Dot-delimited match expressions" → "Dot- and colon-delimited match expressions" (and the matching "Extract variables from..." section) to cover both delimiters, with a colon example using an AWS ARN string (the motivating use case per the SCR).
  • Added a note that a colon-delimited match expression matching no time series may mean the flag isn't enabled for the account yet (per SUMO-292913, colon-delimited expressions fail silently without it).
  • Updated internal anchor links and the greedy-matching and step-by-step sections to reflect that colon works the same as dot.

Verified via yarn build (no broken links/anchors).

Select the type of change

  • Minor Changes - Typos, formatting, slight revisions
  • Update Content - Revisions, updating sections
  • New Content - New features, sections, pages, tutorials
  • Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

Ticket (if applicable)

https://sumologic.atlassian.net/browse/DOCS-1852

Metric Rules match expressions and variable extractions now also
support colon (:) as a segment delimiter, alongside dot, gated
behind metrics.rules.parser.enable.extended.delimiters (SUMO-292913).
Useful for colon-separated identifiers like AWS ARNs. Adds a note
that a colon-delimited expression matching nothing may mean the flag
isn't enabled yet for the account.
@JV0812 JV0812 self-assigned this Sep 3, 2026
@cla-bot cla-bot Bot added the cla-signed Contributor approved, listed in .clabot file label Sep 3, 2026
Microsoft Manual of Style outranks Chicago in our style guide's
reference precedence, and Microsoft recommends against suspended
compound modifiers outside space-constrained contexts. Spells out
"dot-delimited or colon-delimited" in full instead of "dot- or
colon-delimited", and adds a Word List entry so this doesn't need
re-litigating.
Comment thread docs/contributing/word-list.md Outdated
Comment thread docs/metrics/metric-rules-editor.md Outdated
Comment thread docs/contributing/word-list.md Outdated
- metric-rules-editor.md: "a match expression can be a dot-delimited
  or colon-delimited string" (was "one or more ... string",
  singular/plural mismatch).
- word-list.md: closing period now inside the quote, matching the
  first example and the file's existing convention.
@JV0812
JV0812 requested a review from kimsauce September 4, 2026 06:28
Comment thread docs/metrics/metric-rules-editor.md Outdated
…g is GA

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

@kimsauce kimsauce left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the colon-delimiter docs change. Content is accurate and the anchor/link updates are consistent. A few small things inline: one consistency question on the non-_rawName bullet, a heads-up on the changed heading anchor, and an em dash in the new Word List entry. — via Claude Code

1. In the **Define variables** section of the page, for each tag you want to apply to matching metrics, enter a meaningful tag name in the **Variable name** field on the left. In the **Tag sequence** field, assign a variable to the tag. There are two different formats for specifying the Tag Sequence.
* To pull a tag from a dot-delimited string in the metric's `_rawName` field, use `$_1` to extract the first segment of the string, `$_2` to extract the second segment of the string, and so on.  For more information, see [Extracting variables from a dot-delimited match expression](#extract-variables-from-a-dot-delimited-match-expression).
* To pull a tag from a dot-delimited or colon-delimited string in the metric's `_rawName` field, use `$_1` to extract the first segment of the string, `$_2` to extract the second segment of the string, and so on.  For more information, see [Extracting variables from a dot-delimited or colon-delimited match expression](#extract-variables-from-a-dot-delimited-or-colon-delimited-match-expression).
* To pull a tag from a dot-delimited string in metric field other than `_rawName` field, use `$FieldName._1` to extract the first segment of the string, `$FieldName._2` to extract the second segment of the string, and so on. For more information, see [Extracting variables from a key-value pair match expression](#extract-variables-from-a-key-value-pair-match-expression).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This second bullet (non-_rawName fields, $FieldName._1) still says "dot-delimited" only. Does the colon delimiter apply here too, or is it _rawName-only? Worth making it match the bullet above either way. — via Claude Code

A metric match expression defines the scope of the rule. Put another way, the match expression specifies the metrics to which the tags (defined by variable extraction) will be applied. 

### Dot-delimited match expressions
### Dot-delimited or colon-delimited match expressions

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Renaming this heading changes its anchor to #dot-delimited-or-colon-delimited-match-expressions. Internal refs are updated, but any external bookmarks/inbound links to #dot-delimited-match-expressions will break. Just a heads-up. — via Claude Code

### Dot-delimited or colon-delimited match expressions

A match expression can be one or more dot-delimited string, like this: `collectd.*.*.*.*`, which matches all Graphite metrics that have five segments in the string, where the value of the first segment is `collectd`.
A match expression can be a dot-delimited or colon-delimited string. For example, `collectd.*.*.*.*` matches all Graphite metrics that have five segments in the string, where the value of the first segment is `collectd`. Colon-delimited match expressions work the same way, and are useful for colon-separated identifiers such as AWS ARNs, for example: `arn:aws:bedrock-agentcore:*:*:*`.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

arn:aws:bedrock-agentcore:*:*:* with $_4 = region checks out (arn / aws / service / region / account / resource). "Colon-delimited match expressions work the same way" slightly restates the first sentence; could drop it. — via Claude Code


**Sumo Logic**. For all references, always use "Sumo Logic," never "Sumo" alone, including in the possessive. This helps our SEO, which is essential for a SaaS offering. To be more conversational, "we" is also fine.

**Suspended hyphens**. Avoid these in body text — spell out both compound modifiers in full: "dot-delimited or colon-delimited," not "dot- or colon-delimited."

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Em dash here, and the Em dash entry above says we avoid them. Suggest: Avoid these in body text. Spell out both compound modifiers in full: "dot-delimited or colon-delimited," not "dot- or colon-delimited." — via Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed Contributor approved, listed in .clabot file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants