All Classes and Interfaces
Class
Description
Fluent builder of an
AggregateQuery (SigNoz requestType scalar, or
time_series with AggregateBuilder.step).One bucket of a time series.
A count/percentile query for
SignozQueryClient.aggregate(AggregateQuery).Result of
SignozQueryClient.aggregate(AggregateQuery): rows for scalar queries,
series for time series (AggregateBuilder.step).One group of a scalar aggregate.
One time series of a time-series aggregate.
One aggregate expression with the name its values get in the result.
Normalises attribute values (
AttrValue) into the kinds the SDK accepts.Missing or invalid credentials (HTTP 401).
Builder for
BatchingLogClient.Options of a
BatchProcessor.Builder for
BatchOptions.Queues log records and exports them in batches from one background thread (a single-threaded
ScheduledExecutorService).Counters of a
BatchProcessor.The caller cancelled the operation (future cancelled, thread interrupted, client closed).
Invalid or missing configuration.
Conflicting write or check-and-set mismatch (HTTP 409, 412).
The operations of one scenario category (
core, secrets, logging,
tracing) for the ConformanceRunner.Results of a conformance run.
Result of one scenario.
Outcome of a scenario or step.
Result of one step.
Runs the shared conformance scenarios (
conformance/scenarios/*.json, SPEC section 6)
against targets supplied by a service's integration test.Builder for
ConformanceRunner.Conformance operations of the
core category: health, ping,
serverVersion, close.A target of the
core conformance category that is not the service client: a fake for unit
tests of the runner, or an adapter for a client whose core methods differ.A service dependency edge.
What
BatchProcessor.add(codes.grow.packages.signoz.logging.LogRecord) does when the queue is full.Why records were dropped (argument of
BatchOptions.Builder.onDrop).Reads configuration from environment variables (SPEC section 2.2).
Canonical error codes shared by every Grow Codes SDK (SPEC section 2.1).
Service hook that replaces the error
HttpTransport derived from a failed response, for
vendor-specific mapping (for example a 403 that means bad credentials, or a 500 whose body says
the request will never succeed).Evaluates the
expect object of a scenario step (SPEC section 6).Renders SigNoz filter expressions (query builder v5 search syntax), for example
java.util.logging handler that forwards records to a LogClient.Log4j 2 appender plugin (
<GrowLog name="grow"/>) that forwards events to a LogClient (Log4j is an optional, provided dependency).Logback appender that forwards events to a
LogClient (Logback is an optional,
provided dependency).Implements the
health() contract (SPEC section 2.4): never throws for an unhealthy or
unreachable service, only for CancelledException and ConfigException.Result of
health() (SPEC section 2.4).Callbacks invoked for every HTTP attempt (SPEC section 2.5).
Data passed to
Hooks.onError(codes.grow.packages.signoz.core.Hooks.ErrorInfo).The HTTP engine shared by every client of the SDK (SPEC section 2.3), built on
HttpClient.LogExporter that keeps every accepted record in memory.LogQueryClient over in-memory records (usually InMemoryLogExporter.records()).SpanExporter that keeps finished spans in memory.TraceQueryClient over in-memory spans (usually InMemorySpanExporter.spans()),
including a dependency graph computed from parent/child spans of different services.Shared Jackson configuration of the SDK.
JUnit 5 adapter: one dynamic test per scenario.
Sends log records to the service in the background.
Options of
SignozClient.logClient(LogClientOptions) and SignozClient.createLogClient(SignozConfig, LogClientOptions): resource attributes, batching,
redaction and export overrides.Builder of
LogClientOptions.Sends batches of log records to the service.
A log field known to SigNoz.
Minimal logger used by the transport (SPEC section 2.5).
Small logging facade on top of a
LogClient.Conformance operations of the
logging category: send, sendBatch,
flush, searchUntil, stats.Target of the
logging conformance scenarios: the client that sends and the (optional)
query client that reads back.Short form of a log record: a message plus optional severity, attributes, timestamp and trace
ids.
Builder for
LogInput.A raw logs query for
SignozQueryClient.queryLogs(codes.grow.packages.signoz.LogQuery).Builder of
LogQuery.Reads logs back from the service.
One immutable log record in the normalized SDK form (OpenTelemetry log data model).
Builder for
LogRecord.Converts
LogRecord to and from the normalized JSON wire form (
spec/schemas/log-record.schema.json).The record does not exist (HTTP 404).
Executes one scenario step and returns its result (or an
OpResult).A step result with optional extra views for the expectations
count and tree.Converts SDK attribute values (
AttrValue: String, numbers, Boolean, lists, maps) into
OpenTelemetry Attributes.OTLP span exporters (gRPC and HTTP/protobuf) configured from a
TracingConfig: endpoint,
headers, compression, export timeout and TLS.OTLP export protocol used for logs and traces sent to the SigNoz collector.
The credentials lack a permission (HTTP 403).
Generic polling helper (
pollUntil): used by waitForLog, waitForTrace and
service waiters.Result of
SignozQueryClient.queryRange(java.lang.String, java.lang.String, codes.grow.packages.signoz.SignozQueryClient.Window, java.util.Map<java.lang.String, java.lang.Object>): the data member of the response envelope
and the server warnings.The service rate-limited the call (HTTP 429); see
SignozException.retryAfter().Redaction helpers for headers, URLs, structured fields and free text (SPEC section 2.6).
Redacts log records before they are queued.
Builder for
RedactionProcessor.Retry settings with full-jitter exponential backoff (SPEC section 2.3).
Builder for
RetryPolicy.A parsed conformance scenario (
conformance/scenarios/*.json).One step of a scenario.
Package identity used in the
User-Agent header.Options of
LogQueryClient.search(java.lang.String, codes.grow.packages.signoz.logging.SearchOptions): time range, limit (default 100), order, cursor.Builder for
SearchOptions.A credential held in a
char[] that never prints itself.Log severity with the OpenTelemetry severity numbers.
SigNoz telemetry signal of a query-builder query.
Client for SigNoz:
SignozClient.health(), SignozClient.ping(), SignozClient.serverVersion(), the query client
(SignozClient.query(), also as SignozClient.logs() and SignozClient.traces()), OTLP log clients (SignozClient.logClient(LogClientOptions)) and tracing (SignozClient.initTracing(TracingConfig)).Builder that configures and creates a client in one chain.
Immutable configuration of a
SignozClient (SPEC section 2.2).Builder of the configuration.
Base class of every error raised by the SigNoz SDK (SPEC section 2.1).
LogExporter that sends records to the SigNoz collector over OTLP/HTTP protobuf (
POST <endpoint>/v1/logs) or OTLP/gRPC (LogsService/Export), with the
signoz-ingestion-key header when an ingestion key is configured.Query client of the SigNoz query API (
SIGNOZ-API-KEY auth): logs and spans through
POST /api/v5/query_range, traces through the waterfall API, services and operations through v5
aggregations, dependencies through /api/v1/dependency_graph, log fields through
/api/v1/fields/* and live tail through /api/v3/logs/livetail.OpenTelemetry tracing that exports spans to the SigNoz collector over OTLP (gRPC or HTTP
protobuf).
A span as returned by a
TraceQueryClient (normalized model; not the OpenTelemetry API
span).Span event.
Span kind (wire values are lower case).
Span link.
Span status.
Status code (wire values are lower case).
Converts OpenTelemetry SDK
SpanData into the normalized query Span.Creates the span exporter for a
TracingConfig (see OtlpExporters.factory()).A span with its children (see
Traces.buildTree(java.util.List<codes.grow.packages.signoz.tracing.query.Span>)).Options of
Spans.withSpan(java.lang.String, codes.grow.packages.signoz.tracing.ThrowingSupplier<T, E>): attributes, kind, links, tracer, parent context.Builder for
SpanOptions.Result of
SignozQueryClient.queryTraces(codes.grow.packages.signoz.TraceQuery): one span per matching span.Span helpers on top of the OpenTelemetry API.
Everything an
OpHandler needs for one step.Creates the object a scenario runs against (client, provider, log client, tracing handle).
A runnable that may throw.
A supplier that may throw.
A connect, request or total deadline was exceeded (or HTTP 408, 504).
A query time window.
TLS settings: custom CA, client certificate (mutual TLS) and the test-only
insecureSkipVerify.Builder for
TlsOptions.A trace: its id and its spans sorted by start time, then span id.
Tracing of plain functions:
Traced.run(String, Callable) and the Traced.Method
annotation honoured by TracedProxy.Marks an interface method (or its implementation) to run in a span when called through a
TracedProxy.Wraps a
HttpClient: every request runs in a client span and carries the propagation
headers.Proxy-based interceptor that runs methods annotated with Traced.Method (on the
interface or on the implementation) in a span.Trace and span id normalisation (lower-case hex; 64-bit trace ids are left-padded to 32).
A raw spans query for
SignozQueryClient.queryTraces(codes.grow.packages.signoz.TraceQuery).Builder of
TraceQuery.Reads traces back from the service.
Span ordering and tree helpers.
Filter of
TraceQueryClient.searchTraces(codes.grow.packages.signoz.tracing.query.TraceSearchQuery) (limit defaults to 20).Builder for
TraceSearchQuery.Search result entry.
Sets up the OpenTelemetry SDK from a
TracingConfig.Immutable tracing setup used by
Tracing.initWith(codes.grow.packages.signoz.tracing.TracingConfig, codes.grow.packages.signoz.tracing.SpanExporterFactory).Span batch processor settings.
Builder for
TracingConfig.Export body compression.
Export protocol.
Sampler (OpenTelemetry
OTEL_TRACES_SAMPLER names).Jakarta Servlet filter that continues the caller's trace (W3C/B3 headers per the configured
propagators) and records one server span per request (Servlet API is a
provided
dependency).Running tracing setup returned by
Tracing.initWith(codes.grow.packages.signoz.tracing.TracingConfig, codes.grow.packages.signoz.tracing.SpanExporterFactory).OkHttp interceptor (OkHttp is an optional dependency) that runs each call in a client span and
adds the propagation headers.
Conformance operations of the
tracing category: span, flush,
getTraceUntil, listServices.Target of the
tracing conformance scenarios.Settings of one
HttpTransport.Builder for
TransportConfig.One logical HTTP call executed by
HttpTransport (with retries).Builder for
TransportRequest.A response returned by
HttpTransport (2xx or an accepted status).Network error or HTTP 500, 502, 503.
The service or deployment does not offer this capability (HTTP 501).
The request or a value is invalid (HTTP 400, 413, 422, other 4xx).