[docs] Update documentation copied from beats #2131
Conversation
There was a problem hiding this comment.
This looks great. Would you have a go at updating _meta/beat.yml (+ make update to update apm-server.yml and apm-server.docker.yml)? This can close out #2083 all in one go.
|
|
| # have the Elasticsearch output configured, you can simply uncomment the | ||
| # following line. | ||
| #xpack.monitoring.elasticsearch: | ||
| #monitoring.enabled: false |
There was a problem hiding this comment.
Sorry for the late response here. With the latest changes from libbeat, both options - xpack.monitoring and monitoring are supported, but xpack.monitoring will be deprecated from 7.1.0 on. Afaik we usually still document deprecated settings, so I suggest to document them both, but clearly mark the deprecated setting.
Also, when describing the new setting, could you please ensure to fully remove xpack also from the header and the description.
There was a problem hiding this comment.
We do typically document deprecated settings, but I chose to follow Beats lead by removing it from yml files and docs: elastic/beats/pull/11677+ elastic/beats/pull/11678. We can document the deprecated settings, but it will mean adding more complexities to the docs as this is beats documentation - which isn't necessarily a bad thing - just want you to be aware.
There was a problem hiding this comment.
I'm asking to see if there's any rhyme or reason as to why xpack was left in the yml files, or if that was an oversight.
There was a problem hiding this comment.
Thanks for checking @bmorelli25.
Up to you if you want to leave the yml+docs as they are, just wanted to ensure it wasn't removed by mistake and is streamlined with documenting other/future deprecated features and settings.
There was a problem hiding this comment.
Cool beans - I appreciate you bringing this up! I'm very curious to hear the thought process for why beats did this the way they did. Based on their answers, I'll figure out the path forward and determine what I need to or don't need to do.
Updating some docs copied from beats. Everything is pretty straight forward, though I have two comments:
My main concern is with the changes toedit: Just realized I was trying this inmonitoring-beats.asciidoc. Looks like Support shipping directly to monitoring cluster beats#9260 introduced a new class of settings namedmonitoring.*, which I can't get to work in APM Server. Can a dev confirm these doc changes should be left out for now?7.0, notmaster. This change works in master. Should we also updateapm-server.ymlto use the new settings name?make update-beats-docscommand to fail. To try and fix it, I updated the build_docs script to use the dockerized build command. This seems to work fine. Might make sense to update now that the.plversion has reached EOL.Related elastic/beats#11823
Closes #1957
Closes #2083