Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- acceptAnyStatus() - Method in class codes.grow.packages.loki.core.TransportRequest.Builder
-
Returns every status to the caller (health probes); no status is retried.
- accepted() - Method in record class codes.grow.packages.loki.logging.ExportResult
-
Returns the value of the
acceptedrecord component. - accepts(int) - Method in class codes.grow.packages.loki.core.TransportRequest
-
Returns whether a non-2xx status is returned to the caller instead of raising an error.
- acceptStatus(int...) - Method in class codes.grow.packages.loki.core.TransportRequest.Builder
-
Returns these statuses to the caller instead of raising an error (no retries for them).
- add(LogRecord) - Method in class codes.grow.packages.loki.logging.BatchProcessor
-
Queues a record.
- addKeys(String...) - Method in class codes.grow.packages.loki.logging.RedactionProcessor.Builder
-
Adds key fragments to the current list.
- aggregateBy() - Method in class codes.grow.packages.loki.VolumeOptions
-
Returns the grouping.
- aggregateBy(VolumeOptions.AggregateBy) - Method in class codes.grow.packages.loki.VolumeOptions.Builder
-
Sets the grouping.
- ALL_STREAMS_SELECTOR - Static variable in class codes.grow.packages.loki.LokiLogQueryClient
-
Selector used for free-text searches and
LokiLogQueryClient.listStreams(). - allowed() - Method in class codes.grow.packages.loki.CardinalityGuard
-
Returns the allowlist, sorted.
- allowedLabels() - Method in class codes.grow.packages.loki.LokiConfig
-
Returns the cardinality guard allowlist: label names that may become index labels.
- allowedLabels() - Method in class codes.grow.packages.loki.LokiLogClientOptions
-
Returns the cardinality guard allowlist override.
- allowedLabels(List<String>) - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Sets the cardinality guard allowlist.
- allowedLabels(List<String>) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Sets the cardinality guard allowlist (label names that may become index labels; everything else goes to structured metadata).
- allowedLabels(List<String>) - Method in class codes.grow.packages.loki.LokiLogClientOptions.Builder
-
Overrides the cardinality guard allowlist of the client configuration.
- append(ILoggingEvent) - Method in class codes.grow.packages.loki.logging.GrowLogbackAppender
- append(LogEvent) - Method in class codes.grow.packages.loki.logging.GrowLog4j2Appender
- apply(LokiStream) - Method in class codes.grow.packages.loki.CardinalityGuard
-
Returns a copy of the stream whose labels outside the allowlist are moved to the structured metadata of every entry (an entry's own metadata wins).
- arg(String) - Method in class codes.grow.packages.loki.testing.StepContext
-
Returns a required string argument.
- args() - Method in record class codes.grow.packages.loki.testing.Scenario.Step
-
Returns the value of the
argsrecord component. - args() - Method in class codes.grow.packages.loki.testing.StepContext
-
Returns the arguments with
${...}variables substituted (#{i}is kept). - ASC - Enum constant in enum class codes.grow.packages.loki.logging.SortOrder
-
Oldest first (
"asc"). - asSdkException(Throwable, String) - Static method in class codes.grow.packages.loki.core.HttpTransport
-
Converts any throwable from a future into the matching SDK exception.
- assertPassed() - Method in record class codes.grow.packages.loki.testing.ConformanceReport
-
Throws when any scenario failed.
- attempt() - Method in record class codes.grow.packages.loki.core.Hooks.ErrorInfo
-
Returns the value of the
attemptrecord component. - attempt() - Method in record class codes.grow.packages.loki.core.Hooks.RequestInfo
-
Returns the value of the
attemptrecord component. - attempt() - Method in record class codes.grow.packages.loki.core.Hooks.ResponseInfo
-
Returns the value of the
attemptrecord component. - attempts() - Method in class codes.grow.packages.loki.core.TransportResponse
-
Returns the number of attempts the call needed.
- attribute(String, Object) - Method in class codes.grow.packages.loki.logging.LogInput.Builder
-
Adds an attribute.
- attribute(String, Object) - Method in class codes.grow.packages.loki.logging.LogRecord.Builder
-
Adds one attribute.
- attributes() - Method in class codes.grow.packages.loki.logging.Logger
-
Fixed attributes (including
logger.name). - attributes() - Method in class codes.grow.packages.loki.logging.LogInput
-
Attributes.
- attributes() - Method in class codes.grow.packages.loki.logging.LogRecord
-
Attributes.
- attributes(Map<String, ?>) - Method in class codes.grow.packages.loki.logging.LogInput.Builder
-
Replaces the attributes.
- attributes(Map<String, ?>) - Method in class codes.grow.packages.loki.logging.LogRecord.Builder
-
Replaces all attributes.
- attrToString(Object) - Static method in class codes.grow.packages.loki.Labels
-
Renders an attribute value as a structured metadata string: strings as is, numbers and booleans as their text, lists and maps as JSON.
- AttrValues - Class in codes.grow.packages.loki.logging
-
Normalises attribute values (
AttrValue) into the kinds the SDK accepts. - AUTHENTICATION - Enum constant in enum class codes.grow.packages.loki.core.ErrorCode
-
HTTP 401: missing or invalid credentials.
- AuthenticationException - Exception Class in codes.grow.packages.loki.core
-
Missing or invalid credentials (HTTP 401).
- AuthenticationException(String) - Constructor for exception class codes.grow.packages.loki.core.AuthenticationException
-
Creates the exception.
- AuthenticationException(String, Integer, String, boolean, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.AuthenticationException
-
Creates the exception with response details and an explicit
retryableflag, for service subclasses whose errors differ from the default of the code (for example aCONFLICTthat may succeed when retried, or anUNAVAILABLEthat will not). - AuthenticationException(String, Integer, String, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.AuthenticationException
-
Creates the exception with response details.
- AuthenticationException(String, Throwable) - Constructor for exception class codes.grow.packages.loki.core.AuthenticationException
-
Creates the exception with a cause.
- authorizationHeader() - Method in class codes.grow.packages.loki.LokiConfig
-
Returns the
Authorizationheader value when credentials are configured. - await(CompletableFuture<T>, String) - Static method in class codes.grow.packages.loki.core.HttpTransport
-
Waits for a future of this SDK: an interrupt cancels the future and raises
CancelledException.
B
- backoff(int) - Method in class codes.grow.packages.loki.core.RetryPolicy
-
Computes the full-jitter backoff for retry
n. - backoffCap(int) - Method in class codes.grow.packages.loki.core.RetryPolicy
-
Returns the upper bound of the jitter window for retry
n. - BACKWARD - Enum constant in enum class codes.grow.packages.loki.Direction
-
Newest first (Loki's default).
- baseUrl() - Method in class codes.grow.packages.loki.core.TransportConfig
-
Returns the base URL.
- basicAuth(String, Secret) - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Sets Basic-auth credentials.
- basicAuth(String, String) - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Sets Basic-auth credentials (gateways, Grafana Cloud).
- BatchingLogClient - Class in codes.grow.packages.loki.logging
- BatchingLogClient.Builder - Class in codes.grow.packages.loki.logging
-
Builder for
BatchingLogClient. - batchOptions() - Method in class codes.grow.packages.loki.LokiLogClientOptions
-
Returns the batch options.
- batchOptions() - Method in record class codes.grow.packages.loki.testing.Scenario
-
Returns the
batchOptionsobject of a logging scenario. - batchOptions(BatchOptions) - Method in class codes.grow.packages.loki.logging.BatchingLogClient.Builder
-
Sets the batch options.
- batchOptions(BatchOptions) - Method in class codes.grow.packages.loki.LokiLogClientOptions.Builder
-
Sets the batch options.
- batchOptions(Scenario, BatchOptions) - Static method in record class codes.grow.packages.loki.testing.logging.LoggingTarget
-
Applies a scenario's
batchOptions(maxQueueSize,maxBatchSize,maxBatchBytes,flushIntervalMs,exportTimeoutMs,dropPolicy,gzip) on top ofbase; factories call this when building the client. - BatchOptions - Class in codes.grow.packages.loki.logging
-
Options of a
BatchProcessor. - BatchOptions.Builder - Class in codes.grow.packages.loki.logging
-
Builder for
BatchOptions. - BatchProcessor - Class in codes.grow.packages.loki.logging
-
Queues log records and exports them in batches from one background thread (a single-threaded
ScheduledExecutorService). - BatchProcessor(LogExporter) - Constructor for class codes.grow.packages.loki.logging.BatchProcessor
-
Creates a processor with default options.
- BatchProcessor(LogExporter, BatchOptions) - Constructor for class codes.grow.packages.loki.logging.BatchProcessor
-
Creates a processor and starts its worker thread.
- batchSizes() - Method in class codes.grow.packages.loki.testing.logging.InMemoryLogExporter
-
Sizes of all export calls.
- BatchStats - Record Class in codes.grow.packages.loki.logging
-
Counters of a
BatchProcessor. - BatchStats(long, long, long, long, long) - Constructor for record class codes.grow.packages.loki.logging.BatchStats
-
Creates an instance of a
BatchStatsrecord class. - bearerToken() - Method in class codes.grow.packages.loki.LokiConfig
-
Returns the Bearer token for gateways.
- bearerToken(Secret) - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Sets the Bearer token for gateways.
- bearerToken(Secret) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Sets the Bearer token sent to a gateway (
Authorization: Bearer …). - bearerToken(String) - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Sets the Bearer token for gateways.
- bearerToken(String) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Sets the Bearer token.
- BLOCK - Enum constant in enum class codes.grow.packages.loki.logging.DropPolicy
-
Block the caller until there is room (
"block"); never drops for a full queue (an interrupted caller drops its record withDropReason.QUEUE_FULL). - body() - Method in class codes.grow.packages.loki.core.TransportRequest
-
Returns a copy of the body.
- body() - Method in class codes.grow.packages.loki.core.TransportResponse
-
Returns a copy of the body.
- body() - Method in class codes.grow.packages.loki.logging.LogRecord
-
Message; structured bodies are JSON-encoded strings.
- body(byte[], String) - Method in class codes.grow.packages.loki.core.TransportRequest.Builder
-
Sets a raw body.
- body(String) - Method in class codes.grow.packages.loki.logging.LogRecord.Builder
-
Sets the message.
- bool(String, String...) - Method in class codes.grow.packages.loki.core.EnvReader
-
Reads a boolean (
true/false/1/0/yes/no/on/off, case-insensitive). - branch() - Method in record class codes.grow.packages.loki.BuildInfo
-
Returns the value of the
branchrecord component. - build() - Method in class codes.grow.packages.loki.core.RetryPolicy.Builder
-
Validates and builds the policy.
- build() - Method in class codes.grow.packages.loki.core.TlsOptions.Builder
-
Builds the options.
- build() - Method in class codes.grow.packages.loki.core.TransportConfig.Builder
-
Builds the configuration.
- build() - Method in class codes.grow.packages.loki.core.TransportRequest.Builder
-
Builds the request.
- build() - Method in class codes.grow.packages.loki.LiveTailOptions.Builder
-
Builds the options.
- build() - Method in class codes.grow.packages.loki.logging.BatchingLogClient.Builder
-
Builds the client and starts its worker thread.
- build() - Method in class codes.grow.packages.loki.logging.BatchOptions.Builder
-
Validates and builds the options.
- build() - Method in class codes.grow.packages.loki.logging.LogInput.Builder
-
Builds the input.
- build() - Method in class codes.grow.packages.loki.logging.LogRecord.Builder
-
Builds the record.
- build() - Method in class codes.grow.packages.loki.logging.RedactionProcessor.Builder
-
Builds the processor.
- build() - Method in class codes.grow.packages.loki.logging.SearchOptions.Builder
-
Builds the options.
- build() - Method in class codes.grow.packages.loki.LogQL
-
Renders the query.
- build() - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Builds the configuration and the client.
- build() - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Builds and validates the configuration.
- build() - Method in class codes.grow.packages.loki.LokiLogClientOptions.Builder
-
Builds the options.
- build() - Method in class codes.grow.packages.loki.QueryOptions.Builder
-
Builds the options.
- build() - Method in class codes.grow.packages.loki.QueryRangeOptions.Builder
-
Builds the options.
- build() - Method in class codes.grow.packages.loki.testing.ConformanceRunner.Builder
-
Builds the runner.
- build() - Method in class codes.grow.packages.loki.VolumeOptions.Builder
-
Builds the options.
- buildDate() - Method in record class codes.grow.packages.loki.BuildInfo
-
Returns the value of the
buildDaterecord component. - builder() - Static method in class codes.grow.packages.loki.core.RetryPolicy
-
Starts a builder with the defaults.
- builder() - Static method in class codes.grow.packages.loki.core.TlsOptions
-
Starts a builder.
- builder() - Static method in class codes.grow.packages.loki.LiveTailOptions
-
Starts a builder.
- builder() - Static method in class codes.grow.packages.loki.logging.BatchOptions
-
Returns a builder with the defaults.
- builder() - Static method in class codes.grow.packages.loki.logging.LogRecord
-
Returns a new builder.
- builder() - Static method in class codes.grow.packages.loki.logging.RedactionProcessor
-
Returns a builder with the defaults.
- builder() - Static method in class codes.grow.packages.loki.logging.SearchOptions
-
Returns a builder.
- builder() - Static method in class codes.grow.packages.loki.LokiClient
-
Starts a client builder.
- builder() - Static method in class codes.grow.packages.loki.LokiConfig
-
Starts an empty builder (every field at its default).
- builder() - Static method in class codes.grow.packages.loki.LokiLogClientOptions
-
Starts a builder.
- builder() - Static method in class codes.grow.packages.loki.QueryOptions
-
Starts a builder.
- builder() - Static method in class codes.grow.packages.loki.QueryRangeOptions
-
Starts a builder.
- builder() - Static method in class codes.grow.packages.loki.testing.ConformanceRunner
-
Starts a builder with
CoreOpsand the built-in category operations registered. - builder() - Static method in class codes.grow.packages.loki.VolumeOptions
-
Starts a builder.
- builder(LogExporter) - Static method in class codes.grow.packages.loki.logging.BatchingLogClient
-
Returns a builder.
- builder(String) - Static method in class codes.grow.packages.loki.core.TransportConfig
-
Starts a builder with the SPEC defaults.
- builder(String) - Static method in class codes.grow.packages.loki.logging.LogInput
-
Returns a builder for
message. - builder(String, String) - Static method in class codes.grow.packages.loki.core.TransportRequest
-
Starts a request.
- buildInfo() - Method in class codes.grow.packages.loki.LokiClient
-
Build information:
GET /loki/api/v1/status/buildinfo. - BuildInfo - Record Class in codes.grow.packages.loki
-
Build information of the server (
/loki/api/v1/status/buildinfo). - BuildInfo(String, String, String, String, String, String) - Constructor for record class codes.grow.packages.loki.BuildInfo
-
Creates an instance of a
BuildInforecord class. - buildInfoAsync() - Method in class codes.grow.packages.loki.LokiClient
-
Asynchronous
LokiClient.buildInfo(). - buildUser() - Method in record class codes.grow.packages.loki.BuildInfo
-
Returns the value of the
buildUserrecord component. - bytes() - Method in record class codes.grow.packages.loki.IndexStats
-
Returns the value of the
bytesrecord component. - byteSize(LogRecord) - Static method in class codes.grow.packages.loki.logging.LogRecordJson
-
Returns the UTF-8 size of the record's JSON form (the unit of
maxBatchBytes).
C
- caCertPath() - Method in class codes.grow.packages.loki.core.TlsOptions
-
Returns the CA bundle path.
- caCertPath(Path) - Method in class codes.grow.packages.loki.core.TlsOptions.Builder
-
Trusts the CA certificates in a PEM file instead of the system trust store.
- caCertPem() - Method in class codes.grow.packages.loki.core.TlsOptions
-
Returns the inline CA bundle.
- caCertPem(String) - Method in class codes.grow.packages.loki.core.TlsOptions.Builder
-
Trusts the CA certificates in inline PEM text.
- CANCELLED - Enum constant in enum class codes.grow.packages.loki.core.ErrorCode
-
The caller cancelled the operation.
- CancelledException - Exception Class in codes.grow.packages.loki.core
-
The caller cancelled the operation (future cancelled, thread interrupted, client closed).
- CancelledException(String) - Constructor for exception class codes.grow.packages.loki.core.CancelledException
-
Creates the exception.
- CancelledException(String, Integer, String, boolean, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.CancelledException
-
Creates the exception with response details and an explicit
retryableflag, for service subclasses whose errors differ from the default of the code (for example aCONFLICTthat may succeed when retried, or anUNAVAILABLEthat will not). - CancelledException(String, Integer, String, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.CancelledException
-
Creates the exception with response details.
- CancelledException(String, Throwable) - Constructor for exception class codes.grow.packages.loki.core.CancelledException
-
Creates the exception with a cause.
- capabilities(String...) - Method in class codes.grow.packages.loki.testing.ConformanceRunner.Builder
-
Declares capabilities of the target (
write,delete,versions,query,version, ...). - CardinalityGuard - Class in codes.grow.packages.loki
-
Keeps Loki's index small: only allowlisted names become index labels, everything else is sent as structured metadata (per entry, not indexed).
- CardinalityGuard(Collection<String>) - Constructor for class codes.grow.packages.loki.CardinalityGuard
-
Creates a guard.
- category() - Method in interface codes.grow.packages.loki.testing.ConformanceOps
-
Returns the category these operations serve.
- category() - Method in record class codes.grow.packages.loki.testing.ConformanceReport.ScenarioResult
-
Returns the value of the
categoryrecord component. - category() - Method in class codes.grow.packages.loki.testing.CoreOps
- category() - Method in class codes.grow.packages.loki.testing.logging.LoggingOps
- category() - Method in record class codes.grow.packages.loki.testing.Scenario
-
Returns the value of the
categoryrecord component. - check(HttpTransport, String) - Static method in class codes.grow.packages.loki.core.HealthCheck
-
Probes an endpoint once (no retries) and maps the outcome to a
HealthStatus. - check(JsonNode, Object, Throwable) - Static method in class codes.grow.packages.loki.testing.Expectations
-
Checks a step outcome.
- checkAsync(HttpTransport, String) - Static method in class codes.grow.packages.loki.core.HealthCheck
-
Asynchronous variant of
HealthCheck.check(codes.grow.packages.loki.core.HttpTransport, java.lang.String). - child(Map<String, ?>) - Method in class codes.grow.packages.loki.logging.Logger
-
Returns a logger with more fixed attributes (they win over the parent's).
- chunks() - Method in record class codes.grow.packages.loki.IndexStats
-
Returns the value of the
chunksrecord component. - clear() - Method in class codes.grow.packages.loki.core.Secret
-
Overwrites the characters with zeros; later
Secret.reveal()calls throw. - client() - Method in record class codes.grow.packages.loki.testing.logging.LoggingTarget
-
Returns the value of the
clientrecord component. - clientCertPath() - Method in class codes.grow.packages.loki.core.TlsOptions
-
Returns the client certificate path.
- clientCertPath(Path) - Method in class codes.grow.packages.loki.core.TlsOptions.Builder
-
Sets the client certificate file (mutual TLS); requires a key.
- clientCertPem(String) - Method in class codes.grow.packages.loki.core.TlsOptions.Builder
-
Sets the client certificate as inline PEM.
- clientKeyPath() - Method in class codes.grow.packages.loki.core.TlsOptions
-
Returns the client key path.
- clientKeyPath(Path) - Method in class codes.grow.packages.loki.core.TlsOptions.Builder
-
Sets the client key file (unencrypted PKCS#8 PEM).
- clientKeyPem(Secret) - Method in class codes.grow.packages.loki.core.TlsOptions.Builder
-
Sets the client key as inline PEM.
- clock() - Method in class codes.grow.packages.loki.core.TransportConfig
-
Returns the clock used for
Retry-Afterdates. - clock(Clock) - Method in class codes.grow.packages.loki.core.TransportConfig.Builder
-
Sets the clock (tests).
- clock(Clock) - Method in class codes.grow.packages.loki.logging.BatchingLogClient.Builder
-
Sets the clock used for default timestamps (tests).
- close() - Method in class codes.grow.packages.loki.core.HttpTransport
-
Cancels pending calls and releases the client.
- close() - Method in class codes.grow.packages.loki.logging.BatchingLogClient
- close() - Method in class codes.grow.packages.loki.logging.BatchProcessor
-
Same as
BatchProcessor.shutdown(). - close() - Method in class codes.grow.packages.loki.logging.GrowJulHandler
- close() - Method in interface codes.grow.packages.loki.logging.LogClient
-
Flushes and shuts down; idempotent.
- close() - Method in interface codes.grow.packages.loki.logging.TailHandle
-
Same as
TailHandle.stop(). - close() - Method in class codes.grow.packages.loki.LokiClient
-
Flushes and closes log clients created by
LokiClient.logClient(), stops open tails and releases connections (children fromLokiClient.withTenant(java.lang.String)leave the shared connections open). - close() - Method in class codes.grow.packages.loki.LokiTail
-
Same as
LokiTail.stop(). - close() - Method in interface codes.grow.packages.loki.testing.CoreTarget
-
Releases the target; idempotent.
- closeAsync() - Method in class codes.grow.packages.loki.logging.BatchingLogClient
- closeAsync() - Method in interface codes.grow.packages.loki.logging.LogClient
-
Asynchronous
LogClient.close(). - closed() - Method in class codes.grow.packages.loki.LokiTail
-
Returns a future that completes once the socket is closed (after
LokiTail.stop()or when the server closes it). - code() - Method in exception class codes.grow.packages.loki.core.LokiException
-
Returns the canonical error code.
- codes.grow.packages.loki - package codes.grow.packages.loki
-
Grow Codes SDK for Grafana Loki.
- codes.grow.packages.loki.core - package codes.grow.packages.loki.core
- codes.grow.packages.loki.logging - package codes.grow.packages.loki.logging
- codes.grow.packages.loki.testing - package codes.grow.packages.loki.testing
- codes.grow.packages.loki.testing.logging - package codes.grow.packages.loki.testing.logging
- config() - Method in class codes.grow.packages.loki.core.HttpTransport
-
Returns the configuration.
- config() - Method in class codes.grow.packages.loki.LokiClient
-
Returns the configuration.
- CONFIG - Enum constant in enum class codes.grow.packages.loki.core.ErrorCode
-
Invalid or missing configuration.
- ConfigException - Exception Class in codes.grow.packages.loki.core
-
Invalid or missing configuration.
- ConfigException(String) - Constructor for exception class codes.grow.packages.loki.core.ConfigException
-
Creates the exception.
- ConfigException(String, Integer, String, boolean, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.ConfigException
-
Creates the exception with response details and an explicit
retryableflag, for service subclasses whose errors differ from the default of the code (for example aCONFLICTthat may succeed when retried, or anUNAVAILABLEthat will not). - ConfigException(String, Integer, String, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.ConfigException
-
Creates the exception with response details.
- ConfigException(String, Throwable) - Constructor for exception class codes.grow.packages.loki.core.ConfigException
-
Creates the exception with a cause.
- CONFLICT - Enum constant in enum class codes.grow.packages.loki.core.ErrorCode
-
HTTP 409, 412 or a check-and-set mismatch.
- ConflictException - Exception Class in codes.grow.packages.loki.core
-
Conflicting write or check-and-set mismatch (HTTP 409, 412).
- ConflictException(String) - Constructor for exception class codes.grow.packages.loki.core.ConflictException
-
Creates the exception.
- ConflictException(String, Integer, String, boolean, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.ConflictException
-
Creates the exception with response details and an explicit
retryableflag, for service subclasses whose errors differ from the default of the code (for example aCONFLICTthat may succeed when retried, or anUNAVAILABLEthat will not). - ConflictException(String, Integer, String, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.ConflictException
-
Creates the exception with response details.
- ConflictException(String, Throwable) - Constructor for exception class codes.grow.packages.loki.core.ConflictException
-
Creates the exception with a cause.
- ConformanceOps - Interface in codes.grow.packages.loki.testing
-
The operations of one scenario category (
core,secrets,logging,tracing) for theConformanceRunner. - ConformanceReport - Record Class in codes.grow.packages.loki.testing
-
Results of a conformance run.
- ConformanceReport(List<ConformanceReport.ScenarioResult>) - Constructor for record class codes.grow.packages.loki.testing.ConformanceReport
-
Creates a report; the list is copied.
- ConformanceReport.ScenarioResult - Record Class in codes.grow.packages.loki.testing
-
Result of one scenario.
- ConformanceReport.Status - Enum Class in codes.grow.packages.loki.testing
-
Outcome of a scenario or step.
- ConformanceReport.StepResult - Record Class in codes.grow.packages.loki.testing
-
Result of one step.
- ConformanceRunner - Class in codes.grow.packages.loki.testing
-
Runs the shared conformance scenarios (
conformance/scenarios/*.json, SPEC section 6) against targets supplied by a service's integration test. - ConformanceRunner.Builder - Class in codes.grow.packages.loki.testing
-
Builder for
ConformanceRunner. - connectTimeout() - Method in class codes.grow.packages.loki.core.TransportConfig
-
Returns the connection setup timeout.
- connectTimeout() - Method in class codes.grow.packages.loki.LokiConfig
-
Returns the connect timeout.
- connectTimeout(Duration) - Method in class codes.grow.packages.loki.core.TransportConfig.Builder
-
Sets the connect timeout.
- connectTimeout(Duration) - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Sets the connect timeout.
- connectTimeout(Duration) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Sets the connect timeout (default 10 s).
- contentType() - Method in class codes.grow.packages.loki.core.TransportRequest
-
Returns the body content type.
- CoreOps - Class in codes.grow.packages.loki.testing
-
Conformance operations of the
corecategory:health,ping,serverVersion,close. - CoreOps() - Constructor for class codes.grow.packages.loki.testing.CoreOps
-
Creates the operations.
- CoreTarget - Interface in codes.grow.packages.loki.testing
-
A target of the
coreconformance 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. - count() - Method in class codes.grow.packages.loki.testing.OpResult
-
Returns the explicit count.
- create(LokiConfig) - Static method in class codes.grow.packages.loki.LokiClient
-
Creates a client.
- create(Scenario) - Method in interface codes.grow.packages.loki.testing.TargetFactory
-
Creates or returns the target for one scenario.
- create(String, LogClient) - Static method in class codes.grow.packages.loki.logging.GrowLog4j2Appender
-
Creates an appender bound to
client(start it and add it to a configuration). - createAppender(String, Filter) - Static method in class codes.grow.packages.loki.logging.GrowLog4j2Appender
-
Plugin factory used by configuration files.
- cursor() - Method in class codes.grow.packages.loki.logging.SearchOptions
-
Page cursor from a previous result.
- cursor(String) - Method in class codes.grow.packages.loki.logging.SearchOptions.Builder
-
Sets the page cursor.
D
- debug(String) - Method in interface codes.grow.packages.loki.core.Logger
-
Logs at debug level without fields.
- debug(String) - Method in class codes.grow.packages.loki.logging.Logger
-
Logs at DEBUG.
- debug(String, Map<String, ?>) - Method in class codes.grow.packages.loki.logging.Logger
-
Logs at DEBUG.
- debug(String, Map<String, Object>) - Method in interface codes.grow.packages.loki.core.Logger
-
Logs at debug level.
- DEBUG - Enum constant in enum class codes.grow.packages.loki.logging.Severity
-
OTel severity 5.
- decode(byte[], TypeReference<T>) - Static method in class codes.grow.packages.loki.core.Json
-
Decodes JSON bytes into a generic type.
- decode(byte[], Class<T>) - Static method in class codes.grow.packages.loki.core.Json
-
Decodes JSON bytes into a type.
- deepMatch(JsonNode, JsonNode) - Static method in class codes.grow.packages.loki.testing.Expectations
-
Deep JSON equality where objects in
expectedare matched as subsets and numbers compare by value (42 == 42.0). - DEFAULT_ALLOWED_LABELS - Static variable in class codes.grow.packages.loki.Labels
-
Keys the cardinality guard lets become index labels by default (coordinator decision 3).
- DEFAULT_INTERVAL - Static variable in record class codes.grow.packages.loki.logging.TailOptions
-
The interval used when none is given.
- DEFAULT_INTERVAL - Static variable in record class codes.grow.packages.loki.logging.WaitForLogOptions
-
The interval used when none is given.
- DEFAULT_MAX_RETRIES - Static variable in class codes.grow.packages.loki.core.RetryPolicy
-
Default maximum number of retries (so up to 4 attempts).
- DEFAULT_POLL_INTERVAL - Static variable in class codes.grow.packages.loki.testing.ConformanceRunner
-
Pause between repeated steps.
- DEFAULT_POLL_TIMEOUT - Static variable in class codes.grow.packages.loki.testing.ConformanceRunner
-
How long
listServicessteps are repeated until their expectation passes. - DEFAULT_PREFIX - Static variable in class codes.grow.packages.loki.core.EnvReader
-
Prefix of every variable of this SDK.
- DEFAULT_PREFIX - Static variable in class codes.grow.packages.loki.testing.ConformanceRunner
-
Default value of
${prefix}. - DEFAULT_REDACT_KEYS - Static variable in class codes.grow.packages.loki.logging.RedactionProcessor
-
Default sensitive attribute name fragments (SPEC section 4).
- DEFAULT_REPLACEMENT - Static variable in class codes.grow.packages.loki.logging.RedactionProcessor
-
Default replacement text.
- DEFAULT_URL - Static variable in class codes.grow.packages.loki.LokiConfig
-
Default endpoint (the stack catalog port 3100).
- defaults() - Static method in class codes.grow.packages.loki.CardinalityGuard
-
Returns a guard with
Labels.DEFAULT_ALLOWED_LABELS. - defaults() - Static method in class codes.grow.packages.loki.core.RetryPolicy
-
Returns the default policy: 3 retries, 100 ms initial, 10 s max, multiplier 2, Retry-After up to 60 s.
- defaults() - Static method in class codes.grow.packages.loki.core.TlsOptions
-
Returns options without any customisation (system trust store).
- defaults() - Static method in record class codes.grow.packages.loki.LabelsOptions
-
The server's default window (last 6 hours), all streams.
- defaults() - Static method in class codes.grow.packages.loki.LiveTailOptions
-
Default options: Loki replays the last hour (up to 100 entries), then streams new entries.
- defaults() - Static method in class codes.grow.packages.loki.logging.BatchOptions
-
Returns the defaults.
- defaults() - Static method in class codes.grow.packages.loki.logging.RedactionProcessor
-
Returns a processor with the default keys, no patterns and
"[REDACTED]". - defaults() - Static method in class codes.grow.packages.loki.logging.SearchOptions
-
Default options (no range, limit 100, newest first).
- defaults() - Static method in record class codes.grow.packages.loki.logging.TailOptions
-
Defaults: from now, 1 s interval, errors ignored.
- defaults() - Static method in record class codes.grow.packages.loki.logging.WaitForLogOptions
-
Defaults: 30 s timeout, 1 s interval, any record.
- defaults() - Static method in class codes.grow.packages.loki.LokiLogClientOptions
-
Default options: JSON push, default batching and redaction, no resource.
- defaults() - Static method in record class codes.grow.packages.loki.PushOptions
-
Uncompressed JSON.
- defaults() - Static method in class codes.grow.packages.loki.QueryOptions
-
Default options (evaluation time = now).
- defaults() - Static method in class codes.grow.packages.loki.QueryRangeOptions
-
Default options (last hour, Loki's default limit 100, newest first).
- defaults() - Static method in record class codes.grow.packages.loki.TimeRange
-
The server's default window.
- defaults() - Static method in class codes.grow.packages.loki.VolumeOptions
-
Default options.
- delayFor() - Method in class codes.grow.packages.loki.LiveTailOptions
-
Returns the server-side delay.
- delayFor(Duration) - Method in class codes.grow.packages.loki.LiveTailOptions.Builder
-
Sets the server-side delay (0–5 s).
- delete(String) - Static method in class codes.grow.packages.loki.core.TransportRequest
-
Starts a DELETE request.
- DESC - Enum constant in enum class codes.grow.packages.loki.logging.SortOrder
-
Newest first (
"desc", default). - describe() - Method in record class codes.grow.packages.loki.testing.ConformanceReport.ScenarioResult
-
Returns a one-line description.
- description() - Method in record class codes.grow.packages.loki.testing.Scenario
-
Returns the value of the
descriptionrecord component. - details() - Method in record class codes.grow.packages.loki.core.HealthStatus
-
Returns the value of the
detailsrecord component. - direction() - Method in class codes.grow.packages.loki.QueryOptions
-
Returns the direction.
- direction() - Method in class codes.grow.packages.loki.QueryRangeOptions
-
Returns the direction.
- direction(Direction) - Method in class codes.grow.packages.loki.QueryOptions.Builder
-
Sets the direction.
- direction(Direction) - Method in class codes.grow.packages.loki.QueryRangeOptions.Builder
-
Sets the direction.
- Direction - Enum Class in codes.grow.packages.loki
-
Sort order of log query results.
- disableLabelGuard() - Method in class codes.grow.packages.loki.LokiConfig
-
Returns whether
LokiClient.push(java.util.List<codes.grow.packages.loki.LokiStream>)sends every stream label as an index label. - disableLabelGuard(boolean) - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Disables the cardinality guard for
LokiClient.push(java.util.List<codes.grow.packages.loki.LokiStream>). - disableLabelGuard(boolean) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Sends every label of
LokiClient.push(java.util.List<codes.grow.packages.loki.LokiStream>)streams as an index label (the guard is still applied by the log exporter). - DROP_NEWEST - Enum constant in enum class codes.grow.packages.loki.logging.DropPolicy
-
Drop the record being added (
"drop_newest", default). - DROP_OLDEST - Enum constant in enum class codes.grow.packages.loki.logging.DropPolicy
-
Drop the oldest queued record to make room (
"drop_oldest"). - dropped() - Method in record class codes.grow.packages.loki.logging.BatchStats
-
Returns the value of the
droppedrecord component. - droppedCount() - Method in class codes.grow.packages.loki.LokiTail
-
Returns the number of entries the server reported as dropped.
- droppedEntries() - Method in record class codes.grow.packages.loki.TailFrame
-
Returns the value of the
droppedEntriesrecord component. - DroppedEntry - Record Class in codes.grow.packages.loki
-
An entry the tail stream dropped because the client fell behind.
- DroppedEntry(Map<String, String>, long) - Constructor for record class codes.grow.packages.loki.DroppedEntry
-
Copies the labels.
- dropPolicy() - Method in class codes.grow.packages.loki.logging.BatchOptions
-
Queue-full behaviour (default
DropPolicy.DROP_NEWEST). - dropPolicy(DropPolicy) - Method in class codes.grow.packages.loki.logging.BatchOptions.Builder
-
Sets the drop policy.
- DropPolicy - Enum Class in codes.grow.packages.loki.logging
-
What
BatchProcessor.add(codes.grow.packages.loki.logging.LogRecord)does when the queue is full. - DropReason - Enum Class in codes.grow.packages.loki.logging
-
Why records were dropped (argument of
BatchOptions.Builder.onDrop). - duration() - Method in class codes.grow.packages.loki.core.TransportResponse
-
Returns the call duration including retries.
- duration(String, String...) - Method in class codes.grow.packages.loki.core.EnvReader
-
Reads a duration (integer milliseconds or Go-style units such as
1m30s). - durationMs() - Method in record class codes.grow.packages.loki.core.Hooks.ResponseInfo
-
Returns the value of the
durationMsrecord component. - durationMs() - Method in record class codes.grow.packages.loki.testing.ConformanceReport.ScenarioResult
-
Returns the value of the
durationMsrecord component. - dynamicTests(ConformanceRunner) - Static method in class codes.grow.packages.loki.testing.JUnitConformance
-
Creates one dynamic test per selected scenario.
E
- encode(Object) - Static method in class codes.grow.packages.loki.core.Json
-
Encodes a value as UTF-8 JSON.
- ENCODING_FLAGS_HEADER - Static variable in class codes.grow.packages.loki.LokiClient
-
Header that switches query responses to categorized labels.
- end() - Method in record class codes.grow.packages.loki.LabelsOptions
-
Returns the value of the
endrecord component. - end() - Method in class codes.grow.packages.loki.logging.SearchOptions
-
Range end (exclusive).
- end() - Method in class codes.grow.packages.loki.QueryRangeOptions
-
Returns the exclusive end.
- end() - Method in record class codes.grow.packages.loki.TimeRange
-
Returns the value of the
endrecord component. - end() - Method in class codes.grow.packages.loki.VolumeOptions
-
Returns the window end.
- end(Instant) - Method in class codes.grow.packages.loki.logging.SearchOptions.Builder
-
Sets the range end.
- end(Instant) - Method in class codes.grow.packages.loki.QueryRangeOptions.Builder
-
Sets the exclusive end.
- end(Instant) - Method in class codes.grow.packages.loki.VolumeOptions.Builder
-
Sets the window end.
- enqueueOutcome(Function<List<LogRecord>, CompletableFuture<ExportResult>>) - Method in class codes.grow.packages.loki.testing.logging.InMemoryLogExporter
-
Scripts the outcome of the next export call (FIFO).
- entries() - Method in record class codes.grow.packages.loki.IndexStats
-
Returns the value of the
entriesrecord component. - entries() - Method in record class codes.grow.packages.loki.LokiStream
-
Returns the value of the
entriesrecord component. - entries() - Method in record class codes.grow.packages.loki.StreamResult
-
Returns the value of the
entriesrecord component. - EnvReader - Class in codes.grow.packages.loki.core
-
Reads configuration from environment variables (SPEC section 2.2).
- EnvReader(String, Map<String, String>) - Constructor for class codes.grow.packages.loki.core.EnvReader
-
Creates a reader over an explicit environment map.
- equals(Object) - Method in record class codes.grow.packages.loki.BuildInfo
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.core.HealthStatus
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.core.Hooks.ErrorInfo
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.core.Hooks.RequestInfo
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.core.Hooks.ResponseInfo
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.DroppedEntry
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.IndexStats
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.LabelsOptions
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.logging.BatchStats
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.logging.ExportOptions
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.logging.ExportResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class codes.grow.packages.loki.logging.LogRecord
- equals(Object) - Method in record class codes.grow.packages.loki.logging.LogSearchResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.logging.TailOptions
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.logging.WaitForLogOptions
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.LokiEntry
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.LokiStream
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.MatrixSeries
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.PushOptions
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.QueryResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.Sample
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.StreamEntry
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.StreamResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.TailFrame
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.testing.ConformanceReport
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.testing.ConformanceReport.ScenarioResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.testing.ConformanceReport.StepResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.testing.logging.LoggingTarget
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.testing.Scenario
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.testing.Scenario.Step
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.TimeRange
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class codes.grow.packages.loki.VectorSample
-
Indicates whether some other object is "equal to" this one.
- error() - Method in record class codes.grow.packages.loki.core.Hooks.ErrorInfo
-
Returns the value of the
errorrecord component. - error() - Method in record class codes.grow.packages.loki.logging.ExportResult
-
Returns the value of the
errorrecord component. - error(String) - Method in interface codes.grow.packages.loki.core.Logger
-
Logs at error level without fields.
- error(String) - Method in class codes.grow.packages.loki.logging.Logger
-
Logs at ERROR.
- error(String, Map<String, ?>) - Method in class codes.grow.packages.loki.logging.Logger
-
Logs at ERROR.
- error(String, Map<String, Object>) - Method in interface codes.grow.packages.loki.core.Logger
-
Logs at error level.
- ERROR - Enum constant in enum class codes.grow.packages.loki.logging.Severity
-
OTel severity 17.
- ErrorCode - Enum Class in codes.grow.packages.loki.core
-
Canonical error codes shared by every Grow Codes SDK (SPEC section 2.1).
- ErrorInfo(String, String, LokiException, int, boolean) - Constructor for record class codes.grow.packages.loki.core.Hooks.ErrorInfo
-
Creates an instance of a
ErrorInforecord class. - errorMapper() - Method in class codes.grow.packages.loki.core.TransportConfig
-
Returns the service error mapper.
- errorMapper(ErrorMapper) - Method in class codes.grow.packages.loki.core.TransportConfig.Builder
-
Sets the service error mapper (see
ErrorMapper). - ErrorMapper - Interface in codes.grow.packages.loki.core
-
Service hook that replaces the error
HttpTransportderived 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). - errorMessage(String, int, Map<String, List<String>>, byte[], Collection<String>) - Static method in class codes.grow.packages.loki.core.HttpTransport
-
Builds an error message
"<operation>: <reason> (HTTP <status>)"with redacted, truncated vendor text. - expect() - Method in record class codes.grow.packages.loki.testing.Scenario.Step
-
Returns the value of the
expectrecord component. - Expectations - Class in codes.grow.packages.loki.testing
-
Evaluates the
expectobject of a scenario step (SPEC section 6). - explicitInterval() - Method in record class codes.grow.packages.loki.logging.TailOptions
-
Returns the interval the caller set, or empty when it was left unset (the record then holds
TailOptions.DEFAULT_INTERVAL). - explicitInterval() - Method in record class codes.grow.packages.loki.logging.WaitForLogOptions
-
Returns the interval the caller set, or empty when it was left unset (the record then holds
WaitForLogOptions.DEFAULT_INTERVAL). - export(List<LogRecord>, ExportOptions) - Method in interface codes.grow.packages.loki.logging.LogExporter
-
Exports a batch.
- export(List<LogRecord>, ExportOptions) - Method in class codes.grow.packages.loki.LokiLogExporter
- export(List<LogRecord>, ExportOptions) - Method in class codes.grow.packages.loki.LokiOtlpExporter
- export(List<LogRecord>, ExportOptions) - Method in class codes.grow.packages.loki.testing.logging.InMemoryLogExporter
- EXPORT_FAILED - Enum constant in enum class codes.grow.packages.loki.logging.DropReason
-
The exporter failed or rejected the records (
"export_failed"). - ExportOptions - Record Class in codes.grow.packages.loki.logging
- ExportOptions(boolean, Duration) - Constructor for record class codes.grow.packages.loki.logging.ExportOptions
-
Validates the options.
- ExportResult - Record Class in codes.grow.packages.loki.logging
- ExportResult(int, int, Optional<LokiException>) - Constructor for record class codes.grow.packages.loki.logging.ExportResult
-
Validates the result.
- exportTimeout() - Method in class codes.grow.packages.loki.logging.BatchOptions
-
Time budget per export including retries; also the default flush/shutdown timeout (default 30 s).
- exportTimeout(Duration) - Method in class codes.grow.packages.loki.logging.BatchOptions.Builder
-
Sets the export timeout.
F
- failed() - Method in record class codes.grow.packages.loki.logging.BatchStats
-
Returns the value of the
failedrecord component. - FAILED - Enum constant in enum class codes.grow.packages.loki.testing.ConformanceReport.Status
-
An expectation failed or the step raised an unexpected error.
- failure(int, int, LokiException) - Static method in record class codes.grow.packages.loki.logging.ExportResult
-
Some or all records failed.
- fatal(String) - Method in class codes.grow.packages.loki.logging.Logger
-
Logs at FATAL.
- fatal(String, Map<String, ?>) - Method in class codes.grow.packages.loki.logging.Logger
-
Logs at FATAL.
- FATAL - Enum constant in enum class codes.grow.packages.loki.logging.Severity
-
OTel severity 21.
- flush() - Method in class codes.grow.packages.loki.logging.BatchingLogClient
- flush() - Method in class codes.grow.packages.loki.logging.BatchProcessor
-
Exports everything queued now, waiting at most the export timeout.
- flush() - Method in class codes.grow.packages.loki.logging.GrowJulHandler
- flush() - Method in interface codes.grow.packages.loki.logging.LogClient
-
Exports everything queued now, waiting at most the export timeout.
- flush(Duration) - Method in class codes.grow.packages.loki.logging.BatchingLogClient
- flush(Duration) - Method in class codes.grow.packages.loki.logging.BatchProcessor
-
Exports everything queued now.
- flush(Duration) - Method in interface codes.grow.packages.loki.logging.LogClient
-
Exports everything queued now.
- flushAsync(Duration) - Method in class codes.grow.packages.loki.logging.BatchingLogClient
- flushAsync(Duration) - Method in class codes.grow.packages.loki.logging.BatchProcessor
-
Exports everything queued now, asynchronously.
- flushAsync(Duration) - Method in interface codes.grow.packages.loki.logging.LogClient
-
Asynchronous
LogClient.flush(Duration). - flushInterval() - Method in class codes.grow.packages.loki.logging.BatchOptions
-
Interval of the background flush (default 1 s).
- flushInterval(Duration) - Method in class codes.grow.packages.loki.logging.BatchOptions.Builder
-
Sets the background flush interval.
- format() - Method in record class codes.grow.packages.loki.PushOptions
-
Returns the value of the
formatrecord component. - formatLabelSet(Map<String, String>) - Static method in class codes.grow.packages.loki.Labels
-
Renders labels in Prometheus label-set syntax with sorted names and Go-quoted values:
{a="b", c="d"}(the form protobuf push andlistStreams()use). - formatQuery(String) - Method in class codes.grow.packages.loki.LokiClient
-
Normalizes a LogQL query on the server (
GET /loki/api/v1/format_query); useful to check builder output. - formatQueryAsync(String) - Method in class codes.grow.packages.loki.LokiClient
-
Asynchronous
LokiClient.formatQuery(String). - forStatus(int) - Static method in enum class codes.grow.packages.loki.core.ErrorCode
-
Maps an HTTP status to its canonical code.
- FORWARD - Enum constant in enum class codes.grow.packages.loki.Direction
-
Oldest first.
- fromEnv() - Static method in class codes.grow.packages.loki.LokiClient
-
Creates a client from
GROW_GRAFANA_LOKI_*andLOKI_*environment variables. - fromEnv() - Static method in class codes.grow.packages.loki.LokiConfig
-
Reads the configuration from the process environment.
- fromEnv(EnvReader) - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Fills unset fields from an environment reader.
- fromEnv(EnvReader) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Fills every field that was not set explicitly from the environment.
- fromEnv(Map<String, String>) - Static method in class codes.grow.packages.loki.LokiConfig
-
Reads the configuration from an explicit variable map (tests).
- fromError(LokiException) - Static method in class codes.grow.packages.loki.core.HealthCheck
-
Maps a transport error to
unreachable. - fromJson(String) - Static method in class codes.grow.packages.loki.logging.LogRecordJson
-
Parses one record from JSON text.
- fromJsonNode(JsonNode) - Static method in class codes.grow.packages.loki.logging.LogRecordJson
-
Parses one record from a Jackson tree.
- fromNumber(int) - Static method in enum class codes.grow.packages.loki.logging.Severity
-
Maps any OpenTelemetry severity number (1–24) to its severity range; 0 or less maps to
Severity.INFO(unspecified) and numbers above 24 toSeverity.FATAL. - fromResponse(TransportResponse) - Static method in class codes.grow.packages.loki.core.HealthCheck
-
Maps a health response: 2xx is healthy; the word comes from a JSON
statusfield (ok/unhealthywhen absent); other string fields become details.
G
- get(String) - Static method in class codes.grow.packages.loki.core.TransportRequest
-
Starts a GET request.
- getLogClient() - Method in class codes.grow.packages.loki.logging.GrowLogbackAppender
-
Returns the destination.
- goVersion() - Method in record class codes.grow.packages.loki.BuildInfo
-
Returns the value of the
goVersionrecord component. - GrowJulHandler - Class in codes.grow.packages.loki.logging
-
java.util.logginghandler that forwards records to aLogClient. - GrowJulHandler(LogClient) - Constructor for class codes.grow.packages.loki.logging.GrowJulHandler
-
Creates the handler.
- GrowLog4j2Appender - Class in codes.grow.packages.loki.logging
-
Log4j 2 appender plugin (
<GrowLog name="grow"/>) that forwards events to aLogClient(Log4j is an optional,provideddependency). - GrowLogbackAppender - Class in codes.grow.packages.loki.logging
-
Logback appender that forwards events to a
LogClient(Logback is an optional,provideddependency). - GrowLogbackAppender() - Constructor for class codes.grow.packages.loki.logging.GrowLogbackAppender
-
Creates an appender without a client (set it with
GrowLogbackAppender.setLogClient(codes.grow.packages.loki.logging.LogClient)). - GrowLogbackAppender(LogClient) - Constructor for class codes.grow.packages.loki.logging.GrowLogbackAppender
-
Creates an appender for
client. - guard() - Method in class codes.grow.packages.loki.LokiClient
-
Returns the cardinality guard built from
LokiConfig.allowedLabels(). - gzip() - Method in class codes.grow.packages.loki.logging.BatchOptions
-
Whether exports are gzipped (default true).
- gzip() - Method in record class codes.grow.packages.loki.logging.ExportOptions
-
Returns the value of the
gziprecord component. - gzip() - Method in record class codes.grow.packages.loki.PushOptions
-
Returns the value of the
gziprecord component. - gzip(boolean) - Method in class codes.grow.packages.loki.logging.BatchOptions.Builder
-
Enables or disables gzip.
- gzipFlags() - Method in class codes.grow.packages.loki.testing.logging.InMemoryLogExporter
-
Gzip flags of all export calls.
H
- hashCode() - Method in record class codes.grow.packages.loki.BuildInfo
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.core.HealthStatus
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.core.Hooks.ErrorInfo
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.core.Hooks.RequestInfo
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.core.Hooks.ResponseInfo
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.DroppedEntry
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.IndexStats
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.LabelsOptions
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.logging.BatchStats
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.logging.ExportOptions
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.logging.ExportResult
-
Returns a hash code value for this object.
- hashCode() - Method in class codes.grow.packages.loki.logging.LogRecord
- hashCode() - Method in record class codes.grow.packages.loki.logging.LogSearchResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.logging.TailOptions
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.logging.WaitForLogOptions
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.LokiEntry
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.LokiStream
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.MatrixSeries
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.PushOptions
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.QueryResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.Sample
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.StreamEntry
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.StreamResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.TailFrame
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.testing.ConformanceReport
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.testing.ConformanceReport.ScenarioResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.testing.ConformanceReport.StepResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.testing.logging.LoggingTarget
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.testing.Scenario
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.testing.Scenario.Step
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.TimeRange
-
Returns a hash code value for this object.
- hashCode() - Method in record class codes.grow.packages.loki.VectorSample
-
Returns a hash code value for this object.
- header(String) - Method in class codes.grow.packages.loki.core.TransportResponse
-
Returns the first value of a header.
- header(String, String) - Method in class codes.grow.packages.loki.core.TransportRequest.Builder
-
Sets a header.
- header(String, String) - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Adds a header.
- header(String, String) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Adds a header sent with every request (and the tail handshake).
- headers() - Method in record class codes.grow.packages.loki.core.Hooks.RequestInfo
-
Returns the value of the
headersrecord component. - headers() - Method in class codes.grow.packages.loki.core.TransportConfig
-
Returns the extra headers sent with every request.
- headers() - Method in class codes.grow.packages.loki.core.TransportRequest
-
Returns the request headers.
- headers() - Method in class codes.grow.packages.loki.core.TransportResponse
-
Returns the response headers (case-insensitive keys).
- headers() - Method in class codes.grow.packages.loki.LokiConfig
-
Returns the extra request headers.
- headers(Map<String, String>) - Method in class codes.grow.packages.loki.core.TransportConfig.Builder
-
Adds headers sent with every request.
- health() - Method in class codes.grow.packages.loki.LokiClient
-
Readiness:
GET /ready(with the configured auth and tenant headers). - health() - Method in interface codes.grow.packages.loki.testing.CoreTarget
-
Checks liveness; never throws for an unhealthy service.
- healthAsync() - Method in class codes.grow.packages.loki.LokiClient
-
Asynchronous
LokiClient.health(). - HealthCheck - Class in codes.grow.packages.loki.core
-
Implements the
health()contract (SPEC section 2.4): never throws for an unhealthy or unreachable service, only forCancelledExceptionandConfigException. - HealthStatus - Record Class in codes.grow.packages.loki.core
-
Result of
health()(SPEC section 2.4). - HealthStatus(boolean, String, Map<String, String>) - Constructor for record class codes.grow.packages.loki.core.HealthStatus
-
Creates a status; details are copied.
- healthy() - Method in record class codes.grow.packages.loki.core.HealthStatus
-
Returns the value of the
healthyrecord component. - hooks() - Method in class codes.grow.packages.loki.core.TransportConfig
-
Returns the hooks.
- hooks() - Method in class codes.grow.packages.loki.LokiConfig
-
Returns the hooks.
- hooks(Hooks) - Method in class codes.grow.packages.loki.core.TransportConfig.Builder
-
Sets the hooks.
- hooks(Hooks) - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Sets hooks.
- hooks(Hooks) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Sets request hooks.
- Hooks - Interface in codes.grow.packages.loki.core
-
Callbacks invoked for every HTTP attempt (SPEC section 2.5).
- Hooks.ErrorInfo - Record Class in codes.grow.packages.loki.core
-
Data passed to
Hooks.onError(codes.grow.packages.loki.core.Hooks.ErrorInfo). - Hooks.RequestInfo - Record Class in codes.grow.packages.loki.core
-
Data passed to
Hooks.onRequest(codes.grow.packages.loki.core.Hooks.RequestInfo). - Hooks.ResponseInfo - Record Class in codes.grow.packages.loki.core
- httpStatus() - Method in exception class codes.grow.packages.loki.core.LokiException
-
Returns the HTTP status when the error came from a response.
- HttpTransport - Class in codes.grow.packages.loki.core
-
The HTTP engine shared by every client of the SDK (SPEC section 2.3), built on
HttpClient. - HttpTransport(TransportConfig) - Constructor for class codes.grow.packages.loki.core.HttpTransport
-
Creates a transport.
I
- id() - Method in record class codes.grow.packages.loki.testing.ConformanceReport.ScenarioResult
-
Returns the value of the
idrecord component. - id() - Method in record class codes.grow.packages.loki.testing.Scenario
-
Returns the value of the
idrecord component. - idempotent() - Method in class codes.grow.packages.loki.core.TransportRequest
-
Returns whether the request may be replayed after an uncertain send.
- idempotent(boolean) - Method in class codes.grow.packages.loki.core.TransportRequest.Builder
-
Marks the request idempotent (or not), overriding the method default.
- index() - Method in record class codes.grow.packages.loki.testing.ConformanceReport.StepResult
-
Returns the value of the
indexrecord component. - indexStats(String) - Method in class codes.grow.packages.loki.LokiClient
-
Index statistics in the server's default window.
- indexStats(String, TimeRange) - Method in class codes.grow.packages.loki.LokiClient
-
Approximate index statistics:
GET /loki/api/v1/index/stats. - IndexStats - Record Class in codes.grow.packages.loki
-
Approximate index statistics (
LokiClient.indexStats(java.lang.String)). - IndexStats(long, long, long, long) - Constructor for record class codes.grow.packages.loki.IndexStats
-
Creates an instance of a
IndexStatsrecord class. - indexStatsAsync(String, TimeRange) - Method in class codes.grow.packages.loki.LokiClient
-
Asynchronous
LokiClient.indexStats(String, TimeRange). - info(String) - Method in interface codes.grow.packages.loki.core.Logger
-
Logs at info level without fields.
- info(String) - Method in class codes.grow.packages.loki.logging.Logger
-
Logs at INFO.
- info(String, Map<String, ?>) - Method in class codes.grow.packages.loki.logging.Logger
-
Logs at INFO.
- info(String, Map<String, Object>) - Method in interface codes.grow.packages.loki.core.Logger
-
Logs at info level.
- INFO - Enum constant in enum class codes.grow.packages.loki.logging.Severity
-
OTel severity 9.
- initialBackoff() - Method in class codes.grow.packages.loki.core.RetryPolicy
-
Returns the backoff cap for the first retry.
- initialBackoff(Duration) - Method in class codes.grow.packages.loki.core.RetryPolicy.Builder
-
Sets the backoff cap of the first retry.
- InMemoryLogExporter - Class in codes.grow.packages.loki.testing.logging
-
LogExporterthat keeps every accepted record in memory. - InMemoryLogExporter() - Constructor for class codes.grow.packages.loki.testing.logging.InMemoryLogExporter
-
Creates an empty exporter.
- InMemoryLogQueryClient - Class in codes.grow.packages.loki.testing.logging
-
LogQueryClientover in-memory records (usuallyInMemoryLogExporter.records()). - InMemoryLogQueryClient(InMemoryLogExporter) - Constructor for class codes.grow.packages.loki.testing.logging.InMemoryLogQueryClient
-
Reads the records of an exporter.
- InMemoryLogQueryClient(Supplier<List<LogRecord>>) - Constructor for class codes.grow.packages.loki.testing.logging.InMemoryLogQueryClient
-
Reads records from a supplier.
- insecureSkipVerify() - Method in class codes.grow.packages.loki.core.TlsOptions
-
Returns whether certificate and host name verification is disabled (tests only).
- insecureSkipVerify(boolean) - Method in class codes.grow.packages.loki.core.TlsOptions.Builder
-
Disables certificate and host name verification.
- install(LoggerContext, LogClient) - Static method in class codes.grow.packages.loki.logging.GrowLogbackAppender
-
Creates, starts and attaches an appender named
"GROW"to the root logger. - integer(String, String...) - Method in class codes.grow.packages.loki.core.EnvReader
-
Reads an integer.
- interval() - Method in record class codes.grow.packages.loki.logging.TailOptions
-
Returns the value of the
intervalrecord component. - interval() - Method in record class codes.grow.packages.loki.logging.WaitForLogOptions
-
Returns the value of the
intervalrecord component. - interval() - Method in class codes.grow.packages.loki.QueryRangeOptions
-
Returns the stream sampling interval (log queries).
- interval(Duration) - Method in class codes.grow.packages.loki.QueryRangeOptions.Builder
-
Sets the stream sampling interval.
- intervalOr(Duration) - Method in record class codes.grow.packages.loki.logging.TailOptions
-
Returns the caller's interval, or
serviceDefaultwhen it was left unset. - intervalOr(Duration) - Method in record class codes.grow.packages.loki.logging.WaitForLogOptions
-
Returns the caller's interval, or
serviceDefaultwhen it was left unset. - isAllowed(String) - Method in class codes.grow.packages.loki.CardinalityGuard
-
Returns whether a name may be an index label.
- isCleared() - Method in class codes.grow.packages.loki.core.Secret
-
Returns whether
Secret.clear()was called. - isClosed() - Method in class codes.grow.packages.loki.core.HttpTransport
-
Returns whether
HttpTransport.close()was called. - isClosed() - Method in class codes.grow.packages.loki.LokiClient
-
Returns whether
LokiClient.close()was called. - isCustom() - Method in class codes.grow.packages.loki.core.TlsOptions
-
Returns whether any option differs from the system defaults.
- isEmpty() - Method in class codes.grow.packages.loki.core.Secret
-
Returns whether the value is empty.
- isEnabled(Severity) - Method in class codes.grow.packages.loki.logging.Logger
-
Whether records of this severity are sent.
- isOpen() - Method in class codes.grow.packages.loki.LokiTail
-
Returns whether the stream is still open.
- isSensitive(String) - Method in class codes.grow.packages.loki.logging.RedactionProcessor
-
Whether an attribute name matches one of the keys.
- isSensitiveField(String, Collection<String>) - Static method in class codes.grow.packages.loki.core.Redaction
-
Returns whether a field or query parameter name is sensitive (case-insensitive substring).
- isSensitiveHeader(String) - Static method in class codes.grow.packages.loki.core.Redaction
-
Returns whether a header name is sensitive (case-insensitive).
- isValidLabelName(String) - Static method in class codes.grow.packages.loki.Labels
-
Returns whether
namematches[a-zA-Z_][a-zA-Z0-9_]*and does not start with__.
J
- json() - Method in class codes.grow.packages.loki.LogQL
-
Parser stage
| json. - json(TypeReference<T>) - Method in class codes.grow.packages.loki.core.TransportResponse
-
Decodes the JSON body into a generic type.
- json(Class<T>) - Method in class codes.grow.packages.loki.core.TransportResponse
-
Decodes the JSON body.
- json(Object) - Method in class codes.grow.packages.loki.core.TransportRequest.Builder
-
Sets a JSON body encoded with Jackson.
- Json - Class in codes.grow.packages.loki.core
-
Shared Jackson configuration of the SDK.
- JSON - Enum constant in enum class codes.grow.packages.loki.LogProtocol
-
JSON push to
/loki/api/v1/push(default). - JSON - Enum constant in enum class codes.grow.packages.loki.PushFormat
-
application/json(default; optionally gzip). - jsonNode() - Method in class codes.grow.packages.loki.core.TransportResponse
-
Parses the JSON body into a tree.
- JUnitConformance - Class in codes.grow.packages.loki.testing
-
JUnit 5 adapter: one dynamic test per scenario.
K
- KEY - Static variable in class codes.grow.packages.loki.core.SdkInfo
-
Catalog key of the service, e.g.
- keys(Collection<String>) - Method in class codes.grow.packages.loki.logging.RedactionProcessor.Builder
-
Replaces the sensitive key fragments.
- knownSecrets() - Method in class codes.grow.packages.loki.core.TransportConfig
-
Returns the secret values removed from every error message, hook and log line.
- knownSecrets() - Method in class codes.grow.packages.loki.LokiConfig
-
Returns the credential values that are removed from error messages and logs.
- knownSecrets(Supplier<Collection<String>>) - Method in class codes.grow.packages.loki.core.TransportConfig.Builder
-
Sets the supplier of secret values to redact from errors, hooks and logs.
L
- label(String, String, String) - Method in class codes.grow.packages.loki.LogQL
-
Adds a stream-selector matcher.
- labels() - Method in record class codes.grow.packages.loki.DroppedEntry
-
Returns the value of the
labelsrecord component. - labels() - Method in class codes.grow.packages.loki.LokiClient
-
Label names of the server's default window.
- labels() - Method in record class codes.grow.packages.loki.LokiStream
-
Returns the value of the
labelsrecord component. - labels() - Method in record class codes.grow.packages.loki.StreamResult
-
Returns the value of the
labelsrecord component. - labels(LabelsOptions) - Method in class codes.grow.packages.loki.LokiClient
-
Label names:
GET /loki/api/v1/labels. - Labels - Class in codes.grow.packages.loki
-
Label helpers: validation, normalization and Prometheus label-set rendering.
- LABELS - Enum constant in enum class codes.grow.packages.loki.VolumeOptions.AggregateBy
-
By label name.
- labelsAsync(LabelsOptions) - Method in class codes.grow.packages.loki.LokiClient
-
Asynchronous
LokiClient.labels(LabelsOptions). - LabelsOptions - Record Class in codes.grow.packages.loki
-
Options of
LokiClient.labels()andLokiClient.labelValues(java.lang.String). - LabelsOptions(Optional<Instant>, Optional<Instant>, Optional<String>) - Constructor for record class codes.grow.packages.loki.LabelsOptions
-
Normalizes
nullfields to empty. - labelValues(String) - Method in class codes.grow.packages.loki.LokiClient
-
Values of one label in the server's default window.
- labelValues(String, LabelsOptions) - Method in class codes.grow.packages.loki.LokiClient
-
Values of one label:
GET /loki/api/v1/label/{name}/values. - labelValuesAsync(String, LabelsOptions) - Method in class codes.grow.packages.loki.LokiClient
-
Asynchronous
LokiClient.labelValues(String, LabelsOptions). - LANGUAGE - Static variable in class codes.grow.packages.loki.core.SdkInfo
-
Language token in the
User-Agent. - last(Duration) - Static method in record class codes.grow.packages.loki.LabelsOptions
-
Options for the window
[now - window, now](thesinceof the other languages, computed on the client). - last(Duration) - Static method in record class codes.grow.packages.loki.TimeRange
-
The last
windowup to now. - limit() - Method in class codes.grow.packages.loki.LiveTailOptions
-
Returns the maximum number of replayed entries.
- limit() - Method in class codes.grow.packages.loki.logging.SearchOptions
-
Maximum records per page.
- limit() - Method in class codes.grow.packages.loki.QueryOptions
-
Returns the entry limit.
- limit() - Method in class codes.grow.packages.loki.QueryRangeOptions
-
Returns the maximum number of entries across all streams.
- limit() - Method in class codes.grow.packages.loki.VolumeOptions
-
Returns the maximum number of series.
- limit(int) - Method in class codes.grow.packages.loki.LiveTailOptions.Builder
-
Sets the maximum number of replayed entries.
- limit(int) - Method in class codes.grow.packages.loki.logging.SearchOptions.Builder
-
Sets the page size.
- limit(int) - Method in class codes.grow.packages.loki.QueryOptions.Builder
-
Sets the entry limit (≥ 1).
- limit(int) - Method in class codes.grow.packages.loki.QueryRangeOptions.Builder
-
Sets the maximum number of entries (1–5000).
- limit(int) - Method in class codes.grow.packages.loki.VolumeOptions.Builder
-
Sets the maximum number of series.
- line() - Method in record class codes.grow.packages.loki.LokiEntry
-
Returns the value of the
linerecord component. - line() - Method in record class codes.grow.packages.loki.StreamEntry
-
Returns the value of the
linerecord component. - lineContains(String) - Method in class codes.grow.packages.loki.LogQL
-
Line filter
|= "text"(case-sensitive substring). - lineFormat(String) - Method in class codes.grow.packages.loki.LogQL
-
Formatting stage
| line_format "<template>". - lineMatches(String) - Method in class codes.grow.packages.loki.LogQL
-
Line filter
|~ "regex"(RE2; prefix(?i)for case-insensitive). - lineNotContains(String) - Method in class codes.grow.packages.loki.LogQL
-
Line filter
!= "text". - lineNotMatches(String) - Method in class codes.grow.packages.loki.LogQL
-
Line filter
!~ "regex". - listLabels() - Method in interface codes.grow.packages.loki.logging.LogQueryClient
-
Lists the label or field names of the service.
- listLabels() - Method in class codes.grow.packages.loki.LokiLogQueryClient
-
Label names of the default window.
- listLabels() - Method in class codes.grow.packages.loki.testing.logging.InMemoryLogQueryClient
- listLabelsAsync() - Method in interface codes.grow.packages.loki.logging.LogQueryClient
-
Asynchronous
LogQueryClient.listLabels(). - listLabelsAsync() - Method in class codes.grow.packages.loki.LokiLogQueryClient
- listStreams() - Method in interface codes.grow.packages.loki.logging.LogQueryClient
-
Lists the log streams (indexes, streams, data sets) of the service.
- listStreams() - Method in class codes.grow.packages.loki.LokiLogQueryClient
-
Every stream of the default window as a label-set string (
{a="b", c="d"}), sorted. - listStreams() - Method in class codes.grow.packages.loki.testing.logging.InMemoryLogQueryClient
- listStreamsAsync() - Method in interface codes.grow.packages.loki.logging.LogQueryClient
-
Asynchronous
LogQueryClient.listStreams(). - listStreamsAsync() - Method in class codes.grow.packages.loki.LokiLogQueryClient
- LiveTailOptions - Class in codes.grow.packages.loki
- LiveTailOptions.Builder - Class in codes.grow.packages.loki
-
Builder of
LiveTailOptions. - log(Severity, String, Map<String, ?>) - Method in class codes.grow.packages.loki.logging.Logger
-
Logs a message.
- logClient() - Method in class codes.grow.packages.loki.LokiClient
-
A batching log client (JSON push, default batching and redaction).
- logClient(LokiLogClientOptions) - Method in class codes.grow.packages.loki.LokiClient
-
A batching
LogClientthat writes to this Loki (and tenant). - LogClient - Interface in codes.grow.packages.loki.logging
-
Sends log records to the service in the background.
- LogEntry - Interface in codes.grow.packages.loki.logging
- LogExporter - Interface in codes.grow.packages.loki.logging
-
Sends batches of log records to the service.
- logfmt() - Method in class codes.grow.packages.loki.LogQL
-
Parser stage
| logfmt. - logger() - Method in class codes.grow.packages.loki.core.TransportConfig
-
Returns the logger.
- logger() - Method in interface codes.grow.packages.loki.logging.LogClient
-
Returns a logger facade without a name.
- logger() - Method in class codes.grow.packages.loki.LokiConfig
-
Returns the logger.
- logger(Logger) - Method in class codes.grow.packages.loki.core.TransportConfig.Builder
-
Sets the logger.
- logger(Logger) - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Sets the logger.
- logger(Logger) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Sets the logger (default silent).
- logger(String) - Method in interface codes.grow.packages.loki.logging.LogClient
-
Returns a named logger facade.
- logger(String, Map<String, ?>) - Method in interface codes.grow.packages.loki.logging.LogClient
-
Returns a named logger facade with fixed attributes.
- Logger - Class in codes.grow.packages.loki.logging
-
Small logging facade on top of a
LogClient. - Logger - Interface in codes.grow.packages.loki.core
-
Minimal logger used by the transport (SPEC section 2.5).
- Logger(LogClient, String, Map<String, ?>, Severity) - Constructor for class codes.grow.packages.loki.logging.Logger
-
Creates a logger.
- LoggingOps - Class in codes.grow.packages.loki.testing.logging
-
Conformance operations of the
loggingcategory:send,sendBatch,flush,searchUntil,stats. - LoggingOps() - Constructor for class codes.grow.packages.loki.testing.logging.LoggingOps
-
Creates the operations.
- LoggingTarget - Record Class in codes.grow.packages.loki.testing.logging
-
Target of the
loggingconformance scenarios: the client that sends and the (optional) query client that reads back. - LoggingTarget(LogClient, Optional<LogQueryClient>) - Constructor for record class codes.grow.packages.loki.testing.logging.LoggingTarget
-
Validates the target.
- LogInput - Class in codes.grow.packages.loki.logging
-
Short form of a log record: a message plus optional severity, attributes, timestamp and trace ids.
- LogInput.Builder - Class in codes.grow.packages.loki.logging
-
Builder for
LogInput. - LogProtocol - Enum Class in codes.grow.packages.loki
-
How a
log clientships records. - LogQL - Class in codes.grow.packages.loki
-
Immutable LogQL query builder with safe escaping.
- logQueryClient() - Method in class codes.grow.packages.loki.LokiClient
-
A
LogQueryClient(search, tail, listStreams, listLabels, waitForLog) on this Loki and tenant. - LogQueryClient - Interface in codes.grow.packages.loki.logging
-
Reads logs back from the service.
- LogRecord - Class in codes.grow.packages.loki.logging
-
One immutable log record in the normalized SDK form (OpenTelemetry log data model).
- LogRecord.Builder - Class in codes.grow.packages.loki.logging
-
Builder for
LogRecord. - LogRecordJson - Class in codes.grow.packages.loki.logging
-
Converts
LogRecordto and from the normalized JSON wire form (spec/schemas/log-record.schema.json). - LogSearchResult - Record Class in codes.grow.packages.loki.logging
- LogSearchResult(List<LogRecord>, Optional<String>, OptionalLong) - Constructor for record class codes.grow.packages.loki.logging.LogSearchResult
-
Copies the list and replaces
nulloptionals by empty ones. - LokiClient - Class in codes.grow.packages.loki
-
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()). - LokiClient.Builder - Class in codes.grow.packages.loki
-
Builder that configures and creates a client in one chain.
- LokiConfig - Class in codes.grow.packages.loki
-
Immutable configuration of a
LokiClient(SPEC section 2.2). - LokiConfig.Builder - Class in codes.grow.packages.loki
-
Builder of the configuration.
- LokiEntry - Record Class in codes.grow.packages.loki
-
One log line of a
LokiStream. - LokiEntry(Instant, String, Map<String, String>) - Constructor for record class codes.grow.packages.loki.LokiEntry
-
Validates and copies the fields.
- LokiException - Exception Class in codes.grow.packages.loki.core
-
Base class of every error raised by the Grafana Loki SDK (SPEC section 2.1).
- LokiException(ErrorCode, String, Integer, String, boolean, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.LokiException
-
Creates an exception.
- LokiLogClientOptions - Class in codes.grow.packages.loki
-
Options of
LokiClient.logClient(LokiLogClientOptions). - LokiLogClientOptions.Builder - Class in codes.grow.packages.loki
-
Builder of
LokiLogClientOptions. - LokiLogExporter - Class in codes.grow.packages.loki
-
LogExporterof the logging category that writes records withPOST /loki/api/v1/push. - LokiLogExporter(LokiClient, PushFormat, CardinalityGuard) - Constructor for class codes.grow.packages.loki.LokiLogExporter
-
Creates an exporter.
- LokiLogQueryClient - Class in codes.grow.packages.loki
-
LogQueryClientof 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) andwaitForLog. - LokiLogQueryClient(LokiClient) - Constructor for class codes.grow.packages.loki.LokiLogQueryClient
-
Creates a query client.
- LokiOtlpExporter - Class in codes.grow.packages.loki
-
LogExporterthat writes OTLP/JSON toPOST /otlp/v1/logs. - LokiOtlpExporter(LokiClient) - Constructor for class codes.grow.packages.loki.LokiOtlpExporter
-
Creates an exporter.
- LokiServerException - Exception Class in codes.grow.packages.loki
-
A non-transient server-side failure with code
ErrorCode.UNAVAILABLEandretryable=false. - LokiServerException(String, Integer, String, Throwable) - Constructor for exception class codes.grow.packages.loki.LokiServerException
-
Creates the exception.
- LokiStream - Record Class in codes.grow.packages.loki
-
A Loki log stream (
LokiStream): one label set and its entries, the input ofLokiClient.push(java.util.List<codes.grow.packages.loki.LokiStream>). - LokiStream(Map<String, String>, List<LokiEntry>) - Constructor for record class codes.grow.packages.loki.LokiStream
-
Copies the fields.
- LokiTail - Class in codes.grow.packages.loki
-
Handle of an open tail stream (
LokiClient.tail(java.lang.String, java.util.function.Consumer<codes.grow.packages.loki.TailFrame>)).
M
- map(TransportResponse, LokiException) - Method in interface codes.grow.packages.loki.core.ErrorMapper
-
Maps a failed response.
- mapper() - Static method in class codes.grow.packages.loki.core.Json
-
Returns the shared mapper.
- matches(String, LogRecord) - Static method in class codes.grow.packages.loki.testing.logging.InMemoryLogQueryClient
-
Whether a record matches a query.
- matrix() - Method in record class codes.grow.packages.loki.QueryResult
-
Returns the value of the
matrixrecord component. - MATRIX - Enum constant in enum class codes.grow.packages.loki.ResultType
-
Sample series (
QueryResult.matrix()). - MatrixSeries - Record Class in codes.grow.packages.loki
-
One series of a
matrixresult. - MatrixSeries(Map<String, String>, List<Sample>) - Constructor for record class codes.grow.packages.loki.MatrixSeries
-
Copies the fields.
- MAX_QUERY_LIMIT - Static variable in class codes.grow.packages.loki.LokiLogQueryClient
-
Largest
limitLoki accepts per query by default (max_entries_limit_per_query). - MAX_TENANT_ID_LENGTH - Static variable in class codes.grow.packages.loki.LokiConfig
-
Longest tenant id Loki accepts, in bytes.
- MAX_VENDOR_TEXT - Static variable in class codes.grow.packages.loki.core.Redaction
-
Maximum length of vendor error text kept in error messages.
- maxBackoff() - Method in class codes.grow.packages.loki.core.RetryPolicy
-
Returns the upper bound of any backoff.
- maxBackoff(Duration) - Method in class codes.grow.packages.loki.core.RetryPolicy.Builder
-
Sets the upper bound of every backoff.
- maxBatchBytes() - Method in class codes.grow.packages.loki.logging.BatchOptions
-
Maximum UTF-8 JSON bytes per export (default 1 048 576).
- maxBatchBytes(int) - Method in class codes.grow.packages.loki.logging.BatchOptions.Builder
-
Sets the batch byte limit.
- maxBatchSize() - Method in class codes.grow.packages.loki.logging.BatchOptions
-
Maximum records per export (default 512).
- maxBatchSize(int) - Method in class codes.grow.packages.loki.logging.BatchOptions.Builder
-
Sets the batch size.
- maxExportRetries() - Method in class codes.grow.packages.loki.logging.BatchOptions
-
Export attempts repeated after a retryable failure (default 2).
- maxExportRetries(int) - Method in class codes.grow.packages.loki.logging.BatchOptions.Builder
-
Sets how often a batch is re-exported after a retryable failure.
- maxQueueSize() - Method in class codes.grow.packages.loki.logging.BatchOptions
-
Maximum number of queued records (default 2048).
- maxQueueSize(int) - Method in class codes.grow.packages.loki.logging.BatchOptions.Builder
-
Sets the queue size.
- maxRetries() - Method in class codes.grow.packages.loki.core.RetryPolicy
-
Returns the maximum number of retries after the first attempt.
- maxRetries() - Method in class codes.grow.packages.loki.core.TransportRequest
-
Returns the retry limit override.
- maxRetries(int) - Method in class codes.grow.packages.loki.core.RetryPolicy.Builder
-
Sets the maximum number of retries.
- maxRetries(int) - Method in class codes.grow.packages.loki.core.TransportRequest.Builder
-
Overrides the retry limit for this call.
- maxRetryAfter() - Method in class codes.grow.packages.loki.core.RetryPolicy
-
Returns the longest
Retry-Afterwait the client accepts. - maxRetryAfter(Duration) - Method in class codes.grow.packages.loki.core.RetryPolicy.Builder
-
Sets the longest accepted
Retry-After. - merge(Map<String, ?>...) - Static method in class codes.grow.packages.loki.logging.AttrValues
-
Merges attribute maps; later maps win on key collisions.
- message() - Method in class codes.grow.packages.loki.logging.LogInput
-
Message.
- message() - Method in record class codes.grow.packages.loki.testing.ConformanceReport.StepResult
-
Returns the value of the
messagerecord component. - METADATA_OBSERVED_TIMESTAMP - Static variable in class codes.grow.packages.loki.LokiLogExporter
-
Structured metadata key of the observed timestamp (Unix nanoseconds).
- METADATA_SEVERITY_NUMBER - Static variable in class codes.grow.packages.loki.LokiLogExporter
-
Structured metadata key of the OTel severity number.
- METADATA_SEVERITY_TEXT - Static variable in class codes.grow.packages.loki.LokiLogExporter
-
Structured metadata key of the severity text.
- METADATA_SPAN_ID - Static variable in class codes.grow.packages.loki.LokiLogExporter
-
Structured metadata key of the span id.
- METADATA_TRACE_FLAGS - Static variable in class codes.grow.packages.loki.LokiLogExporter
-
Structured metadata key of the trace flags.
- METADATA_TRACE_ID - Static variable in class codes.grow.packages.loki.LokiLogExporter
-
Structured metadata key of the trace id.
- method() - Method in record class codes.grow.packages.loki.core.Hooks.ErrorInfo
-
Returns the value of the
methodrecord component. - method() - Method in record class codes.grow.packages.loki.core.Hooks.RequestInfo
-
Returns the value of the
methodrecord component. - method() - Method in record class codes.grow.packages.loki.core.Hooks.ResponseInfo
-
Returns the value of the
methodrecord component. - method() - Method in class codes.grow.packages.loki.core.TransportRequest
-
Returns the HTTP method.
- metric() - Method in record class codes.grow.packages.loki.MatrixSeries
-
Returns the value of the
metricrecord component. - metric() - Method in record class codes.grow.packages.loki.VectorSample
-
Returns the value of the
metricrecord component. - minSeverity() - Method in class codes.grow.packages.loki.logging.Logger
-
Minimum severity.
- multiplier() - Method in class codes.grow.packages.loki.core.RetryPolicy
-
Returns the exponential growth factor.
- multiplier(double) - Method in class codes.grow.packages.loki.core.RetryPolicy.Builder
-
Sets the exponential growth factor.
- multiTenantQueries() - Method in class codes.grow.packages.loki.LokiConfig
-
Returns whether tenant ids joined with
|(multi-tenant queries) are allowed. - multiTenantQueries(boolean) - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Allows tenant ids joined with
|(multi-tenant queries). - multiTenantQueries(boolean) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Allows tenant ids joined with
|(Loki's multi-tenant query syntax; the server must enablemulti_tenant_queries_enabled).
N
- name() - Method in class codes.grow.packages.loki.logging.Logger
-
Logger name.
- NAME_ATTRIBUTE - Static variable in class codes.grow.packages.loki.logging.Logger
-
Attribute that carries the logger name.
- nextCursor() - Method in record class codes.grow.packages.loki.logging.LogSearchResult
-
Returns the value of the
nextCursorrecord component. - none() - Static method in class codes.grow.packages.loki.core.RetryPolicy
-
Returns a policy that never retries.
- NONE - Static variable in interface codes.grow.packages.loki.core.ErrorMapper
-
Keeps the default error.
- NONE - Static variable in interface codes.grow.packages.loki.core.Hooks
-
Hooks that do nothing.
- NOOP - Static variable in interface codes.grow.packages.loki.core.Logger
-
A logger that discards everything.
- normalize(Object) - Static method in class codes.grow.packages.loki.logging.AttrValues
-
Returns the normalised, deeply immutable form of
value. - normalizeLabelName(String) - Static method in class codes.grow.packages.loki.Labels
-
Normalizes an attribute key the way Loki does for OTLP attributes: every character outside
[a-zA-Z0-9_]becomes_(service.name→service_name) and a leading digit gets a_prefix. - normalizeMap(Map<?, ?>) - Static method in class codes.grow.packages.loki.logging.AttrValues
-
Normalises every value of a map; keys become strings.
- NOT_FOUND - Enum constant in enum class codes.grow.packages.loki.core.ErrorCode
-
HTTP 404 or a missing record.
- NotFoundException - Exception Class in codes.grow.packages.loki.core
-
The record does not exist (HTTP 404).
- NotFoundException(String) - Constructor for exception class codes.grow.packages.loki.core.NotFoundException
-
Creates the exception.
- NotFoundException(String, Integer, String, boolean, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.NotFoundException
-
Creates the exception with response details and an explicit
retryableflag, for service subclasses whose errors differ from the default of the code (for example aCONFLICTthat may succeed when retried, or anUNAVAILABLEthat will not). - NotFoundException(String, Integer, String, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.NotFoundException
-
Creates the exception with response details.
- NotFoundException(String, Throwable) - Constructor for exception class codes.grow.packages.loki.core.NotFoundException
-
Creates the exception with a cause.
- number() - Method in enum class codes.grow.packages.loki.logging.Severity
-
Returns the OpenTelemetry severity number.
O
- observedTimestamp() - Method in class codes.grow.packages.loki.logging.LogRecord
-
Time the SDK observed the record.
- observedTimestamp(Instant) - Method in class codes.grow.packages.loki.logging.LogRecord.Builder
-
Sets the observed time.
- of(char[]) - Static method in class codes.grow.packages.loki.core.Secret
-
Wraps a copy of a character array; the caller may clear its own array afterwards.
- of(ErrorCode, String, Integer, String, boolean, Duration, Throwable) - Static method in exception class codes.grow.packages.loki.core.LokiException
-
Like
LokiException.of(ErrorCode, String, Integer, String, Duration, Throwable)with an explicitretryableflag instead of the default of the code. - of(ErrorCode, String, Integer, String, Duration, Throwable) - Static method in exception class codes.grow.packages.loki.core.LokiException
-
Creates the subclass that matches
code. - of(LogClient, LogQueryClient) - Static method in record class codes.grow.packages.loki.testing.logging.LoggingTarget
-
Creates a target.
- of(Severity, String, Map<String, ?>) - Static method in class codes.grow.packages.loki.logging.LogInput
-
Creates an input with a severity and attributes.
- of(PushFormat) - Static method in record class codes.grow.packages.loki.PushOptions
-
Options with a wire format.
- of(Object) - Static method in class codes.grow.packages.loki.testing.OpResult
-
Wraps a value.
- of(String) - Static method in class codes.grow.packages.loki.core.Secret
-
Wraps a string value.
- of(String) - Static method in class codes.grow.packages.loki.logging.LogInput
-
Creates an INFO input with no attributes.
- of(String) - Static method in record class codes.grow.packages.loki.LokiEntry
-
An entry stamped "now" at push time.
- of(Throwable) - Static method in enum class codes.grow.packages.loki.core.ErrorCode
-
Returns the code of an SDK exception.
- of(Duration, Duration) - Static method in record class codes.grow.packages.loki.logging.WaitForLogOptions
-
Options with a timeout and interval.
- of(Instant, String) - Static method in record class codes.grow.packages.loki.LokiEntry
-
An entry with a timestamp.
- of(Instant, String, Map<String, String>) - Static method in record class codes.grow.packages.loki.LokiEntry
-
An entry with a timestamp and structured metadata.
- of(Instant, Instant) - Static method in record class codes.grow.packages.loki.LabelsOptions
-
A window.
- of(Instant, Instant) - Static method in record class codes.grow.packages.loki.TimeRange
-
A window from
starttoend. - of(List<LogRecord>) - Static method in record class codes.grow.packages.loki.logging.LogSearchResult
-
A single page without cursor or total.
- of(Map<String, String>) - Static method in class codes.grow.packages.loki.core.EnvReader
-
Creates a reader with
EnvReader.DEFAULT_PREFIXover an explicit map. - of(Map<String, String>, LokiEntry...) - Static method in record class codes.grow.packages.loki.LokiStream
-
Creates a stream.
- ok() - Static method in record class codes.grow.packages.loki.core.HealthStatus
-
A healthy
okstatus without details. - onDrop() - Method in class codes.grow.packages.loki.logging.BatchOptions
-
Drop callback.
- onDrop(BiConsumer<List<LogRecord>, DropReason>) - Method in class codes.grow.packages.loki.logging.BatchOptions.Builder
-
Sets the drop callback (exceptions it throws are ignored).
- onDropped() - Method in class codes.grow.packages.loki.LiveTailOptions
-
Returns the callback for entries the server dropped because the client fell behind.
- onDropped(Consumer<List<DroppedEntry>>) - Method in class codes.grow.packages.loki.LiveTailOptions.Builder
-
Sets the dropped-entries callback.
- onError() - Method in class codes.grow.packages.loki.LiveTailOptions
-
Returns the callback for errors after the connection was established (bad frame, abnormal close).
- onError() - Method in class codes.grow.packages.loki.logging.BatchOptions
-
Export error callback.
- onError() - Method in record class codes.grow.packages.loki.logging.TailOptions
-
Returns the value of the
onErrorrecord component. - onError(Hooks.ErrorInfo) - Method in interface codes.grow.packages.loki.core.Hooks
-
Called when an attempt failed (network error, timeout or error status).
- onError(BiConsumer<Throwable, List<LogRecord>>) - Method in class codes.grow.packages.loki.logging.BatchOptions.Builder
-
Sets the export error callback (exceptions it throws are ignored).
- onError(Consumer<LokiException>) - Method in class codes.grow.packages.loki.LiveTailOptions.Builder
-
Sets the error callback.
- only(String...) - Method in class codes.grow.packages.loki.testing.ConformanceRunner.Builder
-
Restricts the run to these scenario ids.
- onRequest(Hooks.RequestInfo) - Method in interface codes.grow.packages.loki.core.Hooks
-
Called before each attempt.
- onResponse(Hooks.ResponseInfo) - Method in interface codes.grow.packages.loki.core.Hooks
-
Called when an attempt received a response (any status).
- op() - Method in record class codes.grow.packages.loki.testing.ConformanceReport.StepResult
-
Returns the value of the
oprecord component. - op() - Method in record class codes.grow.packages.loki.testing.Scenario.Step
-
Returns the value of the
oprecord component. - op(String, String, OpHandler) - Method in class codes.grow.packages.loki.testing.ConformanceRunner.Builder
-
Registers one operation.
- operation() - Method in class codes.grow.packages.loki.core.TransportRequest
-
Returns the operation name used in error messages.
- operation(String) - Method in class codes.grow.packages.loki.core.TransportRequest.Builder
-
Sets the operation name used in error messages.
- OpHandler - Interface in codes.grow.packages.loki.testing
-
Executes one scenario step and returns its result (or an
OpResult). - OpResult - Class in codes.grow.packages.loki.testing
-
A step result with optional extra views for the expectations
countandtree. - ops() - Method in interface codes.grow.packages.loki.testing.ConformanceOps
-
Returns the handlers by operation name.
- ops() - Method in class codes.grow.packages.loki.testing.CoreOps
- ops() - Method in class codes.grow.packages.loki.testing.logging.LoggingOps
- optArg(String) - Method in class codes.grow.packages.loki.testing.StepContext
-
Returns an optional argument.
- options() - Method in class codes.grow.packages.loki.logging.BatchProcessor
-
The options.
- order() - Method in class codes.grow.packages.loki.logging.SearchOptions
-
Order.
- order(SortOrder) - Method in class codes.grow.packages.loki.logging.SearchOptions.Builder
-
Sets the order.
- OTLP - Enum constant in enum class codes.grow.packages.loki.LogProtocol
-
OTLP/JSON to
/otlp/v1/logs; Loki chooses the labels.
P
- parse(JsonNode) - Static method in record class codes.grow.packages.loki.testing.Scenario
-
Parses a scenario document.
- parse(String) - Static method in enum class codes.grow.packages.loki.logging.Severity
-
Parses a severity text case-insensitively.
- parseBool(String) - Static method in class codes.grow.packages.loki.core.EnvReader
-
Parses a boolean:
true/false/1/0/yes/no/on/off, case-insensitive. - parsed() - Method in record class codes.grow.packages.loki.StreamEntry
-
Returns the value of the
parsedrecord component. - parseDuration(String) - Static method in class codes.grow.packages.loki.core.EnvReader
-
Parses a duration: integer milliseconds (
1500) or Go-style units (500ms,10s,2m,1h,1m30s). - parseRateLimitReset(String, Instant) - Static method in class codes.grow.packages.loki.core.RetryPolicy
-
Parses a vendor rate-limit reset header such as
X-RateLimit-Reset: delay seconds (decimals allowed), Unix epoch seconds (values of at least1000000000) or an HTTP-date. - parseRetryAfter(String, Instant) - Static method in class codes.grow.packages.loki.core.RetryPolicy
-
Parses a
Retry-Afterheader: delay seconds or an HTTP-date. - passed() - Method in record class codes.grow.packages.loki.testing.ConformanceReport
-
Returns whether no scenario failed.
- PASSED - Enum constant in enum class codes.grow.packages.loki.testing.ConformanceReport.Status
-
Every expectation held.
- password() - Method in class codes.grow.packages.loki.LokiConfig
-
Returns the Basic-auth password (or Grafana Cloud access token).
- password(Secret) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Sets the Basic-auth password (or Grafana Cloud access token).
- password(String) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Sets the Basic-auth password.
- path() - Method in class codes.grow.packages.loki.core.TransportRequest
-
Returns the path.
- pattern(String) - Method in class codes.grow.packages.loki.LogQL
-
Parser stage
| pattern "<pattern>". - pattern(Pattern) - Method in class codes.grow.packages.loki.logging.RedactionProcessor.Builder
-
Adds a pattern applied to the body and string attribute values.
- PERMISSION_DENIED - Enum constant in enum class codes.grow.packages.loki.core.ErrorCode
-
HTTP 403: the credentials lack a permission.
- PermissionDeniedException - Exception Class in codes.grow.packages.loki.core
-
The credentials lack a permission (HTTP 403).
- PermissionDeniedException(String) - Constructor for exception class codes.grow.packages.loki.core.PermissionDeniedException
-
Creates the exception.
- PermissionDeniedException(String, Integer, String, boolean, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.PermissionDeniedException
-
Creates the exception with response details and an explicit
retryableflag, for service subclasses whose errors differ from the default of the code (for example aCONFLICTthat may succeed when retried, or anUNAVAILABLEthat will not). - PermissionDeniedException(String, Integer, String, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.PermissionDeniedException
-
Creates the exception with response details.
- PermissionDeniedException(String, Throwable) - Constructor for exception class codes.grow.packages.loki.core.PermissionDeniedException
-
Creates the exception with a cause.
- ping() - Method in class codes.grow.packages.loki.LokiClient
-
Authenticated round trip:
GET /loki/api/v1/labels?since=5mwith auth and tenant headers. - ping() - Method in interface codes.grow.packages.loki.testing.CoreTarget
-
Performs an authenticated round trip.
- pingAsync() - Method in class codes.grow.packages.loki.LokiClient
-
Asynchronous
LokiClient.ping(). - pipe(String) - Method in class codes.grow.packages.loki.LogQL
-
Appends a raw pipeline stage (
| <stage>), e.g. - PLUGIN_NAME - Static variable in class codes.grow.packages.loki.logging.GrowLog4j2Appender
-
Plugin element name in
log4j2.xml. - poll(String, Duration) - Method in class codes.grow.packages.loki.testing.ConformanceRunner.Builder
-
Repeats a failing step of
opuntil its expectation passes ortimeout(or the step'stimeoutMsargument) runs out, for eventually consistent backends. - Poll - Class in codes.grow.packages.loki.core
-
Generic polling helper (
pollUntil): used bywaitForLog,waitForTraceand service waiters. - pollInterval(Duration) - Method in class codes.grow.packages.loki.testing.ConformanceRunner.Builder
-
Sets the pause between repeated steps (default
ConformanceRunner.DEFAULT_POLL_INTERVAL). - post(String) - Static method in class codes.grow.packages.loki.core.TransportRequest
-
Starts a POST request.
- predicate() - Method in record class codes.grow.packages.loki.logging.WaitForLogOptions
-
Returns the value of the
predicaterecord component. - prefix(String) - Method in class codes.grow.packages.loki.testing.ConformanceRunner.Builder
-
Sets the
${prefix}template (may contain${run}). - process(LogRecord) - Method in class codes.grow.packages.loki.logging.RedactionProcessor
-
Returns a redacted copy of the record.
- processor() - Method in class codes.grow.packages.loki.logging.BatchingLogClient
-
The underlying processor.
- PROTOBUF - Enum constant in enum class codes.grow.packages.loki.LogProtocol
-
Snappy-compressed protobuf push to
/loki/api/v1/push. - PROTOBUF - Enum constant in enum class codes.grow.packages.loki.PushFormat
-
Snappy-compressed
logproto.PushRequest(application/x-protobuf), encoded from the field numbers of Loki's Apache-2.0pkg/push/push.proto. - protocol() - Method in class codes.grow.packages.loki.LokiLogClientOptions
-
Returns the protocol.
- protocol(LogProtocol) - Method in class codes.grow.packages.loki.LokiLogClientOptions.Builder
-
Sets the protocol (default
LogProtocol.JSON). - proxy() - Method in class codes.grow.packages.loki.core.TransportConfig
-
Returns the proxy URL.
- proxy() - Method in class codes.grow.packages.loki.LokiConfig
-
Returns the explicit proxy URL.
- proxy(String) - Method in class codes.grow.packages.loki.core.TransportConfig.Builder
-
Sets an explicit HTTP proxy URL, e.g.
- proxy(String) - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Sets the proxy URL.
- proxy(String) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Sets an explicit proxy URL; environment proxies (
HTTPS_PROXY) are never used. - publish(LogRecord) - Method in class codes.grow.packages.loki.logging.GrowJulHandler
- push(List<LokiStream>) - Method in class codes.grow.packages.loki.LokiClient
-
Pushes streams as JSON (
POST /loki/api/v1/push). - push(List<LokiStream>, PushOptions) - Method in class codes.grow.packages.loki.LokiClient
-
Pushes streams (
POST /loki/api/v1/push). - pushAsync(List<LokiStream>, PushOptions) - Method in class codes.grow.packages.loki.LokiClient
-
Asynchronous
LokiClient.push(List, PushOptions). - PushFormat - Enum Class in codes.grow.packages.loki
- PushOptions - Record Class in codes.grow.packages.loki
- PushOptions(PushFormat, boolean) - Constructor for record class codes.grow.packages.loki.PushOptions
-
Validates the fields.
- pushOtlp(List<LogRecord>) - Method in class codes.grow.packages.loki.LokiClient
-
Pushes records as OTLP/JSON to
POST /otlp/v1/logs(Loki's OTLP endpoint). - pushOtlp(List<LogRecord>, boolean) - Method in class codes.grow.packages.loki.LokiClient
-
Pushes records as OTLP/JSON, optionally gzip-compressed.
- pushOtlpAsync(List<LogRecord>, boolean) - Method in class codes.grow.packages.loki.LokiClient
-
Asynchronous
LokiClient.pushOtlp(List, boolean). - put(String) - Static method in class codes.grow.packages.loki.core.TransportRequest
-
Starts a PUT request.
Q
- query() - Method in class codes.grow.packages.loki.core.TransportRequest
-
Returns the query parameters in insertion order.
- query() - Method in record class codes.grow.packages.loki.LabelsOptions
-
Returns the value of the
queryrecord component. - query() - Method in record class codes.grow.packages.loki.testing.logging.LoggingTarget
-
Returns the value of the
queryrecord component. - query(String) - Method in class codes.grow.packages.loki.LokiClient
-
Instant metric query at the current time.
- query(String, QueryOptions) - Method in class codes.grow.packages.loki.LokiClient
-
Instant metric query:
GET /loki/api/v1/query. - query(String, Object) - Method in class codes.grow.packages.loki.core.TransportRequest.Builder
-
Adds a query parameter (repeatable).
- queryAsync(String, QueryOptions) - Method in class codes.grow.packages.loki.LokiClient
-
Asynchronous
LokiClient.query(String, QueryOptions). - QueryOptions - Class in codes.grow.packages.loki
-
Options of
LokiClient.query(java.lang.String)(instant metric queries). - QueryOptions.Builder - Class in codes.grow.packages.loki
-
Builder of
QueryOptions. - queryRange(String) - Method in class codes.grow.packages.loki.LokiClient
-
Range query over the last hour (newest first, server default limit 100).
- queryRange(String, QueryRangeOptions) - Method in class codes.grow.packages.loki.LokiClient
-
Range query (logs or metrics):
GET /loki/api/v1/query_range. - queryRangeAsync(String, QueryRangeOptions) - Method in class codes.grow.packages.loki.LokiClient
-
Asynchronous
LokiClient.queryRange(String, QueryRangeOptions). - QueryRangeOptions - Class in codes.grow.packages.loki
-
Options of
LokiClient.queryRange(java.lang.String)(log and metric range queries). - QueryRangeOptions.Builder - Class in codes.grow.packages.loki
-
Builder of
QueryRangeOptions. - QueryResult - Record Class in codes.grow.packages.loki
- QueryResult(ResultType, List<StreamResult>, List<VectorSample>, List<MatrixSeries>, Optional<Sample>, Map<String, Object>) - Constructor for record class codes.grow.packages.loki.QueryResult
-
Copies the fields.
- QUEUE_FULL - Enum constant in enum class codes.grow.packages.loki.logging.DropReason
-
The queue was full (
"queue_full"). - queued() - Method in record class codes.grow.packages.loki.logging.BatchStats
-
Returns the value of the
queuedrecord component. - quote(String) - Static method in class codes.grow.packages.loki.LogQL
-
Quotes a LogQL string literal with Go/JSON escaping (
",\, control characters); other Unicode stays as is.
R
- random(RandomGenerator) - Method in class codes.grow.packages.loki.core.RetryPolicy.Builder
-
Injects the random source used for jitter (tests).
- RATE_LIMITED - Enum constant in enum class codes.grow.packages.loki.core.ErrorCode
-
HTTP 429.
- RateLimitException - Exception Class in codes.grow.packages.loki.core
-
The service rate-limited the call (HTTP 429); see
LokiException.retryAfter(). - RateLimitException(String) - Constructor for exception class codes.grow.packages.loki.core.RateLimitException
-
Creates the exception.
- RateLimitException(String, Integer, String, boolean, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.RateLimitException
-
Creates the exception with response details and an explicit
retryableflag, for service subclasses whose errors differ from the default of the code (for example aCONFLICTthat may succeed when retried, or anUNAVAILABLEthat will not). - RateLimitException(String, Integer, String, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.RateLimitException
-
Creates the exception with response details.
- RateLimitException(String, Throwable) - Constructor for exception class codes.grow.packages.loki.core.RateLimitException
-
Creates the exception with a cause.
- raw() - Method in record class codes.grow.packages.loki.testing.Scenario
-
Returns the value of the
rawrecord component. - ready() - Method in class codes.grow.packages.loki.LokiClient
-
Returns whether
GET /readyanswers 200 (same probe asLokiClient.health()). - readyAsync() - Method in class codes.grow.packages.loki.LokiClient
-
Asynchronous
LokiClient.ready(). - reason() - Method in record class codes.grow.packages.loki.testing.ConformanceReport.ScenarioResult
-
Returns the value of the
reasonrecord component. - records() - Method in record class codes.grow.packages.loki.logging.LogSearchResult
-
Returns the value of the
recordsrecord component. - records() - Method in class codes.grow.packages.loki.testing.logging.InMemoryLogExporter
-
Accepted records in export order.
- recordsToStreams(List<LogRecord>, CardinalityGuard) - Static method in class codes.grow.packages.loki.LokiLogExporter
-
Converts records into Loki streams; records with the same final label set share a stream.
- REDACTED - Static variable in class codes.grow.packages.loki.core.Redaction
-
Replacement for every redacted value.
- redactFields(Map<String, ?>) - Static method in class codes.grow.packages.loki.core.Redaction
-
Same as
Redaction.redactFields(Map, Collection)without extra keys. - redactFields(Map<String, ?>, Collection<String>) - Static method in class codes.grow.packages.loki.core.Redaction
-
Returns a deep copy of a structure with the values of sensitive keys replaced; recurses into nested maps and lists.
- redactHeaderLists(Map<String, List<String>>) - Static method in class codes.grow.packages.loki.core.Redaction
-
Returns a copy of multi-valued headers with sensitive values replaced.
- redactHeaders(Map<String, String>) - Static method in class codes.grow.packages.loki.core.Redaction
-
Returns a copy of single-valued headers with sensitive values replaced.
- redaction() - Method in class codes.grow.packages.loki.LokiLogClientOptions
-
Returns the redaction processor.
- redaction(RedactionProcessor) - Method in class codes.grow.packages.loki.logging.BatchingLogClient.Builder
-
Sets the redaction processor;
nulldisables redaction (not recommended). - redaction(RedactionProcessor) - Method in class codes.grow.packages.loki.LokiLogClientOptions.Builder
-
Sets the redaction processor (
nulldisables redaction). - Redaction - Class in codes.grow.packages.loki.core
-
Redaction helpers for headers, URLs, structured fields and free text (SPEC section 2.6).
- RedactionProcessor - Class in codes.grow.packages.loki.logging
-
Redacts log records before they are queued.
- RedactionProcessor.Builder - Class in codes.grow.packages.loki.logging
-
Builder for
RedactionProcessor. - redactMap(Map<String, ?>) - Method in class codes.grow.packages.loki.logging.RedactionProcessor
-
Redacts an attribute map (same rules as for record attributes).
- redactText(String, Collection<String>) - Static method in class codes.grow.packages.loki.core.Redaction
-
Replaces every occurrence of each known secret value (length 4 or more) with "[REDACTED]".
- redactUrl(String) - Static method in class codes.grow.packages.loki.core.Redaction
-
Redacts user-info passwords and the values of sensitive query parameters in a URL.
- regexp(String) - Method in class codes.grow.packages.loki.LogQL
-
Parser stage
| regexp "<re>"with named capture groups. - register(ConformanceOps) - Method in class codes.grow.packages.loki.testing.ConformanceRunner.Builder
-
Registers (or overrides) operations of a category.
- register(AutoCloseable) - Method in class codes.grow.packages.loki.LokiClient
-
Registers a resource (batch processor, log client) closed with the client.
- rejected() - Method in record class codes.grow.packages.loki.logging.ExportResult
-
Returns the value of the
rejectedrecord component. - replacement(String) - Method in class codes.grow.packages.loki.logging.RedactionProcessor.Builder
-
Sets the replacement text.
- REQUEST_ID_HEADERS - Static variable in class codes.grow.packages.loki.core.HttpTransport
-
Response headers that carry a vendor request id, in lookup order.
- requestId() - Method in record class codes.grow.packages.loki.core.Hooks.ResponseInfo
-
Returns the value of the
requestIdrecord component. - requestId() - Method in exception class codes.grow.packages.loki.core.LokiException
-
Returns the vendor request id header of the failed response.
- requestId() - Method in class codes.grow.packages.loki.core.TransportResponse
-
Returns the vendor request id header.
- RequestInfo(String, String, Map<String, List<String>>, int) - Constructor for record class codes.grow.packages.loki.core.Hooks.RequestInfo
-
Creates an instance of a
RequestInforecord class. - requestTimeout() - Method in class codes.grow.packages.loki.core.TransportConfig
-
Returns the per-attempt timeout.
- requestTimeout() - Method in class codes.grow.packages.loki.LokiConfig
-
Returns the per-attempt timeout.
- requestTimeout(Duration) - Method in class codes.grow.packages.loki.core.TransportConfig.Builder
-
Sets the per-attempt timeout.
- requestTimeout(Duration) - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Sets the per-attempt timeout.
- requestTimeout(Duration) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Sets the per-attempt timeout (default 30 s).
- requires() - Method in record class codes.grow.packages.loki.testing.Scenario
-
Returns the value of the
requiresrecord component. - requires() - Method in record class codes.grow.packages.loki.testing.Scenario.Step
-
Returns the value of the
requiresrecord component. - reset() - Method in class codes.grow.packages.loki.testing.logging.InMemoryLogExporter
-
Forgets stored records and statistics (scripted outcomes stay).
- resolve(String, Map<String, List<String>>) - Method in class codes.grow.packages.loki.core.HttpTransport
-
Resolves a request path and query against the base URL.
- resource() - Method in class codes.grow.packages.loki.logging.BatchingLogClient
-
Resource attributes added to every record.
- resource() - Method in class codes.grow.packages.loki.logging.LogRecord
-
Resource attributes (
service.name,service.version, …). - resource() - Method in class codes.grow.packages.loki.LokiLogClientOptions
-
Returns the resource added to every record (
service.name, …). - resource(Map<String, ?>) - Method in class codes.grow.packages.loki.logging.BatchingLogClient.Builder
-
Sets the resource attributes (
service.name,service.version,deployment.environment,host.name, …). - resource(Map<String, ?>) - Method in class codes.grow.packages.loki.logging.LogRecord.Builder
-
Replaces all resource attributes.
- resource(Map<String, ?>) - Method in class codes.grow.packages.loki.LokiLogClientOptions.Builder
-
Sets the resource added to every record.
- ResponseInfo(String, String, int, long, int, Optional<String>) - Constructor for record class codes.grow.packages.loki.core.Hooks.ResponseInfo
-
Creates an instance of a
ResponseInforecord class. - resultType() - Method in record class codes.grow.packages.loki.QueryResult
-
Returns the value of the
resultTyperecord component. - ResultType - Enum Class in codes.grow.packages.loki
-
Result type of a Loki query.
- retries() - Method in record class codes.grow.packages.loki.logging.BatchStats
-
Returns the value of the
retriesrecord component. - retry() - Method in class codes.grow.packages.loki.core.TransportConfig
-
Returns the retry policy.
- retry() - Method in class codes.grow.packages.loki.LokiConfig
-
Returns the retry policy.
- retry(RetryPolicy) - Method in class codes.grow.packages.loki.core.TransportConfig.Builder
-
Sets the retry policy.
- retry(RetryPolicy) - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Sets the retry policy.
- retry(RetryPolicy) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Sets the retry policy (default
RetryPolicy.defaults()). - retryable() - Method in enum class codes.grow.packages.loki.core.ErrorCode
-
Returns whether errors with this code are retryable by default.
- retryable() - Method in exception class codes.grow.packages.loki.core.LokiException
-
Returns whether retrying the same call may succeed.
- retryAfter() - Method in exception class codes.grow.packages.loki.core.LokiException
-
Returns the wait the server asked for (
Retry-After). - retryAfterHeaders() - Method in class codes.grow.packages.loki.core.TransportConfig
-
Returns the vendor headers read as a retry hint when a 429 or 503 response has no
Retry-After(for exampleX-RateLimit-Reset), parsed withRetryPolicy.parseRateLimitReset(java.lang.String, java.time.Instant). - retryAfterHeaders(String...) - Method in class codes.grow.packages.loki.core.TransportConfig.Builder
-
Adds vendor headers read as a retry hint when a 429 or 503 response has no
Retry-After(for exampleX-RateLimit-Reset). - retryBackoff() - Method in class codes.grow.packages.loki.logging.BatchOptions
-
Base delay before a repeated export, doubled per attempt (default 200 ms).
- retryBackoff(Duration) - Method in class codes.grow.packages.loki.logging.BatchOptions.Builder
-
Sets the base retry delay (doubled per attempt).
- RetryPolicy - Class in codes.grow.packages.loki.core
-
Retry settings with full-jitter exponential backoff (SPEC section 2.3).
- RetryPolicy.Builder - Class in codes.grow.packages.loki.core
-
Builder for
RetryPolicy. - reveal() - Method in class codes.grow.packages.loki.core.Secret
-
Returns the credential as a string.
- revealChars() - Method in class codes.grow.packages.loki.core.Secret
-
Returns a copy of the credential characters.
- revision() - Method in record class codes.grow.packages.loki.BuildInfo
-
Returns the value of the
revisionrecord component. - run() - Method in class codes.grow.packages.loki.testing.ConformanceRunner
-
Runs every selected scenario.
- run(StepContext) - Method in interface codes.grow.packages.loki.testing.OpHandler
-
Runs the step.
- runScenario(Scenario) - Method in class codes.grow.packages.loki.testing.ConformanceRunner
-
Runs one scenario.
S
- sameValue(Secret) - Method in class codes.grow.packages.loki.core.Secret
-
Compares the values in constant time.
- Sample - Record Class in codes.grow.packages.loki
-
One metric sample.
- Sample(Instant, double) - Constructor for record class codes.grow.packages.loki.Sample
-
Creates an instance of a
Samplerecord class. - samples() - Method in record class codes.grow.packages.loki.MatrixSeries
-
Returns the value of the
samplesrecord component. - save() - Method in record class codes.grow.packages.loki.testing.Scenario.Step
-
Returns the value of the
saverecord component. - scalar() - Method in record class codes.grow.packages.loki.QueryResult
-
Returns the value of the
scalarrecord component. - SCALAR - Enum constant in enum class codes.grow.packages.loki.ResultType
-
A single value (
QueryResult.scalar()). - scenario() - Method in class codes.grow.packages.loki.testing.StepContext
-
Returns the running scenario.
- Scenario - Record Class in codes.grow.packages.loki.testing
-
A parsed conformance scenario (
conformance/scenarios/*.json). - Scenario(String, String, String, List<String>, List<Scenario.Step>, JsonNode) - Constructor for record class codes.grow.packages.loki.testing.Scenario
-
Creates a scenario; lists are copied.
- Scenario.Step - Record Class in codes.grow.packages.loki.testing
-
One step of a scenario.
- scenarioDir(Path) - Method in class codes.grow.packages.loki.testing.ConformanceRunner.Builder
-
Reads scenarios from this directory instead of searching for
conformance/scenarios. - ScenarioResult(String, String, ConformanceReport.Status, String, List<ConformanceReport.StepResult>, long) - Constructor for record class codes.grow.packages.loki.testing.ConformanceReport.ScenarioResult
-
Creates a result; the list is copied.
- scenarios() - Method in record class codes.grow.packages.loki.testing.ConformanceReport
-
Returns the value of the
scenariosrecord component. - scenarios() - Method in class codes.grow.packages.loki.testing.ConformanceRunner
-
Returns the scenarios of the categories that have a target, sorted by id.
- SdkInfo - Class in codes.grow.packages.loki.core
-
Package identity used in the
User-Agentheader. - search() - Method in record class codes.grow.packages.loki.logging.WaitForLogOptions
-
Returns the value of the
searchrecord component. - search(String) - Method in interface codes.grow.packages.loki.logging.LogQueryClient
-
Searches with default options (limit 100, newest first).
- search(String, SearchOptions) - Method in interface codes.grow.packages.loki.logging.LogQueryClient
-
Searches records matching a service query (full text or the service's query language).
- search(String, SearchOptions) - Method in class codes.grow.packages.loki.LokiLogQueryClient
-
Searches with
query_range. - search(String, SearchOptions) - Method in class codes.grow.packages.loki.testing.logging.InMemoryLogQueryClient
- searchAsync(String, SearchOptions) - Method in interface codes.grow.packages.loki.logging.LogQueryClient
-
Asynchronous
LogQueryClient.search(String, SearchOptions). - searchAsync(String, SearchOptions) - Method in class codes.grow.packages.loki.LokiLogQueryClient
- SearchOptions - Class in codes.grow.packages.loki.logging
-
Options of
LogQueryClient.search(java.lang.String, codes.grow.packages.loki.logging.SearchOptions): time range, limit (default 100), order, cursor. - SearchOptions.Builder - Class in codes.grow.packages.loki.logging
-
Builder for
SearchOptions. - Secret - Class in codes.grow.packages.loki.core
-
A credential held in a
char[]that never prints itself. - selector(Map<String, String>) - Static method in class codes.grow.packages.loki.LogQL
-
Starts a query from equality matchers (
{app="x", env="prod"}, names sorted). - send(TransportRequest) - Method in class codes.grow.packages.loki.core.HttpTransport
-
Executes a request with retries and returns a 2xx (or accepted) response.
- send(LogEntry) - Method in class codes.grow.packages.loki.logging.BatchingLogClient
- send(LogEntry) - Method in interface codes.grow.packages.loki.logging.LogClient
-
Enqueues one record or input.
- sendAsync(TransportRequest) - Method in class codes.grow.packages.loki.core.HttpTransport
-
Executes a request with retries asynchronously.
- sendBatch(Collection<? extends LogEntry>) - Method in class codes.grow.packages.loki.logging.BatchingLogClient
- sendBatch(Collection<? extends LogEntry>) - Method in interface codes.grow.packages.loki.logging.LogClient
-
Enqueues several records or inputs.
- sendJson(TransportRequest) - Method in class codes.grow.packages.loki.core.HttpTransport
-
Convenience: sends a request and decodes the JSON body.
- sent() - Method in record class codes.grow.packages.loki.logging.BatchStats
-
Returns the value of the
sentrecord component. - series(List<String>) - Method in class codes.grow.packages.loki.LokiClient
-
Series matching any of the selectors in the server's default window.
- series(List<String>, TimeRange) - Method in class codes.grow.packages.loki.LokiClient
-
Series matching any of the selectors:
GET /loki/api/v1/series(repeatedmatch[], OR). - SERIES - Enum constant in enum class codes.grow.packages.loki.VolumeOptions.AggregateBy
-
By series of the matched labels (Loki's default).
- seriesAsync(List<String>, TimeRange) - Method in class codes.grow.packages.loki.LokiClient
-
Asynchronous
LokiClient.series(List, TimeRange). - serverVersion() - Method in class codes.grow.packages.loki.LokiClient
-
Returns the server version (
buildInfo().version(), e.g. - serverVersion() - Method in interface codes.grow.packages.loki.testing.CoreTarget
-
Returns the server version.
- serverVersionAsync() - Method in class codes.grow.packages.loki.LokiClient
-
Asynchronous
LokiClient.serverVersion(). - serviceName(String) - Method in class codes.grow.packages.loki.testing.ConformanceRunner.Builder
-
Sets
${serviceName}(the tracing service name the factory configured). - setDefaultClient(LogClient) - Static method in class codes.grow.packages.loki.logging.GrowLog4j2Appender
-
Sets the client used by appenders created from configuration files.
- setLogClient(LogClient) - Method in class codes.grow.packages.loki.logging.GrowLogbackAppender
-
Sets the destination.
- severity() - Method in class codes.grow.packages.loki.logging.LogInput
-
Severity (default INFO).
- severity() - Method in class codes.grow.packages.loki.logging.LogRecord
-
Severity.
- severity(Severity) - Method in class codes.grow.packages.loki.logging.LogInput.Builder
-
Sets the severity.
- severity(Severity) - Method in class codes.grow.packages.loki.logging.LogRecord.Builder
-
Sets the severity; the severity text follows unless set explicitly.
- Severity - Enum Class in codes.grow.packages.loki.logging
-
Log severity with the OpenTelemetry severity numbers.
- severityOf(Level) - Static method in class codes.grow.packages.loki.logging.GrowLogbackAppender
-
Maps a Logback level to a severity.
- severityOf(Level) - Static method in class codes.grow.packages.loki.logging.GrowJulHandler
-
Maps a JUL level to a severity.
- severityOf(Level) - Static method in class codes.grow.packages.loki.logging.GrowLog4j2Appender
-
Maps a Log4j level to a severity.
- severityText() - Method in class codes.grow.packages.loki.logging.LogRecord
-
Severity text (
"TRACE"…"FATAL"or the vendor text). - severityText(String) - Method in class codes.grow.packages.loki.logging.LogRecord.Builder
-
Sets a vendor severity text (defaults to the severity name).
- shutdown() - Method in class codes.grow.packages.loki.logging.BatchProcessor
-
Drains the queue, shuts the exporter down and stops the worker, waiting at most the export timeout.
- shutdown() - Method in interface codes.grow.packages.loki.logging.LogExporter
-
Releases resources.
- shutdown() - Method in class codes.grow.packages.loki.LokiLogExporter
- shutdown() - Method in class codes.grow.packages.loki.LokiOtlpExporter
- shutdown() - Method in class codes.grow.packages.loki.testing.logging.InMemoryLogExporter
- shutdown(Duration) - Method in class codes.grow.packages.loki.logging.BatchProcessor
-
Drains the queue, shuts the exporter down and stops the worker.
- SHUTDOWN - Enum constant in enum class codes.grow.packages.loki.logging.DropReason
-
The processor was shut down (
"shutdown"). - shutdownAsync(Duration) - Method in class codes.grow.packages.loki.logging.BatchProcessor
-
Asynchronous
BatchProcessor.shutdown(Duration). - shutdownCount() - Method in class codes.grow.packages.loki.testing.logging.InMemoryLogExporter
-
Number of
InMemoryLogExporter.shutdown()calls. - since() - Method in class codes.grow.packages.loki.QueryRangeOptions
-
Returns the relative start used when no start is set.
- since(Duration) - Method in class codes.grow.packages.loki.QueryRangeOptions.Builder
-
Sets the relative start (
end - since) used when no start is set. - SKIPPED - Enum constant in enum class codes.grow.packages.loki.testing.ConformanceReport.Status
-
A required capability was not declared.
- SortOrder - Enum Class in codes.grow.packages.loki.logging
- source(String, String...) - Method in class codes.grow.packages.loki.core.EnvReader
-
Returns the name of the first variable that is set, for error messages.
- spanId() - Method in class codes.grow.packages.loki.logging.LogInput
-
Span id.
- spanId() - Method in class codes.grow.packages.loki.logging.LogRecord
-
Span id (16 lower-hex).
- spanId(String) - Method in class codes.grow.packages.loki.logging.LogInput.Builder
-
Sets the span id.
- spanId(String) - Method in class codes.grow.packages.loki.logging.LogRecord.Builder
-
Sets the span id (16 hex).
- split(Map<String, ?>, Map<String, String>, Map<String, String>) - Method in class codes.grow.packages.loki.CardinalityGuard
-
Splits attributes into index labels (allowlisted, non-empty scalar text) and structured metadata.
- sslContext() - Method in class codes.grow.packages.loki.core.TlsOptions
-
Builds the SSL context for these options.
- start() - Method in record class codes.grow.packages.loki.LabelsOptions
-
Returns the value of the
startrecord component. - start() - Method in class codes.grow.packages.loki.LiveTailOptions
-
Returns the replay start.
- start() - Method in class codes.grow.packages.loki.logging.GrowLogbackAppender
- start() - Method in class codes.grow.packages.loki.logging.SearchOptions
-
Range start (inclusive).
- start() - Method in record class codes.grow.packages.loki.logging.TailOptions
-
Returns the value of the
startrecord component. - start() - Method in class codes.grow.packages.loki.QueryRangeOptions
-
Returns the inclusive start.
- start() - Method in record class codes.grow.packages.loki.TimeRange
-
Returns the value of the
startrecord component. - start() - Method in class codes.grow.packages.loki.VolumeOptions
-
Returns the window start.
- start(Instant) - Method in class codes.grow.packages.loki.LiveTailOptions.Builder
-
Replays entries from this time before streaming live ones (default: now, live only).
- start(Instant) - Method in class codes.grow.packages.loki.logging.SearchOptions.Builder
-
Sets the range start.
- start(Instant) - Method in class codes.grow.packages.loki.QueryRangeOptions.Builder
-
Sets the inclusive start.
- start(Instant) - Method in class codes.grow.packages.loki.VolumeOptions.Builder
-
Sets the window start.
- stats() - Method in class codes.grow.packages.loki.logging.BatchingLogClient
- stats() - Method in class codes.grow.packages.loki.logging.BatchProcessor
-
Current counters.
- stats() - Method in interface codes.grow.packages.loki.logging.LogClient
-
Current counters.
- stats() - Method in record class codes.grow.packages.loki.QueryResult
-
Returns the value of the
statsrecord component. - status() - Method in record class codes.grow.packages.loki.core.HealthStatus
-
Returns the value of the
statusrecord component. - status() - Method in record class codes.grow.packages.loki.core.Hooks.ResponseInfo
-
Returns the value of the
statusrecord component. - status() - Method in class codes.grow.packages.loki.core.TransportResponse
-
Returns the HTTP status.
- status() - Method in record class codes.grow.packages.loki.testing.ConformanceReport.ScenarioResult
-
Returns the value of the
statusrecord component. - status() - Method in record class codes.grow.packages.loki.testing.ConformanceReport.StepResult
-
Returns the value of the
statusrecord component. - step() - Method in class codes.grow.packages.loki.QueryRangeOptions
-
Returns the metric query resolution.
- step() - Method in class codes.grow.packages.loki.testing.StepContext
-
Returns the current step.
- step() - Method in class codes.grow.packages.loki.VolumeOptions
-
Returns the resolution of
LokiClient.volumeRange(java.lang.String). - step(Duration) - Method in class codes.grow.packages.loki.QueryRangeOptions.Builder
-
Sets the metric query resolution.
- step(Duration) - Method in class codes.grow.packages.loki.VolumeOptions.Builder
-
Sets the resolution of
LokiClient.volumeRange(java.lang.String). - Step(String, JsonNode, JsonNode, String, List<String>) - Constructor for record class codes.grow.packages.loki.testing.Scenario.Step
-
Creates a step; the list is copied.
- StepContext - Class in codes.grow.packages.loki.testing
-
Everything an
OpHandlerneeds for one step. - StepResult(int, String, ConformanceReport.Status, String) - Constructor for record class codes.grow.packages.loki.testing.ConformanceReport.StepResult
-
Creates an instance of a
StepResultrecord class. - steps() - Method in record class codes.grow.packages.loki.testing.ConformanceReport.ScenarioResult
-
Returns the value of the
stepsrecord component. - steps() - Method in record class codes.grow.packages.loki.testing.Scenario
-
Returns the value of the
stepsrecord component. - stop() - Method in interface codes.grow.packages.loki.logging.TailHandle
-
Stops the subscription; idempotent.
- stop() - Method in class codes.grow.packages.loki.LokiTail
-
Closes the WebSocket with close code 1000.
- store(List<LogRecord>) - Method in class codes.grow.packages.loki.testing.logging.InMemoryLogExporter
-
Stores records as if exported (for outcomes that accept part of a batch).
- StreamEntry - Record Class in codes.grow.packages.loki
-
One log entry returned by a query or the tail stream.
- StreamEntry(long, Instant, String, Map<String, String>, Map<String, String>) - Constructor for record class codes.grow.packages.loki.StreamEntry
-
Copies the maps.
- StreamResult - Record Class in codes.grow.packages.loki
-
One stream of a
streamsresult. - StreamResult(Map<String, String>, List<StreamEntry>) - Constructor for record class codes.grow.packages.loki.StreamResult
-
Copies the fields.
- streams() - Method in record class codes.grow.packages.loki.IndexStats
-
Returns the value of the
streamsrecord component. - streams() - Method in record class codes.grow.packages.loki.QueryResult
-
Returns the value of the
streamsrecord component. - streams() - Method in record class codes.grow.packages.loki.TailFrame
-
Returns the value of the
streamsrecord component. - STREAMS - Enum constant in enum class codes.grow.packages.loki.ResultType
-
Log streams (
QueryResult.streams()). - string(String, String...) - Method in class codes.grow.packages.loki.core.EnvReader
-
Reads a string.
- stringify(Object) - Static method in class codes.grow.packages.loki.core.Json
-
Encodes a value as a JSON string.
- structuredMetadata() - Method in record class codes.grow.packages.loki.LokiEntry
-
Returns the value of the
structuredMetadatarecord component. - structuredMetadata() - Method in record class codes.grow.packages.loki.StreamEntry
-
Returns the value of the
structuredMetadatarecord component. - substitute(String) - Method in class codes.grow.packages.loki.testing.StepContext
-
Substitutes
${name}variables in a string. - substitute(String, Map<String, String>) - Static method in class codes.grow.packages.loki.testing.ConformanceRunner
-
Replaces
${name}placeholders; unknown names are kept as they are. - substituteNode(JsonNode, Map<String, String>) - Static method in class codes.grow.packages.loki.testing.ConformanceRunner
-
Substitutes placeholders in every string (and object key) of a JSON tree.
- success(int) - Static method in record class codes.grow.packages.loki.logging.ExportResult
-
All records accepted.
- summary() - Method in record class codes.grow.packages.loki.testing.ConformanceReport
-
Returns a multi-line summary listing every scenario.
- system() - Static method in class codes.grow.packages.loki.core.EnvReader
-
Creates a reader with
EnvReader.DEFAULT_PREFIXover the process environment.
T
- tail(String, Consumer<LogRecord>, TailOptions) - Method in interface codes.grow.packages.loki.logging.LogQueryClient
-
Streams new matching records to
onRecorduntil the handle is stopped. - tail(String, Consumer<LogRecord>, TailOptions) - Method in class codes.grow.packages.loki.LokiLogQueryClient
-
Live tail over the WebSocket API.
- tail(String, Consumer<LogRecord>, TailOptions) - Method in class codes.grow.packages.loki.testing.logging.InMemoryLogQueryClient
- tail(String, Consumer<TailFrame>) - Method in class codes.grow.packages.loki.LokiClient
-
Live tail with default options (Loki replays the last hour first).
- tail(String, Consumer<TailFrame>, LiveTailOptions) - Method in class codes.grow.packages.loki.LokiClient
-
Live tail over WebSocket (
/loki/api/v1/tail). - tailAsync(String, Consumer<TailFrame>, LiveTailOptions) - Method in class codes.grow.packages.loki.LokiClient
-
Asynchronous
LokiClient.tail(String, Consumer, LiveTailOptions). - TailFrame - Record Class in codes.grow.packages.loki
-
One frame of the tail WebSocket.
- TailFrame(List<StreamResult>, List<DroppedEntry>) - Constructor for record class codes.grow.packages.loki.TailFrame
-
Copies the lists.
- TailHandle - Interface in codes.grow.packages.loki.logging
- TailOptions - Record Class in codes.grow.packages.loki.logging
- TailOptions(Optional<Instant>, Duration, Consumer<Throwable>) - Constructor for record class codes.grow.packages.loki.logging.TailOptions
-
Fills defaults for
nullvalues. - target() - Method in class codes.grow.packages.loki.testing.StepContext
-
Returns the scenario target.
- target(Class<T>) - Method in class codes.grow.packages.loki.testing.StepContext
-
Returns the target cast to a type.
- target(String, TargetFactory) - Method in class codes.grow.packages.loki.testing.ConformanceRunner.Builder
-
Sets the target factory of a category; categories without a target do not run.
- TargetFactory - Interface in codes.grow.packages.loki.testing
-
Creates the object a scenario runs against (client, provider, log client, tracing handle).
- targetLabels() - Method in class codes.grow.packages.loki.VolumeOptions
-
Returns the labels to aggregate on.
- targetLabels(List<String>) - Method in class codes.grow.packages.loki.VolumeOptions.Builder
-
Sets the labels to aggregate on.
- TENANT_HEADER - Static variable in class codes.grow.packages.loki.LokiClient
-
Tenant header.
- tenantId() - Method in class codes.grow.packages.loki.LokiClient
-
Returns the tenant sent as
X-Scope-OrgID. - tenantId() - Method in class codes.grow.packages.loki.LokiConfig
-
Returns the tenant sent as
X-Scope-OrgID. - tenantId(String) - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Sets the tenant (
X-Scope-OrgID). - tenantId(String) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Sets the tenant sent as
X-Scope-OrgIDon every request and tail handshake. - tenantIdProblem(String, boolean) - Static method in class codes.grow.packages.loki.LokiConfig
-
Returns the problem with a tenant id (
X-Scope-OrgID), or empty when it is valid. - text() - Method in class codes.grow.packages.loki.core.TransportResponse
-
Returns the body decoded as UTF-8.
- text() - Method in enum class codes.grow.packages.loki.logging.Severity
-
Returns the canonical severity text (
"TRACE"…"FATAL"). - time() - Method in class codes.grow.packages.loki.QueryOptions
-
Returns the evaluation time.
- time(Instant) - Method in class codes.grow.packages.loki.QueryOptions.Builder
-
Sets the evaluation time.
- timeout() - Method in class codes.grow.packages.loki.core.TransportRequest
-
Returns the per-attempt timeout override.
- timeout() - Method in record class codes.grow.packages.loki.logging.ExportOptions
-
Returns the value of the
timeoutrecord component. - timeout() - Method in record class codes.grow.packages.loki.logging.WaitForLogOptions
-
Returns the value of the
timeoutrecord component. - timeout(Duration) - Method in class codes.grow.packages.loki.core.TransportRequest.Builder
-
Overrides the per-attempt timeout for this call.
- TIMEOUT - Enum constant in enum class codes.grow.packages.loki.core.ErrorCode
-
Connect, request or total deadline exceeded, HTTP 408 or 504.
- TimeoutException - Exception Class in codes.grow.packages.loki.core
-
A connect, request or total deadline was exceeded (or HTTP 408, 504).
- TimeoutException(String) - Constructor for exception class codes.grow.packages.loki.core.TimeoutException
-
Creates the exception.
- TimeoutException(String, Integer, String, boolean, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.TimeoutException
-
Creates the exception with response details and an explicit
retryableflag, for service subclasses whose errors differ from the default of the code (for example aCONFLICTthat may succeed when retried, or anUNAVAILABLEthat will not). - TimeoutException(String, Integer, String, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.TimeoutException
-
Creates the exception with response details.
- TimeoutException(String, Throwable) - Constructor for exception class codes.grow.packages.loki.core.TimeoutException
-
Creates the exception with a cause.
- TimeRange - Record Class in codes.grow.packages.loki
-
A time window for
LokiClient.series(java.util.List<java.lang.String>),LokiClient.indexStats(java.lang.String)and the label calls. - TimeRange(Optional<Instant>, Optional<Instant>) - Constructor for record class codes.grow.packages.loki.TimeRange
-
Normalizes
nullfields to empty. - timestamp() - Method in class codes.grow.packages.loki.logging.LogInput
-
Event time.
- timestamp() - Method in class codes.grow.packages.loki.logging.LogRecord
-
Event time.
- timestamp() - Method in record class codes.grow.packages.loki.LokiEntry
-
Returns the value of the
timestamprecord component. - timestamp() - Method in record class codes.grow.packages.loki.Sample
-
Returns the value of the
timestamprecord component. - timestamp() - Method in record class codes.grow.packages.loki.StreamEntry
-
Returns the value of the
timestamprecord component. - timestamp() - Method in record class codes.grow.packages.loki.VectorSample
-
Returns the value of the
timestamprecord component. - timestamp(Instant) - Method in class codes.grow.packages.loki.logging.LogInput.Builder
-
Sets the event time.
- timestamp(Instant) - Method in class codes.grow.packages.loki.logging.LogRecord.Builder
-
Sets the event time.
- timestampNanos() - Method in record class codes.grow.packages.loki.DroppedEntry
-
Returns the value of the
timestampNanosrecord component. - timestampNanos() - Method in record class codes.grow.packages.loki.StreamEntry
-
Returns the value of the
timestampNanosrecord component. - tls() - Method in class codes.grow.packages.loki.core.TransportConfig
-
Returns the TLS options.
- tls() - Method in class codes.grow.packages.loki.LokiConfig
-
Returns the TLS options.
- tls(TlsOptions) - Method in class codes.grow.packages.loki.core.TransportConfig.Builder
-
Sets the TLS options.
- tls(TlsOptions) - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Sets the TLS options.
- tls(TlsOptions) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Sets the TLS options; environment TLS variables are then ignored.
- TlsOptions - Class in codes.grow.packages.loki.core
-
TLS settings: custom CA, client certificate (mutual TLS) and the test-only
insecureSkipVerify. - TlsOptions.Builder - Class in codes.grow.packages.loki.core
-
Builder for
TlsOptions. - toAttrValue(JsonNode) - Static method in class codes.grow.packages.loki.logging.LogRecordJson
-
Converts a JSON tree into attribute values (
AttrValues). - toBuilder() - Method in class codes.grow.packages.loki.core.RetryPolicy
-
Returns a builder initialised from this policy.
- toBuilder() - Method in class codes.grow.packages.loki.core.TlsOptions
-
Returns a builder initialised from these options.
- toBuilder() - Method in class codes.grow.packages.loki.logging.BatchOptions
-
Returns a builder initialised with these options.
- toBuilder() - Method in class codes.grow.packages.loki.logging.LogRecord
-
Returns a builder initialised with this record's values.
- toBuilder() - Method in class codes.grow.packages.loki.logging.SearchOptions
-
Returns a builder with these values.
- toBuilder() - Method in class codes.grow.packages.loki.LokiConfig
-
Starts a builder holding every field of this configuration.
- toJson(LogRecord) - Static method in class codes.grow.packages.loki.logging.LogRecordJson
-
Serialises a record to compact JSON.
- toLogQL(String) - Static method in class codes.grow.packages.loki.LokiLogQueryClient
-
Turns a search text into LogQL: text starting with
{is LogQL as is; anything else is a case-sensitive substring search over every stream ({service_name=~".+"} |= "<text>"). - toLogRecord(Map<String, String>, StreamEntry) - Static method in class codes.grow.packages.loki.LokiLogQueryClient
-
Converts one Loki entry to a normalized
LogRecord. - toMap(LogRecord) - Static method in class codes.grow.packages.loki.logging.LogRecordJson
-
Returns the wire form as an ordered map of plain JSON values.
- toString() - Method in record class codes.grow.packages.loki.BuildInfo
-
Returns a string representation of this record class.
- toString() - Method in class codes.grow.packages.loki.CardinalityGuard
- toString() - Method in record class codes.grow.packages.loki.core.HealthStatus
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.core.Hooks.ErrorInfo
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.core.Hooks.RequestInfo
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.core.Hooks.ResponseInfo
-
Returns a string representation of this record class.
- toString() - Method in class codes.grow.packages.loki.core.RetryPolicy
- toString() - Method in class codes.grow.packages.loki.core.Secret
-
Always "[REDACTED]".
- toString() - Method in class codes.grow.packages.loki.core.TlsOptions
- toString() - Method in class codes.grow.packages.loki.core.TransportResponse
- toString() - Method in record class codes.grow.packages.loki.DroppedEntry
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.IndexStats
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.LabelsOptions
-
Returns a string representation of this record class.
- toString() - Method in class codes.grow.packages.loki.logging.BatchOptions
- toString() - Method in record class codes.grow.packages.loki.logging.BatchStats
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.logging.ExportOptions
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.logging.ExportResult
-
Returns a string representation of this record class.
- toString() - Method in class codes.grow.packages.loki.logging.LogInput
- toString() - Method in class codes.grow.packages.loki.logging.LogRecord
-
Returns the normalized JSON form (see
LogRecordJson). - toString() - Method in record class codes.grow.packages.loki.logging.LogSearchResult
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.logging.TailOptions
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.logging.WaitForLogOptions
-
Returns a string representation of this record class.
- toString() - Method in class codes.grow.packages.loki.LogQL
-
Same as
LogQL.build(). - toString() - Method in class codes.grow.packages.loki.LokiClient
- toString() - Method in class codes.grow.packages.loki.LokiConfig
- toString() - Method in record class codes.grow.packages.loki.LokiEntry
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.LokiStream
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.MatrixSeries
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.PushOptions
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.QueryResult
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.Sample
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.StreamEntry
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.StreamResult
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.TailFrame
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.testing.ConformanceReport.ScenarioResult
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.testing.ConformanceReport.StepResult
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.testing.ConformanceReport
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.testing.logging.LoggingTarget
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.testing.Scenario.Step
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.testing.Scenario
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.TimeRange
-
Returns a string representation of this record class.
- toString() - Method in record class codes.grow.packages.loki.VectorSample
-
Returns a string representation of this record class.
- total() - Method in record class codes.grow.packages.loki.logging.LogSearchResult
-
Returns the value of the
totalrecord component. - totalTimeout() - Method in class codes.grow.packages.loki.core.TransportConfig
-
Returns the budget of a whole call including retries and backoff.
- totalTimeout() - Method in class codes.grow.packages.loki.LokiConfig
-
Returns the total timeout per call including retries.
- totalTimeout(Duration) - Method in class codes.grow.packages.loki.core.TransportConfig.Builder
-
Sets the total budget per call.
- totalTimeout(Duration) - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Sets the total timeout.
- totalTimeout(Duration) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Sets the total timeout per call including retries (default 120 s).
- toTransportConfig() - Method in class codes.grow.packages.loki.LokiConfig
-
Translates the common fields into transport settings.
- trace(String) - Method in class codes.grow.packages.loki.logging.Logger
-
Logs at TRACE.
- trace(String, Map<String, ?>) - Method in class codes.grow.packages.loki.logging.Logger
-
Logs at TRACE.
- TRACE - Enum constant in enum class codes.grow.packages.loki.logging.Severity
-
OTel severity 1.
- traceFlags() - Method in class codes.grow.packages.loki.logging.LogRecord
-
W3C trace flags.
- traceFlags(Integer) - Method in class codes.grow.packages.loki.logging.LogRecord.Builder
-
Sets the W3C trace flags (0–255).
- traceId() - Method in class codes.grow.packages.loki.logging.LogInput
-
Trace id.
- traceId() - Method in class codes.grow.packages.loki.logging.LogRecord
-
Trace id (32 lower-hex).
- traceId(String) - Method in class codes.grow.packages.loki.logging.LogInput.Builder
-
Sets the trace id.
- traceId(String) - Method in class codes.grow.packages.loki.logging.LogRecord.Builder
-
Sets the trace id (32 hex; upper case is accepted, 16 hex is left-padded).
- transport() - Method in class codes.grow.packages.loki.LokiClient
-
Returns the HTTP transport, for service modules built on this client.
- TransportConfig - Class in codes.grow.packages.loki.core
-
Settings of one
HttpTransport. - TransportConfig.Builder - Class in codes.grow.packages.loki.core
-
Builder for
TransportConfig. - TransportRequest - Class in codes.grow.packages.loki.core
-
One logical HTTP call executed by
HttpTransport(with retries). - TransportRequest.Builder - Class in codes.grow.packages.loki.core
-
Builder for
TransportRequest. - TransportResponse - Class in codes.grow.packages.loki.core
-
A response returned by
HttpTransport(2xx or an accepted status). - TransportResponse(int, Map<String, List<String>>, byte[], int, Duration, String) - Constructor for class codes.grow.packages.loki.core.TransportResponse
-
Creates a response (used by the transport and by tests).
- tree() - Method in class codes.grow.packages.loki.testing.OpResult
-
Returns the tree view.
- tree(byte[]) - Static method in class codes.grow.packages.loki.core.Json
-
Parses JSON bytes into a tree.
- truncate(String, int) - Static method in class codes.grow.packages.loki.core.Redaction
-
Truncates text to
maxcharacters, appending an ellipsis when cut.
U
- UNAVAILABLE - Enum constant in enum class codes.grow.packages.loki.core.ErrorCode
-
Network error or HTTP 500, 502, 503.
- UnavailableException - Exception Class in codes.grow.packages.loki.core
-
Network error or HTTP 500, 502, 503.
- UnavailableException(String) - Constructor for exception class codes.grow.packages.loki.core.UnavailableException
-
Creates the exception.
- UnavailableException(String, Integer, String, boolean, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.UnavailableException
-
Creates the exception with response details and an explicit
retryableflag, for service subclasses whose errors differ from the default of the code (for example aCONFLICTthat may succeed when retried, or anUNAVAILABLEthat will not). - UnavailableException(String, Integer, String, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.UnavailableException
-
Creates the exception with response details.
- UnavailableException(String, Throwable) - Constructor for exception class codes.grow.packages.loki.core.UnavailableException
-
Creates the exception with a cause.
- unpack() - Method in class codes.grow.packages.loki.LogQL
-
Parser stage
| unpack. - unreachable(String) - Static method in record class codes.grow.packages.loki.core.HealthStatus
-
The status for a service that could not be reached.
- UNSUPPORTED - Enum constant in enum class codes.grow.packages.loki.core.ErrorCode
-
A capability the service or deployment does not offer (HTTP 501).
- UnsupportedException - Exception Class in codes.grow.packages.loki.core
-
The service or deployment does not offer this capability (HTTP 501).
- UnsupportedException(String) - Constructor for exception class codes.grow.packages.loki.core.UnsupportedException
-
Creates the exception.
- UnsupportedException(String, Integer, String, boolean, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.UnsupportedException
-
Creates the exception with response details and an explicit
retryableflag, for service subclasses whose errors differ from the default of the code (for example aCONFLICTthat may succeed when retried, or anUNAVAILABLEthat will not). - UnsupportedException(String, Integer, String, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.UnsupportedException
-
Creates the exception with response details.
- UnsupportedException(String, Throwable) - Constructor for exception class codes.grow.packages.loki.core.UnsupportedException
-
Creates the exception with a cause.
- until(String, Duration, Duration, Callable<Optional<T>>) - Static method in class codes.grow.packages.loki.core.Poll
-
Calls
attempteveryintervaluntil it returns a value ortimeoutpasses. - untilAsync(String, Duration, Duration, Supplier<CompletableFuture<Optional<T>>>) - Static method in class codes.grow.packages.loki.core.Poll
-
Asynchronous variant of
Poll.until(java.lang.String, java.time.Duration, java.time.Duration, java.util.concurrent.Callable<java.util.Optional<T>>): no thread blocks between attempts. - url() - Method in record class codes.grow.packages.loki.core.Hooks.ErrorInfo
-
Returns the value of the
urlrecord component. - url() - Method in record class codes.grow.packages.loki.core.Hooks.RequestInfo
-
Returns the value of the
urlrecord component. - url() - Method in record class codes.grow.packages.loki.core.Hooks.ResponseInfo
-
Returns the value of the
urlrecord component. - url() - Method in class codes.grow.packages.loki.LokiConfig
-
Returns the endpoint base URL.
- url(String) - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Sets the endpoint base URL.
- url(String) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Sets the endpoint base URL (default
http://127.0.0.1:3100). - userAgent() - Static method in class codes.grow.packages.loki.core.SdkInfo
-
Returns the standard user agent:
grow-codes-<key>/<version> (java). - userAgent() - Method in class codes.grow.packages.loki.core.TransportConfig
-
Returns the full
User-Agentheader value. - userAgentSuffix() - Method in class codes.grow.packages.loki.core.TransportConfig
-
Returns the user agent suffix.
- userAgentSuffix() - Method in class codes.grow.packages.loki.LokiConfig
-
Returns the user agent suffix.
- userAgentSuffix(String) - Method in class codes.grow.packages.loki.core.TransportConfig.Builder
-
Sets the text appended to the standard user agent.
- userAgentSuffix(String) - Method in class codes.grow.packages.loki.LokiClient.Builder
-
Sets the user agent suffix.
- userAgentSuffix(String) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Sets the text appended to the
User-Agent. - username() - Method in class codes.grow.packages.loki.LokiConfig
-
Returns the Basic-auth user.
- username(String) - Method in class codes.grow.packages.loki.LokiConfig.Builder
-
Sets the Basic-auth user (gateways, Grafana Cloud instance id).
V
- validate() - Method in class codes.grow.packages.loki.core.TlsOptions
-
Checks that certificate and key come together.
- validate() - Method in class codes.grow.packages.loki.LokiConfig
-
Checks URL scheme, positive timeouts, TLS pairs, the tenant id and the credential rules.
- validateLabel(String, String) - Static method in class codes.grow.packages.loki.Labels
-
Checks one index label: valid, non-reserved name and a non-empty value.
- validateLabelName(String) - Static method in class codes.grow.packages.loki.Labels
-
Checks a label name.
- VALIDATION - Enum constant in enum class codes.grow.packages.loki.core.ErrorCode
-
HTTP 400, 413, 422, other 4xx or bad input caught client side.
- ValidationException - Exception Class in codes.grow.packages.loki.core
-
The request or a value is invalid (HTTP 400, 413, 422, other 4xx).
- ValidationException(String) - Constructor for exception class codes.grow.packages.loki.core.ValidationException
-
Creates the exception.
- ValidationException(String, Integer, String, boolean, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.ValidationException
-
Creates the exception with response details and an explicit
retryableflag, for service subclasses whose errors differ from the default of the code (for example aCONFLICTthat may succeed when retried, or anUNAVAILABLEthat will not). - ValidationException(String, Integer, String, Duration, Throwable) - Constructor for exception class codes.grow.packages.loki.core.ValidationException
-
Creates the exception with response details.
- ValidationException(String, Throwable) - Constructor for exception class codes.grow.packages.loki.core.ValidationException
-
Creates the exception with a cause.
- value() - Method in record class codes.grow.packages.loki.Sample
-
Returns the value of the
valuerecord component. - value() - Method in class codes.grow.packages.loki.testing.OpResult
-
Returns the wrapped value.
- value() - Method in record class codes.grow.packages.loki.VectorSample
-
Returns the value of the
valuerecord component. - valueOf(String) - Static method in enum class codes.grow.packages.loki.core.ErrorCode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class codes.grow.packages.loki.Direction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class codes.grow.packages.loki.logging.DropPolicy
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class codes.grow.packages.loki.logging.DropReason
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class codes.grow.packages.loki.logging.Severity
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class codes.grow.packages.loki.logging.SortOrder
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class codes.grow.packages.loki.LogProtocol
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class codes.grow.packages.loki.PushFormat
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class codes.grow.packages.loki.ResultType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class codes.grow.packages.loki.testing.ConformanceReport.Status
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class codes.grow.packages.loki.VolumeOptions.AggregateBy
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class codes.grow.packages.loki.core.ErrorCode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class codes.grow.packages.loki.Direction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class codes.grow.packages.loki.logging.DropPolicy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class codes.grow.packages.loki.logging.DropReason
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class codes.grow.packages.loki.logging.Severity
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class codes.grow.packages.loki.logging.SortOrder
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class codes.grow.packages.loki.LogProtocol
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class codes.grow.packages.loki.PushFormat
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class codes.grow.packages.loki.ResultType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class codes.grow.packages.loki.testing.ConformanceReport.Status
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class codes.grow.packages.loki.VolumeOptions.AggregateBy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- variable(String) - Method in class codes.grow.packages.loki.testing.StepContext
-
Returns a variable (
run,prefix,serviceNameor a saved name). - variable(String, String) - Method in class codes.grow.packages.loki.testing.ConformanceRunner.Builder
-
Sets an extra variable, e.g.
- vector() - Method in record class codes.grow.packages.loki.QueryResult
-
Returns the value of the
vectorrecord component. - VECTOR - Enum constant in enum class codes.grow.packages.loki.ResultType
-
One sample per series (
QueryResult.vector()). - VectorSample - Record Class in codes.grow.packages.loki
-
One series of a
vectorresult. - VectorSample(Map<String, String>, Instant, double) - Constructor for record class codes.grow.packages.loki.VectorSample
-
Copies the labels.
- version() - Method in record class codes.grow.packages.loki.BuildInfo
-
Returns the value of the
versionrecord component. - VERSION - Static variable in class codes.grow.packages.loki.core.SdkInfo
-
Package version (from the Maven build).
- view(Object) - Static method in class codes.grow.packages.loki.testing.Expectations
-
Returns the JSON view of a value used by
equals,contains,typeandsorted. - volume(String) - Method in class codes.grow.packages.loki.LokiClient
-
Ingested bytes per series in the server's default window.
- volume(String, VolumeOptions) - Method in class codes.grow.packages.loki.LokiClient
-
Ingested bytes per series or label:
GET /loki/api/v1/index/volume(vector result). - volumeAsync(String, VolumeOptions) - Method in class codes.grow.packages.loki.LokiClient
-
Asynchronous
LokiClient.volume(String, VolumeOptions). - VolumeOptions - Class in codes.grow.packages.loki
- VolumeOptions.AggregateBy - Enum Class in codes.grow.packages.loki
-
How volumes are grouped.
- VolumeOptions.Builder - Class in codes.grow.packages.loki
-
Builder of
VolumeOptions. - volumeRange(String) - Method in class codes.grow.packages.loki.LokiClient
-
Volume over time in the server's default window.
- volumeRange(String, VolumeOptions) - Method in class codes.grow.packages.loki.LokiClient
-
Volume over time:
GET /loki/api/v1/index/volume_range. - volumeRangeAsync(String, VolumeOptions) - Method in class codes.grow.packages.loki.LokiClient
-
Asynchronous
LokiClient.volumeRange(String, VolumeOptions).
W
- waitForLog(String) - Method in interface codes.grow.packages.loki.logging.LogQueryClient
-
LogQueryClient.waitForLog(String, WaitForLogOptions)with defaults. - waitForLog(String, WaitForLogOptions) - Method in interface codes.grow.packages.loki.logging.LogQueryClient
-
Polls
LogQueryClient.search(java.lang.String, codes.grow.packages.loki.logging.SearchOptions)until a record matches the query and the predicate. - waitForLogAsync(String, WaitForLogOptions) - Method in interface codes.grow.packages.loki.logging.LogQueryClient
-
Asynchronous
LogQueryClient.waitForLog(String, WaitForLogOptions). - WaitForLogOptions - Record Class in codes.grow.packages.loki.logging
- WaitForLogOptions(Duration, Duration, Predicate<LogRecord>, SearchOptions) - Constructor for record class codes.grow.packages.loki.logging.WaitForLogOptions
-
Fills defaults for
nullvalues. - warn(String) - Method in interface codes.grow.packages.loki.core.Logger
-
Logs at warn level without fields.
- warn(String) - Method in class codes.grow.packages.loki.logging.Logger
-
Logs at WARN.
- warn(String, Map<String, ?>) - Method in class codes.grow.packages.loki.logging.Logger
-
Logs at WARN.
- warn(String, Map<String, Object>) - Method in interface codes.grow.packages.loki.core.Logger
-
Logs at warn level.
- WARN - Enum constant in enum class codes.grow.packages.loki.logging.Severity
-
OTel severity 13.
- where(String, String, double) - Method in class codes.grow.packages.loki.LogQL
-
Numeric label filter with
==,!=,>,>=,<,<=. - where(String, String, String) - Method in class codes.grow.packages.loki.LogQL
-
Label filter on an extracted label or structured-metadata key, comparing strings with
=,!=,=~,!~. - willRetry() - Method in record class codes.grow.packages.loki.core.Hooks.ErrorInfo
-
Returns the value of the
willRetryrecord component. - wireValue() - Method in enum class codes.grow.packages.loki.core.ErrorCode
-
Returns the wire value used in conformance scenarios and JSON.
- wireValue() - Method in enum class codes.grow.packages.loki.Direction
-
Returns the query parameter value (
forward/backward). - wireValue() - Method in enum class codes.grow.packages.loki.logging.DropPolicy
-
Wire value.
- wireValue() - Method in enum class codes.grow.packages.loki.logging.DropReason
-
Wire value.
- wireValue() - Method in enum class codes.grow.packages.loki.logging.SortOrder
-
Wire value.
- wireValue() - Method in enum class codes.grow.packages.loki.VolumeOptions.AggregateBy
-
Returns the query parameter value.
- with(ConformanceReport.Status) - Method in record class codes.grow.packages.loki.testing.ConformanceReport
-
Returns the scenarios with a status.
- withCount(int) - Method in class codes.grow.packages.loki.testing.OpResult
-
Returns a copy with an explicit count (e.g. the number of spans of a trace).
- withGzip(boolean) - Method in record class codes.grow.packages.loki.PushOptions
-
A copy with gzip enabled or disabled.
- withMinSeverity(Severity) - Method in class codes.grow.packages.loki.logging.Logger
-
Returns a copy with another minimum severity.
- withOnError(Consumer<Throwable>) - Method in record class codes.grow.packages.loki.logging.TailOptions
-
Copy with an error callback.
- withPredicate(Predicate<LogRecord>) - Method in record class codes.grow.packages.loki.logging.WaitForLogOptions
-
Copy with a predicate.
- withQuery(String) - Method in record class codes.grow.packages.loki.LabelsOptions
-
A copy scoped to the streams matching a selector.
- withTenant(String) - Method in class codes.grow.packages.loki.LokiClient
-
Returns a client for another tenant: it shares this client's connections and sends
X-Scope-OrgID: idon every request and on the tail handshake. - withTree(Map<String, List<String>>) - Method in class codes.grow.packages.loki.testing.OpResult
-
Returns a copy with a parent-name to child-names view (span trees).
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form