Skip to content

Output

Where collected samples are sent.

Schema: output.json. Explanations and examples: configuration model.

Field Type Required Description
apiVersion tapyr/v1alpha1 yes Version of the configuration format.
kind Output yes Kind of the document.
metadata ObjectMeta yes Name and description of the document.
spec OutputSpec yes Specification of the document.

ObjectMeta

ObjectMeta identifies a document.

Field Type Required Description
description string Description is free text for humans.
name Name yes Name of the document, unique per kind.

OutputSpec

OutputSpec is the specification of an Output.

Field Type Required Description
externalLabels map of string to string externalLabels added to every sample sent through this output. Keys match ^[a-zA-Z_][a-zA-Z0-9_]*$.
otlp OTLPOutput otlp pushes OTLP metrics (type otlp).
prometheus PrometheusOutput Prometheus pull exposition on /metrics (type prometheus, at most one).
queue Queue Queue of a push output (not allowed for prometheus).
remoteWrite RemoteWriteOutput remoteWrite pushes with Prometheus remote write 1.0 (type remote_write).
type string yes Type of output. One of prometheus, remote_write, otlp.
  • When type is remote_write: remoteWrite is required.
  • When type is otlp: otlp is required.

Name

Type: string. Pattern ^[a-z0-9]([-a-z0-9]{0,61}[a-z0-9])?$.

OTLPOutput

OTLPOutput configures OTLP metrics export.

Field Type Required Description
endpoint string yes Endpoint of the OTLP receiver. Format uri.
headers map of string to StringOrSecret Headers added to every request; values are literals or secrets.
protocol string Protocol: http/protobuf or grpc. Default http/protobuf. One of http/protobuf, grpc.
resourceAttributes map of string to string resourceAttributes added to the OTLP resource.
timeout Duration Timeout of a send request. Default 10s.

PrometheusOutput

PrometheusOutput configures the pull exposition.

Field Type Required Description
exposeTimestamps boolean exposeTimestamps adds sample timestamps to the exposition. Off by default, as recommended by Prometheus.

Queue

Queue is the bounded in-memory queue of a push output.

Field Type Required Description
capacity integer Capacity in samples; the oldest samples are dropped (with accounting) when full. Default 50000. Minimum 1.
flushInterval Duration flushInterval sends a partial batch after this delay. Default 5s.
maxBatch integer maxBatch is the maximum number of samples per request. Default 5000. Minimum 1.

RemoteWriteOutput

RemoteWriteOutput configures Prometheus remote write 1.0.

Field Type Required Description
basicAuth BasicAuthSecrets basicAuth credentials.
headers map of string to StringOrSecret Headers added to every request; values are literals or secrets.
timeout Duration Timeout of a send request. Default 10s.
url string yes url of the remote write endpoint. Format uri.

StringOrSecret

A literal string, {env: NAME} or {file: /path}.

Either a string, or an object:

Field Type Required Description
env string Name of an environment variable holding the secret. Minimum length 1.
file string Path of a file holding the secret, relative to the declaring file. Minimum length 1.
  • Exactly one field is set.

Duration

Type: string. Pattern ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$. Examples 30s, 5m, 1h30m.

BasicAuthSecrets

BasicAuthSecrets are HTTP basic credentials read from secrets.

Field Type Required Description
password SecretRef yes Password secret.
username SecretRef yes Username secret.

SecretRef

A secret read from an environment variable ({env: NAME}) or a file ({file: /path}).

Field Type Required Description
env string Name of an environment variable holding the secret. Minimum length 1.
file string Path of a file holding the secret, relative to the declaring file. Minimum length 1.
  • Exactly one field is set.