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
clj-otel-sdk-common
Instrumentation modules
- clj-otel-instrumentation-runtime-telemetry-java8
- clj-otel-instrumentation-runtime-telemetry-java17
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.

clj-otel-sdk-common is an optional module which provides programmatic configuration in Clojure of OpenTelemetry SDK common components such as Resource objects. This module is used when configuring some exporters.

Instrumentation modules

These are optional modules which implement instrumentation for applications not using the instrumentation agent.

`clj-otel-instrumentation-runtime-telemetry-java8`

Provide access to OpenTelemetry instrumentation of the JVM runtime for Java 8+.

`clj-otel-instrumentation-runtime-telemetry-java17`

Provide access to OpenTelemetry instrumentation of the JVM runtime for Java 17+.

Extension modules

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

`clj-otel-contrib-aws-resources`

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

`clj-otel-contrib-aws-xray-propagator`

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:

`clj-otel-instrumentation-resources`

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

`clj-otel-sdk-extension-autoconfigure`

Provides access to OpenTelemetry SDK configuration using environment variables and system properties.

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

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

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 instrumentation agent and should not be added to applications which are run with the agent.