wavefront-adapter-for-istio icon indicating copy to clipboard operation
wavefront-adapter-for-istio copied to clipboard

Documentation: Document the various config parameters and their use case

Open akodali18 opened this issue 5 years ago • 3 comments

Need to document the configuration params in https://github.com/vmware/wavefront-adapter-for-istio/blob/master/install/wavefront/values.yaml#L15 in more detail. (especially for "prefix")

akodali18 avatar Mar 19 '19 01:03 akodali18

This is documented in some detail at https://github.com/vmware/wavefront-adapter-for-istio/tree/master/install/wavefront#configuration-parameters. It'd be great to add more details, and maybe an example to make it more clear.

venilnoronha avatar Mar 19 '19 01:03 venilnoronha

From your suggestion offline - "it’d be good to have a separate document with more detailed explanation of the configuration options. We can link to this new doc in both the standard and the Helm readmes."

akodali18 avatar Mar 19 '19 01:03 akodali18

Thanks both. I think examples would work better or at least an explanation to show how the adapter works. I guess it re-direct matched "metrics tag" and "prefix to prepend all metrics" to wavefront perhaps?

shawnho1018 avatar Mar 21 '19 09:03 shawnho1018