-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add missing using instrumentation libraries pages: Erlang/Elixir (#4371)
Co-authored-by: Phillip Carter <[email protected]>
- Loading branch information
1 parent
8eef800
commit 01e59c5
Showing
2 changed files
with
59 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
title: Using instrumentation libraries | ||
linkTitle: Libraries | ||
weight: 40 | ||
cSpell:ignore: Ecto Hex | ||
--- | ||
|
||
{{% docs/languages/libraries-intro "Erlang" %}} | ||
|
||
## Use instrumentation libraries | ||
|
||
If a library doesn't include OpenTelemetry support, you can use | ||
[instrumentation libraries](/docs/specs/otel/glossary/#instrumentation-library) | ||
to generate telemetry data for a library or framework. | ||
|
||
For example, | ||
[the instrumentation library for Ecto](https://github.com/open-telemetry/opentelemetry-erlang-contrib/tree/main/instrumentation/opentelemetry_ecto) | ||
automatically creates [spans](/docs/concepts/signals/traces/#spans) based on | ||
queries. | ||
|
||
## Setup | ||
|
||
Each instrumentation library is distributed as a Hex package. To install an | ||
instrumentation, add the dependency to your `mix.exs` file. For example: | ||
|
||
```elixir | ||
def deps do | ||
[ | ||
{:opentelemetry_{package}, "~> 1.0"} | ||
] | ||
end | ||
``` | ||
|
||
Where `{package}` is the name of the instrumentation. | ||
|
||
Note that some instrumentation packages might have prerequisites. Check the | ||
documentation of each instrumentation package for further instructions. | ||
|
||
## Available instrumentation libraries | ||
|
||
For a full list of instrumentation libraries, see the | ||
[list of Hex packages](https://hex.pm/packages?search=opentelemetry&sort=recent_downloads). | ||
|
||
You can also find more instrumentations available in the | ||
[registry](/ecosystem/registry/?language=erlang&component=instrumentation). | ||
|
||
## Next steps | ||
|
||
After you have set up instrumentation libraries, you might want to add your own | ||
[instrumentation](/docs/languages/erlang/instrumentation) to your code, to | ||
collect custom telemetry data. | ||
|
||
You might also want to configure an appropriate exporter to | ||
[export your telemetry data](/docs/languages/erlang/exporters) to one or more | ||
telemetry backends. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters