[Request]: Update "Define deployment modes" page to have filestream example
Closed this issue · 6 comments
Description
The filebeat's log input which was deprecated in favor of the filestream input in 7.16 should also be reflected within the example documentation to make sure that if/when we remove logfile support (potentially in 9.0)
The example in question starts here:
location: https://github.com/elastic/observability-docs/blob/363af381dc2de59051fcf4af78937c8f47bf202a/docs/en/integrations/build-integration.asciidoc?plain=1#L189
We need to give a more modern example for filestream so that any new development won't steer contributions into integration to a deprecated mode of operation
Resources
You can use the filestream documentation to help formulate a proper example variable declaration
Which documentation set does this change impact?
Integrations
Feature differences
This is a part of integrations and is just an update to a legacy integration practice.
What release is this request related to?
N/A
Collaboration model
The documentation team
Point of contact.
Main contact: @qcorporation
@jlind23 Is there a developer who might be able to provide a new version of the hide_in_deployment_modes example (from the Integrations Developer Guide) that uses filestream? I'm out of my element here. :-)
Not urgent, by the way. Whenever someone has some time.
@belimawr might probably be best to assists here.
cc @pierrehilbert
@kilfoyle do you mean something like that:
streams:
- input: filestream
vars:
- name: paths
type: text
title: Paths
multi: true
required: true
show_user: true
default:
- /var/log/my-package/*.log
- name: agentless_only
type: text
title: Agentless only variable
multi: false
required: false
show_user: true
hide_in_deployment_modes:
- default
- name: hidden_in_agentless
type: text
title: Hidden in agentless variable
multi: false
required: false
show_user: true
hide_in_deployment_modes:
- agentless
Or are you looking for something more specific?
Thanks @belimawr!
@qcorporation, it seems we just need to change the input type from logfile
to filestream
for the example to be up to date, so I can make that change. Is that what you had in mind?
@kilfoyle I agree, as long as the rest of the configurations work with the new input type - then we are good
The other question I have is if there are other configuration examples that also use logfile
and should be found and changed.
@qcorporation The example you found will be fixed by elastic/observability-docs#4228
I'll check the Fleet & Elastic Agent docs (which are in this repo) for other examples using that use logfile
and I'll fix whatever I find. Offhand I don't think there are any, so we should be good. Since this issue is specifically for the "Define deployment modes" page, I'll close it when the above PR is merged, which will fix the page in main
and any future releases.