OpenTelemetry SDKs

Mirador ingests OTLP directly, so you instrument with the standard OpenTelemetry SDK for your language. There is no Mirador package to install on the server, and no proprietary API to migrate off later. Every SDK below reads the same four environment variables:

export OTEL_SERVICE_NAME=checkout-api
export OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
export OTEL_EXPORTER_OTLP_ENDPOINT=https://otel.mirador.org
export OTEL_EXPORTER_OTLP_HEADERS=Authorization=mir_srv_xxx

Create a server key (mir_srv_*) on your project’s API keys page in the Mirador dashboard. See Authentication for the Bearer form and web-key rules.

Languages

JavaScript / Node.js

Auto-instrumentation for Express, Fastify, HTTP, gRPC, Postgres, and more

Python

Zero-code startup via opentelemetry-instrument

Go

Explicit SDK setup with otelhttp and otelgrpc middleware

Java

Drop-in -javaagent with no code changes

.NET

OpenTelemetry.Extensions.Hosting plus OTLP exporter

Rust

opentelemetry-otlp with the tracing ecosystem

Ruby

opentelemetry-sdk with Rails and Rack instrumentation

PHP

Extension-based auto-instrumentation

Erlang / Elixir

opentelemetry_exporter for BEAM services

Swift

Server-side and Apple platform instrumentation

C++

OTLP HTTP and gRPC exporters

Collector

Already running a Collector? Add Mirador as an exporter

Install and run

npm install @opentelemetry/sdk-node \
            @opentelemetry/auto-instrumentations-node \
            @opentelemetry/exporter-trace-otlp-http

export OTEL_SERVICE_NAME=checkout-api
export OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
export OTEL_EXPORTER_OTLP_ENDPOINT=https://otel.mirador.org
export OTEL_EXPORTER_OTLP_HEADERS=Authorization=mir_srv_xxx

node --require @opentelemetry/auto-instrumentations-node/register app.js

pip install opentelemetry-distro opentelemetry-exporter-otlp
opentelemetry-bootstrap -a install

export OTEL_SERVICE_NAME=checkout-api
export OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
export OTEL_EXPORTER_OTLP_ENDPOINT=https://otel.mirador.org
export OTEL_EXPORTER_OTLP_HEADERS=Authorization=mir_srv_xxx

opentelemetry-instrument python app.py

go get go.opentelemetry.io/otel \
       go.opentelemetry.io/otel/sdk \
       go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp

export OTEL_SERVICE_NAME=checkout-api
export OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
export OTEL_EXPORTER_OTLP_ENDPOINT=https://otel.mirador.org
export OTEL_EXPORTER_OTLP_HEADERS=Authorization=mir_srv_xxx

go run .

curl -L -O https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent.jar

export OTEL_SERVICE_NAME=checkout-api
export OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
export OTEL_EXPORTER_OTLP_ENDPOINT=https://otel.mirador.org
export OTEL_EXPORTER_OTLP_HEADERS=Authorization=mir_srv_xxx

java -javaagent:./opentelemetry-javaagent.jar -jar app.jar

dotnet add package OpenTelemetry.Extensions.Hosting
dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol
dotnet add package OpenTelemetry.Instrumentation.AspNetCore

export OTEL_SERVICE_NAME=checkout-api
export OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
export OTEL_EXPORTER_OTLP_ENDPOINT=https://otel.mirador.org
export OTEL_EXPORTER_OTLP_HEADERS=Authorization=mir_srv_xxx

dotnet run

bundle add opentelemetry-sdk opentelemetry-exporter-otlp opentelemetry-instrumentation-all

export OTEL_SERVICE_NAME=checkout-api
export OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
export OTEL_EXPORTER_OTLP_ENDPOINT=https://otel.mirador.org
export OTEL_EXPORTER_OTLP_HEADERS=Authorization=mir_srv_xxx

bundle exec ruby app.rb

With OTEL_EXPORTER_OTLP_ENDPOINT=https://otel.mirador.org, standards-compliant HTTP exporters append /v1/traces, /v1/metrics, and /v1/logs automatically. Signal-specific variables such as OTEL_EXPORTER_OTLP_TRACES_ENDPOINT must include the full path.

Add web3 correlation

Once telemetry is flowing, emit a reserved mirador.* span event when an external action starts. Mirador follows the action and stitches its outcome back into the same trace, which is how on-chain and off-chain steps end up on one timeline.

span.addEvent('mirador.web3.evm.txhint', {
  'tx.hash': transactionHash,
  'chain.id': 8453, // or 'base'
});

span.add_event("mirador.web3.evm.txhint", {
    "tx.hash": transaction_hash,
    "chain.id": 8453,
})

span.AddEvent("mirador.web3.evm.txhint", trace.WithAttributes(
    attribute.String("tx.hash", transactionHash),
    attribute.Int64("chain.id", 8453),
))

EVM, Solana, Canton, Safe, Relay, Stripe, and market rates are supported. See Enrichment hints for the full event catalog and required attributes.

Next steps

OpenTelemetry overview

Endpoints, authentication, and Collector setup

Enrichment hints

Track on-chain and external actions from OTel spans

Logs

Export structured logs and correlate them with traces

Web SDK

Browser telemetry with wallet and provider capture

Getting Started

OpenTelemetry

Web SDK

Web3 Integration

Payments & Market Data

Automations

AI & Agents

Best Practices

Languages

JavaScript / Node.js

Python

Go

Java

.NET

Rust

Ruby

PHP

Erlang / Elixir

Swift

C++

Collector

Install and run

Add web3 correlation

Next steps

OpenTelemetry overview

Enrichment hints

Logs

Web SDK

​Languages

JavaScript / Node.js

Python

Go

Java

.NET

Rust

Ruby

PHP

Erlang / Elixir

Swift

C++

Collector

​Install and run

​Add web3 correlation

​Next steps

OpenTelemetry overview

Enrichment hints

Logs

Web SDK

Languages

Install and run

Add web3 correlation

Next steps