Uses of Class
org.microproxy.otel.Telemetry.Builder

Packages that use Telemetry.Builder

Package	Description
org.microproxy.otel	OpenTelemetry for MicroProxy, with no dependencies but the JDK: W3C Trace Context, B3 and Jaeger propagation (Propagators), sampling (Sampler), a SERVER span per exchange and a CLIENT span per attempt to reach the server, INTERNAL spans for tunnels and flows, and OTLP/HTTP export of traces, metrics (the proxy's StatsRegistry) and access logs, as protobuf or JSON (Telemetry).

Uses of Telemetry.Builder in org.microproxy.otel

Methods in org.microproxy.otel that return Telemetry.Builder

Modifier and Type	Method	Description
static Telemetry.Builder	Telemetry.builder()	Returns a builder with the defaults: everything exported to http://localhost:4318.
Telemetry.Builder	Telemetry.Builder.compression(boolean gzip)	Gzips the exports (OTEL_EXPORTER_OTLP_COMPRESSION=gzip).
Telemetry.Builder	Telemetry.Builder.enabled(boolean enabled)	Turns everything on (the default) or off; off, Telemetry.install(org.microproxy.HttpProxyServerBootstrap) changes nothing.
Telemetry.Builder	Telemetry.Builder.endpoint(String endpoint)	The collector's OTLP/HTTP base URL; each signal goes to <endpoint>/v1/<signal>.
Telemetry.Builder	Telemetry.Builder.forceTraceHeader(String header)	Samples every request that has header, whatever the sampler says (Envoy's x-envoy-force-trace); none by default.
static Telemetry.Builder	Telemetry.fromEnvironment()	A builder configured from the process's environment (OTEL_* variables, see Telemetry.fromEnvironment(Map)).
static Telemetry.Builder	Telemetry.fromEnvironment(Map<String,String> env)	A builder configured from env, OpenTelemetry's environment variables: OTEL_SDK_DISABLED, OTEL_SERVICE_NAME, OTEL_RESOURCE_ATTRIBUTES, OTEL_EXPORTER_OTLP_ENDPOINT and OTEL_EXPORTER_OTLP_{TRACES,METRICS,LOGS}_ENDPOINT, OTEL_EXPORTER_OTLP_PROTOCOL, OTEL_EXPORTER_OTLP_HEADERS, OTEL_EXPORTER_OTLP_COMPRESSION, OTEL_EXPORTER_OTLP_TIMEOUT, OTEL_{TRACES,METRICS,LOGS}_EXPORTER (otlp or none), OTEL_TRACES_SAMPLER and OTEL_TRACES_SAMPLER_ARG, OTEL_PROPAGATORS, OTEL_METRIC_EXPORT_INTERVAL, OTEL_BSP_* and OTEL_BLRP_* ( SCHEDULE_DELAY, MAX_QUEUE_SIZE, MAX_EXPORT_BATCH_SIZE), and the span limits (OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT, OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT, OTEL_SPAN_EVENT_COUNT_LIMIT, OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT).
Telemetry.Builder	Telemetry.Builder.header(String name, String value)	Adds a header to every export, such as authorization.
Telemetry.Builder	Telemetry.Builder.logFormat(AccessLogFormat format)	The body of exported log records: an access-log format; Envoy's default by default.
Telemetry.Builder	Telemetry.Builder.logQueue(int maxQueue, int maxBatch, Duration delay)	The log record queue (OTEL_BLRP_*): 2048, 512 and 1 s by default.
Telemetry.Builder	Telemetry.Builder.logs(boolean on)	Whether access-log records are exported as log records (OTEL_LOGS_EXPORTER).
Telemetry.Builder	Telemetry.Builder.logsEndpoint(String url)	The URL log records go to, as it is.
Telemetry.Builder	Telemetry.Builder.metricInterval(Duration interval)	How often metrics are exported (OTEL_METRIC_EXPORT_INTERVAL, 60 s).
Telemetry.Builder	Telemetry.Builder.metricPrefix(String prefix)	The prefix of exported metric names; the registry's (envoy) by default.
Telemetry.Builder	Telemetry.Builder.metrics(boolean on)	Whether the proxy's stats are exported as metrics (OTEL_METRICS_EXPORTER).
Telemetry.Builder	Telemetry.Builder.metricsEndpoint(String url)	The URL metrics go to, as it is.
Telemetry.Builder	Telemetry.Builder.propagators(List<Propagator> propagators)	The propagators, as OpenTelemetry's composite propagator: they extract in order, so the last that finds a valid context in a request gives the parent, and all write the proxy's context upstream; W3C Trace Context by default.
Telemetry.Builder	Telemetry.Builder.protocol(Telemetry.Protocol protocol)	How OTLP is sent: protobuf (the default) or JSON.
Telemetry.Builder	Telemetry.Builder.requestId(Telemetry.RequestIdMode mode)	What happens to X-Request-Id: kept, or made when missing (the default), always made, or left alone.
Telemetry.Builder	Telemetry.Builder.resourceAttribute(String key, String value)	A resource attribute (OTEL_RESOURCE_ATTRIBUTES), besides service.*, host.name, process.* and telemetry.sdk.*, which it may override.
Telemetry.Builder	Telemetry.Builder.retry(int maxAttempts, Duration initial, Duration max)	How failed exports are retried: attempts in all (5 by default), and the backoff between them, growing by half each time from initial (1 s) up to max (5 s), with jitter, and never shorter than a Retry-After.
Telemetry.Builder	Telemetry.Builder.sampler(Sampler sampler)	The sampler; parentbased_always_on by default.
Telemetry.Builder	Telemetry.Builder.serviceName(String name)	service.name (OTEL_SERVICE_NAME); microproxy by default.
Telemetry.Builder	Telemetry.Builder.spanLimits(SpanLimits limits)	The span limits.
Telemetry.Builder	Telemetry.Builder.spanQueue(int maxQueue, int maxBatch, Duration delay)	The span queue (OTEL_BSP_*): its size (2048), the largest batch (512) and how long a span waits for its batch to fill (5 s).
Telemetry.Builder	Telemetry.Builder.timeout(Duration timeout)	How long one export attempt may take, connecting included (10 seconds by default).
Telemetry.Builder	Telemetry.Builder.traces(boolean on)	Whether spans are exported (OTEL_TRACES_EXPORTER); without them the proxy still propagates.
Telemetry.Builder	Telemetry.Builder.tracesEndpoint(String url)	The URL spans go to, as it is (OTEL_EXPORTER_OTLP_TRACES_ENDPOINT).
Telemetry.Builder	Telemetry.Builder.trustIncoming(boolean trust)	Whether to continue the traces clients send (the default), or start a new trace for every request, as a trust boundary.
Telemetry.Builder	Telemetry.Builder.whenStripped(Telemetry.WhenStripped mode)	What goes upstream when the proxy strips tracing headers: the proxy's own context (the default) or nothing.