search

fluent / fluent-bit

Fast and Lightweight Logs and Metrics processor for Linux, BSD, OSX and Windows
https://fluentbit.io
Apache License 2.0
5.64k stars 1.54k forks source link

More YAML configuration documentation #8433

Closed epsteina16 closed 1 month ago

epsteina16 commented 7 months ago

Is your feature request related to a problem? Please describe. Many plugins and configuration sections are missing examples for YAML configuration. Here are some examples: https://docs.fluentbit.io/manual/administration/buffering-and-storage#configuration https://docs.fluentbit.io/manual/pipeline/outputs/file#configuration-file https://docs.fluentbit.io/manual/pipeline/outputs/loki#getting-started

Describe the solution you'd like It would be helpful to show all configuration snippets in both YAML and classic format. Maybe an option to toggle between them.

Additional context Now that YAML is production ready, it would help if it was documented as a first-class configuration format for wider adoption and ease of use.

lecaros commented 7 months ago

Hello @epsteina16, thanks for noting this. PRs are always welcome! :)

epsteina16 commented 6 months ago

Thanks for the response @lecaros We'd like to move to full YAML-based configuration, and having more documentation across the board would be very helpful for us and I'm sure others as well.

patrick-stephens commented 6 months ago

I think we all agree, it's more that it takes time to do and so contribution is always welcome for any plugins you're working with. OSS docs are a great way to contribute particularly for first time PRs.

patrick-stephens commented 6 months ago

Saying that I just checked and @nokute78 has been a very busy bee with adding a lot more: https://github.com/fluent/fluent-bit-docs/pulls

Thanks @nokute78

uberjew666 commented 5 months ago

Can parsers also be configured using YAML?

patrick-stephens commented 5 months ago

Not yet but they will be.

epsteina16 commented 4 months ago

Just checking in on this. Thanks @nokute78 for adding many examples! Is there a timeline for when a larger set of YAML examples will be added to the docs?

patrick-stephens commented 4 months ago

It would greatly speed things up if people can submit PRs proactively to add any missing examples. Docs PRs are a great and simple way to contribute to OSS.

github-actions[bot] commented 1 month ago

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 5 days. Maintainers can add the exempt-stale label.

github-actions[bot] commented 1 month ago

This issue was closed because it has been stalled for 5 days with no activity.