opentelemetry-erlang-contrib/README.md

<p align="center"> <strong> <a href="https://github.com/open-telemetry/opentelemetry-erlang/blob/main/website_docs/getting-started.md">Getting Started<a/>   •   <a href="https://hexdocs.pm/opentelemetry_api/1.0.0-rc.2/OpenTelemetry.html">API Documentation<a/> </strong> </p> <p align="center"> <strong> <a href="CONTRIBUTING.md">Contributing<a/>   •   <a href="instrumentation/">Instrumentation<a/>   •   <a href="propagators/">Propagators<a/>   •   <a href="examples/">Examples<a/> </strong> </p>

Getting Started   •   API Documentation

Contributing   •   Instrumentation   •   Propagators   •   Examples

About this project

This is a repository for OpenTelemetry Erlang & Elixir contributions that are not part of the core repository and core distribution of the API and SDK.

Instrumentations

OpenTelemetry can collect tracing data using instrumentation. Vendors/Users can also create and use their own. Currently, OpenTelemetry supports automatic tracing for:

• opentelemetry-cowboy
• opentelemetry-phoenix
• opentelemetry-ecto

Supported Runtimes

OpenTelemetry requires OTP v21.3 and above.

See Elixir OTP Compatibility for supported OTP/Elixir combinations.

Contributing

We'd love your help!. Use tags [up-for-grabs][up-for-grabs-issues] and good first issue to get started with the project. Follow CONTRIBUTING guide to report issues or submit a proposal.

Useful links

• For more information on OpenTelemetry, visit: https://opentelemetry.io/
• For conventions used in OpenTelemetry traces, see the following readme.
• For help or feedback on this project, join us in GitHub Discussions, #otel-erlang-elixir channel in the CNCF slack, and #opentelemetry channel in the Elixir Lang slack
• Erlang SIG community page

License

Apache 2.0 - See LICENSE for more information.