Metricbeat: Add compatibility notes where missing #7939
Conversation
jsoriano
added
needs_backport
jsoriano
force-pushed
the
doc-metricbeat-module-versions
branch
from
11dc87c
to
8f420c1
Compare
There was a problem hiding this comment.
Left two minor comments.
Long term idea: Have in the fields.yml file a compatbility: [1.4, 2.7] entry that we could use to generate the docs (not sure that is going to work in a nice way) but more importantly to generate a test matrix. Perhaps the compatibility: entry must be more complex to also contain platform, or other relevant entries.
| [float] | ||
| === Compatibility | ||
|
|
||
| The Ceph module is tested with Ceph Jewel |
There was a problem hiding this comment.
Could you add a dot at the end? I think also applies to more entries below. Should we also put a version number here? (10.2)?
There was a problem hiding this comment.
Added, added version number as in the docker image we use too.
| @@ -7,6 +7,9 @@ This file is generated! See scripts/docs_collector.py | |||
|
|
|||
| This module fetches metrics from https://www.docker.com/[Docker] containers. The default metricsets are: `container`, `cpu`, `diskio`, `healthcheck`, `info`, `memory` and `network`. The `image` metricset is not enabled by default. | |||
|
|
|||
| [float] | |||
| === Compability | |||
|
|
|||
| The Docker module is currently not tested on Windows. | |||
There was a problem hiding this comment.
Should we have any details around with which docker version we test?
There was a problem hiding this comment.
Added more details, though the versions are the ones in travis and jenkins.
|
Agree with having the list of versions for the test matrix. Not so sure for the compatibility notes because they are quite dependant on the services, I don't think we should autogenerate them. |
|
AFAICT Travis isn't building docs and this PR is all docs. Since Jenkins is green, I'm merging it. @jsoriano I added version labels for 7.0.0 and 6.5.0. Should this be backported to 6.4.0 as well (since its docs anyway)? |
|
We'd have to check if versions have changed, I'll take a look. |
|
@jsoriano Thanks very much for doing this! @ruflin If we decide to generate compatibility info, we should generate a file that contains asciidoc attributes for setting compatible versions (similar to what we do for version.asciidoc, but the file would be generated). Then we can just reference the attributes in the docs. |
|
@dedemorton I have my doubts we will be able to generated the docs automatically as the compatibility will be more complex then what we have in version.asciidoc. It can be also a range and potentially have things inside like |
|
@jsoriano I've backported this to 6.x. Which other branches (if any) should I backport this to? |
* Metricbeat: Add compatibility notes where missing, based on integration tests * Added review suggestions
* Metricbeat: Add compatibility notes where missing, based on integration tests * Added review suggestions
…7937 #7939 #7948 #7949 #7950) (#8188) * Reset modulename attribute at the end of a file (#7888) * Add safeguard related statements for max_backoff setting (#7889) * Add docs about append_fields (#7903) * Add docs about append_fields * Remove experimental tag from setup.template.json.enabled description * Metricbeat: Add compatibility notes where missing (#7939) * Metricbeat: Add compatibility notes where missing, based on integration tests * Added review suggestions * Add missing config options to Logstash section of reference.yml (#7883) Closes #3062 * Fix processor autodiscovery docs for Filebeat (#7937) { needs escaping as otherwise asciidoc will show an empty code block. * Add document for beat export dashboard (#7696) * Add document for beat export dashboard Follow up from #7239 * move to command reference * address review comments * review comments applied * apply review feedback * Replace golang with Go (#7948) I've been told that using "golang" instead of "Go" is considered a faux pas in some circles. :-) I've replaced instances in the external docs, but I did not update the changelog, readmes, or code files. * Minor fixes to attributes in module docs (#7949) * Add recommendation to avoid harvesting symlinks when dealing with file rotation (#7950)
ycombinator
removed
the
needs_backport
Add compatibility notes where missing based on versions tested in integration tests.