fluent-bit icon indicating copy to clipboard operation
fluent-bit copied to clipboard

More YAML configuration documentation

Open epsteina16 opened this issue 1 year ago • 8 comments

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.

epsteina16 avatar Jan 29 '24 19:01 epsteina16

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

lecaros avatar Jan 29 '24 19:01 lecaros

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.

epsteina16 avatar Feb 06 '24 13:02 epsteina16

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 avatar Feb 12 '24 09:02 patrick-stephens

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

patrick-stephens avatar Feb 12 '24 10:02 patrick-stephens

Can parsers also be configured using YAML?

uberjew666 avatar Mar 15 '24 10:03 uberjew666

Not yet but they will be.

patrick-stephens avatar Mar 15 '24 11:03 patrick-stephens

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?

epsteina16 avatar Apr 19 '24 17:04 epsteina16

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.

patrick-stephens avatar Apr 22 '24 10:04 patrick-stephens

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] avatar Jul 22 '24 01:07 github-actions[bot]

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

github-actions[bot] avatar Jul 28 '24 01:07 github-actions[bot]