In #3433, @jamiehynds suggested:
It may also be worth calling out which inputs are supported by the integration. This come up occasionally with users - they have to go to the integration and manually determine which inputs are support. e.g. for some integrations users can ingest logs via API, S3 or log file.
Input types can be found in the manifest.yml for each integration. However, it's still not clear to me what the one-to-one comparison of the inputs you can find in the manifest.yml align with the inputs listed in the Filebeat docs referenced in #3433 (comment).
I don't know if I'm overthinking this, but (for example) I see four inputs for the System integration:
Based on Jamie's comment from the PR I would guess...
...but I don't know how to reference winlog and system/metrics.
As next steps, maybe we can:
- Work together separately to develop a one-to-one comparison of
inputs to the relevant reference docs
- Update the documentation guidelines to explain how to document inputs in READMEs
- Update all docs that have already been reworked to follow the new guidelines
cc @elastic/obs-docs
In #3433, @jamiehynds suggested:
Input types can be found in the
manifest.ymlfor each integration. However, it's still not clear to me what the one-to-one comparison of theinputsyou can find in themanifest.ymlalign with the inputs listed in the Filebeat docs referenced in #3433 (comment).I don't know if I'm overthinking this, but (for example) I see four inputs for the System integration:
Based on Jamie's comment from the PR I would guess...
logfile= Log Filehttpjson= REST API...but I don't know how to reference
winlogandsystem/metrics.As next steps, maybe we can:
inputsto the relevant reference docscc @elastic/obs-docs