Add better explanation for how to configure extension classes #8898
Conversation
It was not obvious how to apply some of the examples listed in the readme. Added some config that is available without a customizer, but also linked to the demo customizer since that was missing before.
examples/extension/README.md
Outdated
|
|
||
| | System property | Environment variable | Value | | ||
| |----------------------|----------------------|----------------------------------------| | ||
| | otel.traces.exporter | OTEL_TRACES_EXPORTER | com.example.javaagent.DemoSpanExporter | |
There was a problem hiding this comment.
did you verify that these values would work or did you just guess that these values should work?
There was a problem hiding this comment.
I didn't verify... sorry.
Perhaps they could be added to the unit tests somehow?
There was a problem hiding this comment.
the extension project has tests already, can you check those?
There was a problem hiding this comment.
I think you should verify whether these work. I'd assume that otel.propagators uses the name from the provider
DemoSpanExporter doesn't have a provider at probably can't be configured this way.
There was a problem hiding this comment.
After further consideration, I opted to remove the settings table and only document the customizer since that allows better encapsulation within the extension.
There was a problem hiding this comment.
I've updated the explanation per @mateuszrzeszutek's feedback. I've also verified that the otel.propagators setting is used in the unit tests so I referenced that one specifically where the others are applied dynamically.
This keeps the customization encapsulated within the extension.
Also add better formatting for links to demo classes.
It was not obvious how to apply some of the examples listed in the readme. Added some config that is available without a customizer, but also linked to the demo customizer since that was missing before.