Liking cljdoc? Tell your friends :D

API & Reference

All clj-otel modules and API documentation are hosted on Clojars and cljdoc. Click on the and badges below to see further information.

Most users will need the clj-otel-api module only for manual instrumentation.

Table of Contents

clj-otel-api
clj-otel-sdk
Extension modules
Exporter libraries and modules
- Java exporter libraries
- Clojure exporter modules

`clj-otel-api`

clj-otel-api is the main module of clj-otel. It provides an idiomatic Clojure wrapper of the OpenTelemetry API for manual instrumentation. It also offers support for Ring and Pedestal applications and support for asynchronous Clojure code.

`clj-otel-sdk`

clj-otel-sdk is an optional module which provides programmatic configuration of the OpenTelemetry SDK in Clojure.

Extension modules

These are optional modules used with clj-otel-sdk for programmatic configuration of the OpenTelemetry SDK in Clojure.

`clj-otel-sdk-extension-resources`

Provides access to Resource objects which describe the local host and running process.

`clj-otel-sdk-extension-aws`

Provides access to Resource objects which describe the execution environment on the Amazon Web Services (AWS) platform.

`clj-otel-sdk-extension-jaeger-remote-sampler`

Provides access to a Sampler that implements the Jaeger remote sampler type.

`clj-otel-extension-aws`

Provides access to a TextMapPropagator implementation of the AWS X-Ray Trace Header propagation protocol.

`clj-otel-extension-trace-propagators`

Provides access to TextMapPropagator implementations of these protocols:

OpenTracing Basic Tracers protocol
Jaeger propagation protocol
B3 propagation protocol

Exporter libraries and modules

These are optional exporters used with the OpenTelemetry SDK when the SDK is either autoconfigured or programmatically configured. Use the Java libraries for autoconfiguration or Clojure modules for programmatic configuration in Clojure.

These exporters are included in the OpenTelemetry auto-instrumentation agent and should not be added to applications which are run with the agent.

Java exporter libraries

`opentelemetry-exporter-otlp`

Configuration of span and metrics exporters using OTLP.

`opentelemetry-exporter-jaeger`

Configuration of span exporter to Jaeger using gRPC.

`opentelemetry-exporter-jaeger-thrift`

Configuration of span exporter to Jaeger using Thrift.

`opentelemetry-exporter-zipkin`

Configuration of span exporter to Zipkin.

`opentelemetry-exporter-logging`

Configuration of exporters that log using java.util.logging. Intended for debugging only.

`opentelemetry-exporter-logging-otlp`

Configuration of exporters that log OTLP in JSON format using java.util.logging. Intended for debugging only.

Clojure exporter modules

`clj-otel-exporter-otlp`

Configuration of span and metrics exporters using OTLP.

`clj-otel-exporter-jaeger-grpc`

Configuration of span exporter to Jaeger using gRPC.

`clj-otel-exporter-jaeger-thrift`

Configuration of span exporter to Jaeger using Thrift.

`clj-otel-exporter-zipkin`

Configuration of span exporter to Zipkin.

`clj-otel-exporter-logging`

Configuration of exporters that log using java.util.logging. Intended for debugging only.

`clj-otel-exporter-logging-otlp`

Configuration of exporters that log OTLP in JSON format using java.util.logging. Intended for debugging only.

❮Guides Concepts❯

Can you improve this documentation?Edit on GitHub

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts

`Ctrl`+`k`	Jump to recent docs
`←`	Move to previous article
`→`	Move to next article
`Ctrl`+`/`	Jump to the search field

Raise an issue Browse cljdoc source Chat on Slack

× close