[DOCS-10886] Add OP Custom Processor #29565
Conversation
layouts/shortcodes/observability_pipelines/processors/custom_processor.md
Outdated
Show resolved
Hide resolved
✅ Documentation Team ReviewThe documentation team has approved this pull request. Thank you for your contribution! |
|
Created DOCS-11049 for Docs Team review. |
There was a problem hiding this comment.
Hi @maycmlee this looks good! Thanks for being specific on what needs reviewed since that shortcode is used throughout it made it a lot easier :)
|
|
||
| To set up this processor: | ||
|
|
||
| Click **Manage custom processors**. |
There was a problem hiding this comment.
Should be: Add custom processor
Manage is for when you've already created processors prior. The first creation flow is clicking Add custom processor and going to step 1 on line 24
There was a problem hiding this comment.
Ah okay thanks. Removing this line and updating the two bullet points below.
|
|
||
| ##### Add a function | ||
|
|
||
| 1. Enter a name for the function. |
There was a problem hiding this comment.
Enter a name for your custom processor
| ##### Add a function | ||
|
|
||
| 1. Enter a name for the function. | ||
| 1. Add your script to modify your logs using [custom functions][10191]. |
There was a problem hiding this comment.
Can we add a section for using Library Functions?
"Select a Library Function to get started with example functions for popular use cases. Refer to this guide (link the guide we're creating) for more information."
There was a problem hiding this comment.
Updated. I said to "click Autofill with Example" instead of "Select a Library Function" because we don't mention anything about library function in the UI. I'll add a link to the guide once the guide is live.
| 1. Add your script to modify your logs using [custom functions][10191]. | ||
| 1. Optionally, check **Drop events on error** if you want to drop events that encounter an error during processing. | ||
| 1. Enter a sample log event. | ||
| 1. Click **Run** to process the log and see the output. |
There was a problem hiding this comment.
Click Run to preview how the functions will process the log. Once executed, you are able to see the expected output for the log.
What does this PR do? What is the motivation?
Add OP Custom Processor docs.
For docs review, just need the following:
Thanks!
Merge instructions
Merge readiness:
For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass in CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
To have your PR automatically merged after it receives the required reviews, add the following PR comment:
Additional notes