Liking cljdoc? Tell your friends :D
Clojure only.

steffan-westcott.clj-otel.exporter.zipkin

Span data exporter to Zipkin.

Span data exporter to Zipkin.
raw docstring

span-exporterclj

(span-exporter)
(span-exporter {:keys [endpoint read-timeout sender encoder local-ip-address-fn
                       compression meter-provider internal-telemetry-version]})

Returns a span exporter that sends span data using the io.zipkin.reporter2:zipkin-reporter library. May take an option map as follows:

keydescription
:endpointWith the default sender, Zipkin endpoint e.g. "http://zipkinhost:9411/api/v2/spans" (default: "http://localhost:9411/api/v2/spans").
:read-timeoutWith the default sender, maximum time to wait for export of a batch of spans. Value is either a Duration or a vector [amount ^TimeUnit unit] (default: 10s).
:senderzipkin2.reporter.BytesMessageSender used to send span data (default: OkHttpSender instance with :compression, :endpoint and :read-timeout config).
:encoderzipkin2.reporter.BytesEncoder Format used to send span data (default: SpanBytesEncoder/JSON_V2).
:local-ip-address-fn0-arg function that returns nil or InetAddress of local Zipkin endpoint (default: fn that returns local IP address captured when exporter created).
:compressionMethod used to compress payloads. Value is string "gzip" or "none" (default: "gzip").
:meter-provider^MeterProvider to collect metrics related to export (default: metrics not collected).
:internal-telemetry-versionSelf-monitoring telemetry to export, either :legacy or :latest (default: :legacy).
Returns a span exporter that sends span data using the
[`io.zipkin.reporter2:zipkin-reporter`](https://github.com/openzipkin/zipkin-reporter-java)
library. May take an option map as follows:

| key                         | description |
|-----------------------------|-------------|
|`:endpoint`                  | With the default sender, Zipkin endpoint e.g. `"http://zipkinhost:9411/api/v2/spans"` (default: `"http://localhost:9411/api/v2/spans"`).
|`:read-timeout`              | With the default sender, maximum time to wait for export of a batch of spans. Value is either a `Duration` or a vector `[amount ^TimeUnit unit]` (default: 10s).
|`:sender`                    | `zipkin2.reporter.BytesMessageSender` used to send span data (default: `OkHttpSender` instance with `:compression`, `:endpoint` and `:read-timeout` config).
|`:encoder`                   | `zipkin2.reporter.BytesEncoder` Format used to send span data (default: `SpanBytesEncoder/JSON_V2`).
|`:local-ip-address-fn`       | 0-arg function that returns `nil` or `InetAddress` of local Zipkin endpoint (default: fn that returns local IP address captured when exporter created).
|`:compression`               | Method used to compress payloads. Value is string `"gzip"` or `"none"` (default: `"gzip"`).
|`:meter-provider`            | ^MeterProvider to collect metrics related to export (default: metrics not collected).
|`:internal-telemetry-version`| Self-monitoring telemetry to export, either `:legacy` or `:latest` (default: `:legacy`).
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close