sumologic-kubernetes-collection
sumologic-kubernetes-collection copied to clipboard
Documentation detailing components and their purpose
Is your feature request related to a problem? Please describe. Having used FluentBit/FluentD in the Sumologic collection stack for a number of years its difficult even when reading the migration documentation exactly what is the purpose of each component. The documentation has always assumed a lot of existing knowledge but with the introduction of a number of new components alongside deprecated components and optional components it has become more difficult to understand what is necessary.
Describe the solution you'd like It would be useful to have a clear table of what purpose each component serves, whether they are optional, how and when to scale them, their deprecation status, and any integrations they have, for example:
- remote-write-proxy: appears to be used to push Prometheus metrics to FluentD
- traces-gateway: isn't explained anywhere and the chart configuration has the helpful statement description "Flag to control deploying traces-gateway"
Describe alternatives you've considered I've searched the entire repo trying to understand the interactions between components.
- an architecture diagram would be useful
- a table indicating: what purpose each component serves, whether they are optional, when to scale them, their deprecation status, and any integrations they have with other components
- improve descriptions of the configuration options
Additional context Add any other context or screenshots about the feature request here. The remoteWriteProxy is described as "This is an advanced feature, enable only ..." that is enabled by default
Totally agree, I am interested only by the pure logs and maybe kube event and there are too manny charts and we don't understand what does what, very hard to maintain.
We'll improve documentation but in the meantime I hope that this doc will help.