All Classes and Interfaces
Class
Description
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.Build information of the server (
/loki/api/v1/status/buildinfo).The caller cancelled the operation (future cancelled, thread interrupted, client closed).
Keeps Loki's index small: only allowlisted names become index labels, everything else is sent as
structured metadata (per entry, not indexed).
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.Sort order of log query results.
An entry the tail stream dropped because the client fell behind.
What
BatchProcessor.add(codes.grow.packages.loki.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).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.loki.core.Hooks.ErrorInfo).Data passed to
Hooks.onRequest(codes.grow.packages.loki.core.Hooks.RequestInfo).The HTTP engine shared by every client of the SDK (SPEC section 2.3), built on
HttpClient.Approximate index statistics (
LokiClient.indexStats(java.lang.String)).LogExporter that keeps every accepted record in memory.LogQueryClient over in-memory records (usually InMemoryLogExporter.records()).Shared Jackson configuration of the SDK.
JUnit 5 adapter: one dynamic test per scenario.
Label helpers: validation, normalization and Prometheus label-set rendering.
Options of
LokiClient.labels() and LokiClient.labelValues(java.lang.String).Builder of
LiveTailOptions.Sends log records to the service in the background.
Sends batches of log records to the service.
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.How a
log client ships records.Immutable LogQL query builder with safe escaping.
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).Client for Grafana Loki: push (JSON, protobuf + Snappy, OTLP), LogQL queries, labels, series,
index stats and volume, WebSocket tail, status, multi-tenancy and the logging category (
LokiClient.logClient(), LokiClient.logQueryClient()).Builder that configures and creates a client in one chain.
Immutable configuration of a
LokiClient (SPEC section 2.2).Builder of the configuration.
One log line of a
LokiStream.Base class of every error raised by the Grafana Loki SDK (SPEC section 2.1).
Options of
LokiClient.logClient(LokiLogClientOptions).Builder of
LokiLogClientOptions.LogExporter of the logging category that writes records with POST
/loki/api/v1/push.LogQueryClient of the logging category on top of the Loki query API: search
(query_range, merge-sorted across streams, cursor pagination), tail (WebSocket),
listStreams (series), listLabels (labels) and waitForLog.LogExporter that writes OTLP/JSON to POST /otlp/v1/logs.A non-transient server-side failure with code
ErrorCode.UNAVAILABLE and
retryable=false.A Loki log stream (
LokiStream): one label set and its entries, the input of LokiClient.push(java.util.List<codes.grow.packages.loki.LokiStream>).Handle of an open tail stream (
LokiClient.tail(java.lang.String, java.util.function.Consumer<codes.grow.packages.loki.TailFrame>)).One series of a
matrix result.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.The credentials lack a permission (HTTP 403).
Generic polling helper (
pollUntil): used by waitForLog, waitForTrace and
service waiters.Options of
LokiClient.query(java.lang.String) (instant metric queries).Builder of
QueryOptions.Options of
LokiClient.queryRange(java.lang.String) (log and metric range queries).Builder of
QueryRangeOptions.The service rate-limited the call (HTTP 429); see
LokiException.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.Result type of a Loki query.
Retry settings with full-jitter exponential backoff (SPEC section 2.3).
Builder for
RetryPolicy.One metric sample.
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.loki.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.
Everything an
OpHandler needs for one step.One log entry returned by a query or the tail stream.
One stream of a
streams result.One frame of the tail WebSocket.
Creates the object a scenario runs against (client, provider, log client, tracing handle).
A connect, request or total deadline was exceeded (or HTTP 408, 504).
A time window for
LokiClient.series(java.util.List<java.lang.String>), LokiClient.indexStats(java.lang.String) and the label calls.TLS settings: custom CA, client certificate (mutual TLS) and the test-only
insecureSkipVerify.Builder for
TlsOptions.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).
One series of a
vector result.How volumes are grouped.
Builder of
VolumeOptions.