[DOCS] Describe common use cases for functionbeat #12539
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dedemorton
added
in progress
|
@acchen97 I've added a couple of diagrams. Not sure which ingest node processors make sense to show for these examples, though. Can you suggest a few to give a realistic pipeline example in the diagram? |
acchen97
reviewed
Jun 18, 2019
acchen97
reviewed
Jun 18, 2019
|
|
||
| . The structured events are indexed into an {es} cluster. | ||
|
|
||
| image::./images/functionbeat-pipeline-cloudwatchlogs.png["{beatname_uc} collects events generated by CloudWatch logs"] |
acchen97
reviewed
Jun 18, 2019
acchen97
reviewed
Jun 18, 2019
|
Thanks @dedemorton. Shaping up nicely, left a few comments. @kvch and @ph may have have more real-world processor/pipeline examples for these use cases. |
kvch
approved these changes
Jun 25, 2019
dedemorton
added a commit
to dedemorton/beats
that referenced
this pull request
Jun 25, 2019
* [DOCS] Describe common use cases for functionbeat * Add diagrams * Comment out section that is not yet true
dedemorton
removed
the
needs_backport
dedemorton
added a commit
that referenced
this pull request
Jun 25, 2019
leweafan
pushed a commit
to leweafan/beats
that referenced
this pull request
Apr 28, 2023
…astic#12681) * [DOCS] Describe common use cases for functionbeat * Add diagrams * Comment out section that is not yet true
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #11867.
The text is ready to review, but I still need to add a couple diagrams, so I'm marking this as in progress.
TODO:
@acchen97 I decided to break this content out into sections so that it will scale as we add support for more use cases that we want to highlight. I also think that adding sections helps users who are scanning the content. I struggled with the notion of presenting use cases without telling folks how to implement them. My compromise was to describe how the data passes through the parts of the stack. I plan to add diagrams so that folks who like to scan can see quickly which parts of the stack are relevant to the use case.
The svg diagram shown here is from the functionbeat page: https://www.elastic.co/products/beats/functionbeat
I'm trying to locate the source so I can use the same images/fonts in the diagrams that show the processing pipeline.