Skip to content

[DOCS-14081] Updates to Grok Parser doc#37806

Open
maycmlee wants to merge 9 commits into
masterfrom
may/grok-parser-updates-ai
Open

[DOCS-14081] Updates to Grok Parser doc#37806
maycmlee wants to merge 9 commits into
masterfrom
may/grok-parser-updates-ai

Conversation

@maycmlee

Copy link
Copy Markdown
Contributor

What does this PR do? What is the motivation?

Merge readiness

  • Updates Grok Parser doc with new features

  • Adds images

  • Ready for merge

For Datadog employees:

  • ⚠️ Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). If you've already created your PR with an incorrect branch name, please rename your branch and open a fresh PR.
  • 🤖 New: Comment with /review to run an automated check that catches common issues before a Documentation team member reviews your PR.

AI assistance

Additional notes

@maycmlee maycmlee requested a review from a team as a code owner June 26, 2026 20:46
@maycmlee maycmlee added the WORK IN PROGRESS No review needed, it's a wip ;) label Jun 26, 2026
@github-actions github-actions Bot added the Images Images are added/removed with this PR label Jun 26, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Preview links (active after the build_preview check completes)

Modified Files

@datadog-datadog-prod-us1-2

This comment has been minimized.

@maycmlee maycmlee changed the title [DOCS-14081] Updates to doc and add images [DOCS-14081] Updates to Grok Parser doc Jun 29, 2026

To write parsing rules manually, in the {{< ui >}}Create Parsing Rule{{< /ui >}} modal:

1. Click {{< ui >}}write rules manually{{< /ui >}}.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

"write rules manually" is not capitalized in the UI so it's not capitalized here.

@evazorro evazorro removed the WORK IN PROGRESS No review needed, it's a wip ;) label Jun 30, 2026

@evazorro evazorro left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks really good! Left a few small suggestions/questions.

One higher-level thing: after my manual review, I ran our PR review skill on this, and it flagged that you're using a few different terms on this page: "AI-generated parsing rules" (line 19), "AI-assisted" (line 52), "AI rule generator" (lines 61, 64), and "AI-created rules" (line 63). I didn't find it particularly confusing, but apparently it can be easier for agents to not have to reconcile multiple different terms.

Comment thread content/en/observability_pipelines/processors/grok_parser.md Outdated
1. Review the parsed log in the {{< ui >}}Preview Changes{{< /ui >}} panel.
1. Click {{< ui >}}Generate New Rule{{< /ui >}} to re-run the AI rule generator or manually update the rule so the log is parsed correctly. See [Parsing][1] for information on writing parsing rules.
<br>**Notes**:
- If you re-run the AI rule generator, a new rule is created. You must manually delete previously AI-created rules if you don't want them.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm a little confused by this sentence: "You must manually delete previously AI-created rules if you don't want them."

Can you say more? Do the generated rules stack up in the UI?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

If you re-run the AI rule generator, it'll create a new rule and won't delete the previous one so you must manually delete AI-created rules if you don't want them.

What do you think about this?

Suggested change
- If you re-run the AI rule generator, a new rule is created. You must manually delete previously AI-created rules if you don't want them.
- If you re-run the AI rule generator, a new rule is created, but the previous rule is not deleted so you must manually delete AI-generated rules if you don't want them.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think I like the previous version better, actually. I think it will make sense when seen in context (while using the product), so probably no further clarification needed

