Skip to main content

Documentation Index

Fetch the complete documentation index at: https://private-7c7dfe99-page-updates.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

✅ Logs✖️ Metrics✖️ Traces
🚧 OpenTelemetry metrics & tracing instrumentation coming soon!

​
Getting started

​
Install ClickStack logger backend package

The package can be installed by adding hyperdx to your list of dependencies in mix.exs: 
def deps do
  [
    {:hyperdx, "~> 0.1.6"}
  ]
end

​
Configure logger

Add the following to your config.exs file: 
# config/releases.exs

config :logger,
  level: :info,
  backends: [:console, {Hyperdx.Backend, :hyperdx}]

​
Configure environment variables

Afterwards you’ll need to configure the following environment variables in your shell to ship telemetry to ClickStack via the OpenTelemetry collector: 
OTEL_SERVICE_NAME='<NAME_OF_YOUR_APP_OR_SERVICE>'
The OTEL_SERVICE_NAME environment variable is used to identify your service in the HyperDX app, it can be any name you want.