Instrument Erlang/Elixir applications with OpenTelemetry

Add the following dependencies to your rebar.config file:

erlangcopydownload
{deps, [{opentelemetry_api, "~> 1.0.0"},
        {opentelemetry, "~> 1.0.0"},
        {opentelemetry_exporter, "~> 1.0.0"}]}.

Add the following dependencies to your src/<PROJ_NAME>.app.src file:

erlangcopydownload
{applications, [kernel,
                stdlib,
                opentelemetry_api,
                opentelemetry,
                opentelemetry_exporter]}

Set names for the span and add attributes as you see fit.

erlangcopydownload
-export([hello/0]).
-include_lib("opentelemetry_api/include/otel_tracer.hrl").
-include_lib("opentelemetry/include/otel_resource.hrl").

hello() ->
    ?with_span(<<"my-span">>, #{attributes => [{<<"my-key-1">>, <<"my-value-1">>}]}, fun(_ChildSpanCtx) -> %%TODO Add attributes
        ?set_attributes([{<<"child-key-1">>, <<"child-value-1">>}]) %%TODO Add attributes
    end).

Add the following dependencies to your mix.exs file:

elixircopydownload
defp deps do
    [
        {:opentelemetry_api, "~> 1.0"},
        {:opentelemetry, "~> 1.0"},
        {:opentelemetry_exporter, "~> 1.0"}
    ]
end

Also add a releases section to your mix.exs file:

elixircopydownload
def application do
    [
        extra_applications: [:logger],
        mod: {<PROJ_NAME>.Application, []},
        releases: [
            otel_getting_started: [
            version: "0.0.1",
            applications: [otel_getting_started: :permanent]
            ]
        ]
    ]
end

Set names for the span and add attributes as you see fit.

elixircopydownload
require OpenTelemetry.Tracer, as: Tracer

def hello do
  Tracer.with_span "my-span", %{attributes: [{<<"my-key-1">>, <<"my-value-1">>}]} do #TODO add attributes
    Tracer.set_attributes([{"another-key-1", "another-value-1"}]) #TODO add attributes
  end
end

To send data to Dynatrace with OneAgent, add the following configuration to your config/sys.config file:

erlangcopydownload
[
  {otel_getting_started, []},

  {opentelemetry,
    [{processors,
      [{otel_batch_processor,
        #{exporter => {opentelemetry_exporter, #{endpoints =>
          ["http://localhost:14499/otlp"]}
        }}
      }]
    },
    {resource,
      [{service,
        #{name => "erlang-quickstart", version => "1.0.1"} %%TODO Replace with the name and version of your application
      }]
    }]
  }
].

When using OneAgent, make sure to enable the public Extension Execution Controller in your Dynatrace Settings, otherwise no data will be sent.

In the Dynatrace menu, go to Settings > Preferences > Extension Execution Controller. The toggles Enable Extension Execution Controller and Enable local PIPE/HTTP metric and Log Ingest API should be active.

To send data to Dynatrace without OneAgent, add the following configuration to your config/sys.config file:

erlangcopydownload
[
  {otel_getting_started, []},

  {opentelemetry,
    [{processors,
      [{otel_batch_processor,
        #{exporter => {opentelemetry_exporter, #{endpoints =>
          ["https://<URL>:443/api/v2/otlp"], %%TODO Replace <URL> to your SaaS/Managed-URL as mentioned in the next step
          headers => [{"Authorization", "Api-Token <TOKEN>"}]} %%TODO Replace <TOKEN> with your API Token as mentioned in the next step
        }}
      }]
    },
    {resource,
      [{service,
        #{name => "erlang-quickstart", version => "1.0.1"} %%TODO Replace with the name and version of your application
      }]
    }]
  }
].

Lastly, you need to define the correct endpoint and token, to make sure your data arrives where it should be.

• To set the endpoint:
  1. Use your Environment ID to set the endpoint to which your app will send traces as follows:
  • Dynatrace SaaS https://{your-environment-id}.live.dynatrace.com:443/api/v2/otlp
  • Dynatrace Managed https://{your-domain}:443/e/{your-environment-id}/api/v2/otlp
  2. Replace <URL> in the code snippet above with your endpoint.
• To create an authentication token
  1. In the Dynatrace menu, go to Access tokens and select Generate new token.
  2. Provide a Token name.
  3. In the Search scopes box, search for Ingest OpenTelemetry traces and select the checkbox.
  4. Select Generate token.
  5. Select Copy to copy the token to your clipboard.
  6. Save the token in a safe place; you can't display it again.
  7. Replace <TOKEN> in the code snippet above with your token.

To send data to Dynatrace with OneAgent, edit your config/config.exs file (or create the file if it does not already exist) and add the following configuration:

elixircopydownload
import Config

config :opentelemetry, :resource,
  service: %{name: "elixir-quickstart", version: "1.0.1"} #TODO Replace with the name and version of your application

config :opentelemetry, :processors,
   otel_batch_processor: %{
     exporter: {:opentelemetry_exporter, %{endpoints: ["http://localhost:14499/otlp"]}}
   }

When using OneAgent, make sure to enable the public Extension Execution Controller in your Dynatrace Settings, otherwise no data will be sent.

In the Dynatrace menu, go to Settings > Preferences > Extension Execution Controller. The toggles Enable Extension Execution Controller and Enable local PIPE/HTTP metric and Log Ingest API should be active.

To send data to Dynatrace without OneAgent, edit your config/config.exs file (or create the file if it does not already exist) and add the following configuration:

elixircopydownload
import Config

config :opentelemetry, :resource,
  service: %{name: "elixir-quickstart", version: "1.0.1"} #TODO Replace with the name and version of your application

config :opentelemetry, :processors,
  otel_batch_processor: %{
    exporter: {:opentelemetry_exporter, %{endpoints: ["<URL>:443/api/v2/otlp"], #TODO Replace <URL> to your SaaS/Managed-URL as mentioned in the next step
                                          headers: [{"Authorization", "Api-Token <TOKEN>"}]}} #TODO Replace <TOKEN> with your API Token as mentioned in the next step
  }

Lastly, you need to define the correct endpoint and token, to make sure your data arrives where it should be.

• To set the endpoint:
  1. Use your Environment ID to set the endpoint to which your app will send traces as follows:
  • Dynatrace SaaS https://{your-environment-id}.live.dynatrace.com:443/api/v2/otlp
  • Dynatrace Managed https://{your-domain}:443/e/{your-environment-id}/api/v2/otlp
  2. Replace <URL> in the code snippet above with your endpoint.
• To create an authentication token
  1. In the Dynatrace menu, go to Access tokens and select Generate new token.
  2. Provide a Token name.
  3. In the Search scopes box, search for Ingest OpenTelemetry traces and select the checkbox.
  4. Select Generate token.
  5. Select Copy to copy the token to your clipboard.
  6. Save the token in a safe place; you can't display it again.
  7. Replace <TOKEN> in the code snippet above with your token.