All Classes and Interfaces
Class
Description
Organization and service-account helpers (
OpenObserveClient.admin()).Authenticated request helper shared by the OpenObserve service modules: adds the Basic
Authorization header, maps OpenObserve error bodies (JSON or plain text, vendor codes on HTTP
400) to SDK exceptions and keeps the secret values that error messages must never contain.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.One Elasticsearch-style bulk action for
Logs.ingestBulk(java.util.List<codes.grow.packages.openobserve.logs.BulkAction>).Outcome of one bulk action.
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.openobserve.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).The most frequent values of one field.
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).One histogram bucket.
Options of
Logs.histogram(java.lang.String).Record count per time bucket.
Callbacks invoked for every HTTP attempt (SPEC section 2.5).
The HTTP engine shared by every client of the SDK (SPEC section 2.3), built on
HttpClient.Per-stream outcome of an ingest call.
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.
LogExporter that writes records to an OpenObserve stream through the _json ingest
API (the default exporter of OpenObserveClient.logClient()).JUnit 5 adapter: one dynamic test per scenario.
Options of
Streams.listStreams().Sends log records to the service in the background.
Options of
OpenObserveClient.logClient(LogClientOptions): target stream (default the
configured stream), exporter protocol (_json by default, or OTLP/HTTP JSON), batching,
resource attributes and redaction.Builder of
LogClientOptions.Exporter protocol of a log client.
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.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).Log ingestion and SQL search of OpenObserve (
OpenObserveClient.logs()).Builder of
LogTailOptions.The record does not exist (HTTP 404).
Client for OpenObserve.
Builder that configures and creates a client in one chain.
Immutable configuration of a
OpenObserveClient (SPEC section 2.2).Builder of the configuration.
Base class of every error raised by the OpenObserve SDK (SPEC section 2.1).
LogQueryClient for one OpenObserve log stream (OpenObserveClient.logQuery()).TraceQueryClient for one OpenObserve traces stream (
OpenObserveClient.traceQuery()).OpenTelemetry tracing that exports to OpenObserve: OTLP/HTTP protobuf to
<url>/api/<org>/v1/traces (default) or OTLP/gRPC to port 5081 of the same host, with the Basic
Authorization header, the stream-name header (the configured traces stream) and,
for gRPC, the organization header.Executes one scenario step and returns its result (or an
OpResult).A step result with optional extra views for the expectations
count and tree.An OpenObserve organization.
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.LogExporter that sends OTLP/HTTP JSON (ExportLogsServiceRequest) to
/api/{org}/v1/logs with a stream-name header.A partition key of a stream.
The caller's ingest-only credential: Basic
user:passcode may ingest but not search or
administer.The credentials lack a permission (HTTP 403).
Generic polling helper (
pollUntil): used by waitForLog, waitForTrace and
service waiters.The service rate-limited the call (HTTP 429); see
OpenObserveException.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.
One field of a stream schema.
Package identity used in the
User-Agent header.Options of
LogQueryClient.search(java.lang.String, codes.grow.packages.openobserve.logging.SearchOptions): time range, limit (default 100), order, cursor.Builder for
SearchOptions.A credential held in a
char[] that never prints itself.A listed service account (the server masks its token, so it is not returned).
A service account with its usable token.
Log severity with the OpenTelemetry severity numbers.
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.openobserve.tracing.query.Span>)).Options of
Spans.withSpan(java.lang.String, codes.grow.packages.openobserve.tracing.ThrowingSupplier<T, E>): attributes, kind, links, tracer, parent context.Builder for
SpanOptions.Span helpers on top of the OpenTelemetry API.
Options of
Logs.search(java.lang.String).Builder of
SqlSearchOptions.One page of an OpenObserve SQL search.
Everything an
OpHandler needs for one step.A stream with its schema, settings and statistics.
One page of streams.
Stream management of OpenObserve (
OpenObserveClient.streams()).Settings of a stream.
Changes to stream settings (
Streams.updateStreamSettings(java.lang.String, codes.grow.packages.openobserve.logs.StreamSettingsUpdate)).Builder of
StreamSettingsUpdate.Storage statistics of a stream.
Type of an OpenObserve stream (the
type query parameter).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).
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).
Reads traces back from the service.
Span ordering and tree helpers.
Filter of
TraceQueryClient.searchTraces(codes.grow.packages.openobserve.tracing.query.TraceSearchQuery) (limit defaults to 20).Builder for
TraceSearchQuery.Search result entry.
Where and when the server's trace index saw a trace.
Sets up the OpenTelemetry SDK from a
TracingConfig.Immutable tracing setup used by
Tracing.initWith(codes.grow.packages.openobserve.tracing.TracingConfig, codes.grow.packages.openobserve.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.openobserve.tracing.TracingConfig, codes.grow.packages.openobserve.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).
One distinct value with its number of records.
Value helpers shared by the OpenObserve service modules: name normalization, SQL quoting, time
conversion (OpenObserve uses Unix microseconds) and JSON conversions.
Options of
Logs.valuesOf(java.lang.String, java.util.List<java.lang.String>): time window (default the last 15 minutes) and the maximum
number of distinct values per field (default 10).