- If you re-run the AI rule generator, a new rule is created. You must manually delete previously AI-created rules if you don't want them.
- You can run the AI rule generator a maximum of three times per sample.
1. Repeat step 4 to create rules based on additional sample logs. See [Order of custom rules](#order-of-custom-rules) for information on how rule order determines which rule parses a log.
1. If you want to add library rules, select a library rule from the {{< ui >}}reference a library rule{{< /ui >}} dropdown menu. You can add multiple library rules. See [Library rules](#library-rules) for more information.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Small thing: I don't see the reference a library rule dropdown in the screenshot below this procedure; should it be there?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Ah, so that dropdown only shows up after a rule has been created.

Does this make it clearer?

Suggested change
1. If you want to add library rules, select a library rule from the {{< ui >}}reference a library rule{{< /ui >}} dropdown menu. You can add multiple library rules. See [Library rules](#library-rules) for more information.
1. After you add a rule, you can add library rules by selecting a library rule from the {{< ui >}}reference a library rule{{< /ui >}} dropdown menu. You can add multiple library rules. See [Library rules](#library-rules) for more information.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yes I like this!

Comment thread content/en/observability_pipelines/processors/grok_parser.md Outdated
Comment thread content/en/observability_pipelines/processors/grok_parser.md Outdated
Co-authored-by: Eva Parish <eva.parish@datadoghq.com>
1. Review the parsed log in the {{< ui >}}Preview Changes{{< /ui >}} panel.
1. Click {{< ui >}}Generate New Rule{{< /ui >}} to re-run the AI rule generator or manually update the rule so the log is parsed correctly. See [Parsing][1] for information on writing parsing rules.
<br>**Notes**:
- If you re-run the AI rule generator, a new rule is created. You must manually delete previously AI-created rules if you don't want them.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

If you re-run the AI rule generator, it'll create a new rule and won't delete the previous one so you must manually delete AI-created rules if you don't want them.

What do you think about this?

Suggested change
- If you re-run the AI rule generator, a new rule is created. You must manually delete previously AI-created rules if you don't want them.
- If you re-run the AI rule generator, a new rule is created, but the previous rule is not deleted so you must manually delete AI-generated rules if you don't want them.

- If you re-run the AI rule generator, a new rule is created. You must manually delete previously AI-created rules if you don't want them.
- You can run the AI rule generator a maximum of three times per sample.
1. Repeat step 4 to create rules based on additional sample logs. See [Order of custom rules](#order-of-custom-rules) for information on how rule order determines which rule parses a log.
1. If you want to add library rules, select a library rule from the {{< ui >}}reference a library rule{{< /ui >}} dropdown menu. You can add multiple library rules. See [Library rules](#library-rules) for more information.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Ah, so that dropdown only shows up after a rule has been created.

Does this make it clearer?

Suggested change
1. If you want to add library rules, select a library rule from the {{< ui >}}reference a library rule{{< /ui >}} dropdown menu. You can add multiple library rules. See [Library rules](#library-rules) for more information.
1. After you add a rule, you can add library rules by selecting a library rule from the {{< ui >}}reference a library rule{{< /ui >}} dropdown menu. You can add multiple library rules. See [Library rules](#library-rules) for more information.

Comment thread content/en/observability_pipelines/processors/grok_parser.md Outdated
@maycmlee

maycmlee commented Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

Thanks @evazorro for the review! I applied your suggestions and responded to these two comments:

  1. [DOCS-14081] Updates to Grok Parser doc #37806 (comment)
  2. [DOCS-14081] Updates to Grok Parser doc #37806 (comment)

@maycmlee maycmlee requested a review from evazorro July 1, 2026 22:13
Comment thread content/en/observability_pipelines/processors/grok_parser.md Outdated
@maycmlee

maycmlee commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

Thanks @evazorro! I left one as is and updated the other one (9d0edbd).

Comment on lines +46 to +50
1. Click {{< ui >}}Preview Library Rules{{< /ui >}} to preview preset rules for integrations. You can test out-of-the-box parsing rules with your log samples. See [Library rules](#library-rules) for more information.
1. Toggle {{< ui >}}Disable library rules{{< /ui >}} on the Grok Parser to disable all library parsing rules.
<br>**Notes**:
- You must create a custom parsing rule before you can disable library rules.
- Library rules are applied by default. Disable library rules only if you are relying on custom parsing rules.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Not a blocker at all, but just wanted to note that the instructions for the "Preview Library Rules" and "Disable library rules" workflows will eventually have to be tweaked when I revamp the previewing of library rules UI (this change is still in progress). Just wanted to give a heads-up on this, but I can also help start this docs change if you are OOO during the time I reach this step.

Image

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Ah okay, thanks for the heads up! That change would also make the docs flow better.

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

Labels

Images Images are added/removed with this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants