[DOCS-14081] Updates to Grok Parser doc#37806
Conversation
Preview links (active after the
|
This comment has been minimized.
This comment has been minimized.
|
|
||
| To write parsing rules manually, in the {{< ui >}}Create Parsing Rule{{< /ui >}} modal: | ||
|
|
||
| 1. Click {{< ui >}}write rules manually{{< /ui >}}. |
There was a problem hiding this comment.
"write rules manually" is not capitalized in the UI so it's not capitalized here.
evazorro
left a comment
There was a problem hiding this comment.
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.
| 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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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?
| - 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. |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
Small thing: I don't see the reference a library rule dropdown in the screenshot below this procedure; should it be there?
There was a problem hiding this comment.
Ah, so that dropdown only shows up after a rule has been created.
Does this make it clearer?
| 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. |
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. |
There was a problem hiding this comment.
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?
| - 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. |
There was a problem hiding this comment.
Ah, so that dropdown only shows up after a rule has been created.
Does this make it clearer?
| 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. |
|
Thanks @evazorro for the review! I applied your suggestions and responded to these two comments: |
| 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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Ah okay, thanks for the heads up! That change would also make the docs flow better.
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:
<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./reviewto run an automated check that catches common issues before a Documentation team member reviews your PR.AI assistance
Additional notes