-
Notifications
You must be signed in to change notification settings - Fork 81
Doc: Add more configurable attributes #423
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Doc: Add more configurable attributes #423
Conversation
|
@andsel Let's review content together to make sure that content and context is correct for both beats and Elastic Agent. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
...of the name to the Beat version...
maybe, for cases that are not covered by :plugin-uc: Beats, we should define another uppercase not plural placeholder
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A similar problem, with singular beat is also present at https://github.com/logstash-plugins/logstash-input-beats/pull/423/files#diff-cae5619b3d18ec99c5ccd0a9f6de0c6d3f53343c64692444551a7d29da6863e7R154
|
Carry over note from #417: #417 (review) |
24715fa to
a160108
Compare
|
@andsel Those deeplinks aren't resolving correctly for me, so I made some guesses and changed more instances. Other place to discuss/resolve:
Noting here that you've already explained that the ECS section should use the |
a160108 to
871bdb7
Compare
docs/index.asciidoc
Outdated
| metricbeat-7.4.0. | ||
| of the metadata field and `%{[@metadata][version]}` sets the second part to | ||
| the {plugin-singular} version. For example: | ||
| metricbeat-7.4.0. or elastic_agent-7.14.0. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@andsel Will this work as documented? We're relying on metadata, so I think it might not.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@karenzone we should remove any reference to [@metadata][beat] and [@metadata][version] because the agent doesn't send that information
|
@andsel Ready for review. Also, I left a question inline. Thanks! |
871bdb7 to
8e39223
Compare
|
@andsel Do we have the info we need to wrap this up? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
HI @karenzone as described in the comment left inline, we should remove reference to metadata sent by beat in the case of agent
docs/index.asciidoc
Outdated
| metricbeat-7.4.0. | ||
| of the metadata field and `%{[@metadata][version]}` sets the second part to | ||
| the {plugin-singular} version. For example: | ||
| metricbeat-7.4.0. or elastic_agent-7.14.0. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@karenzone we should remove any reference to [@metadata][beat] and [@metadata][version] because the agent doesn't send that information
|
In that case, I think we could cut that part of WDYT? |
|
@andsel This approach is working so far. For the Versioned indices info, are you proposing that we remove that whole section for Agent for now? |
a7d7322 to
bfe307d
Compare
bfe307d to
22a7f8c
Compare
docs/index.asciidoc
Outdated
| the {plugin-uc} version. For example: | ||
| metricbeat-7.4.0. | ||
| of the metadata field and `%{[@metadata][version]}` sets the second part to | ||
| the {plugin-singular} version. For example: metricbeat-7.4.0. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@andsel Should this reflect the beats version (instead of the stack version)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[@metadata][version] field read from the remote beats is the version of the remote beat and not of the overall stack
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for validating. I will fix.
|
@andsel Thanks for clarifying some of the fine details. I've introduced conditional processing to handle the differences. Please let me know what you think. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From a content perspective it LGTM!
Maybe we should check how it renders
I always do that locally as part of content development, but it would be nice for you to see it, too. We can't generate docs until this PR is merged and the gem is published. However, I can do a close approximation. I will put that content into a PR with "do not merge" warnings so you can see it, too. Stay tuned! UPDATE: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
|
Published at v6.1.6: https://rubygems.org/gems/logstash-input-beats/versions/6.1.6-java |
Adds more attributes to allow for more content differentiation between Beats and Elastic Agent
Related: #422