package pulse.config.common.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Offload queue that uses AWS SQS

Used in: RetryOffloadQueue

• string queue_name = 1

  The queue name to lookup and use.

Specify a bearer token. This is currently specified in the x-bitdrift-api-key header.

Used in: HttpFileSourceConfig, outflow.v1.HttpRemoteWriteAuthConfig

• oneof token_type

  • string token = 1

    The token specified inline.

  • string file_path = 2

    The file to load the token from.

Wraps data that can be specified inline, via the environment, or within a file.

• oneof data_type

  • EnvOrInline env_or_inline = 1

    The data will be pulled from the environment or inline.

  • string file_path = 2

    The data will be pulled from the specified file path.

Wraps data that can be specified inline or come via environment.

Used in: bootstrap.v1.KubernetesBootstrapConfig, bootstrap.v1.MetaStats, EnvInlineOrFile, inflow.v1.KubernetesPrometheusConfig.HttpServiceDiscovery, outflow.v1.RequestHeader

• oneof data_type

  • string env_var = 1

    The data will be pulled from this environment variable.

  • string inline = 2

    The data is specified by this value.

Configuration for an individual file source.

Used in: processor.v1.DropProcessorConfig, processor.v1.ElisionConfig.BlocklistConfig

• oneof file_source_type

  • LocalFileSourceConfig local = 1

    A local file source.

  • HttpFileSourceConfig http = 2

    A remote HTTP based file source.

HTTP file source configuration.

Used in: FileSourceConfig

• string url = 1

  The URL to fetch. The first fetch does not supply an if-none-match header and expects a 200 response with the file contents as well as an etag. Future requests will return the etag in the if-none-match header and expect a 304 response if the contents have not changed.

• optional google.protobuf.Duration interval = 2

  How often the file will be checked for changes. Defaults to 60s.

• optional BearerTokenConfig auth_bearer_token = 3

  Whether an authentication token will be provided in the x-bitdrift-api-key header.

• optional google.protobuf.Duration request_timeout = 4

  Fetch request timeout. If not set defaults to 15s.

• optional string cache_path = 5

  If configured, the fetched file will be cached to this path. Furthermore, on startup, if the remote server cannot be contacted, the file cache contents will be used as long as the integrity is verified.

Local file source configuration.

Used in: FileSourceConfig

• optional RuntimeConfig runtime_config = 1

  The path to the file. This file will be watched for changes and reloaded as needed. Atomic file swaps should be used to make sure file reads are consistent.

Offload queue for local integration testing only.

Used in: RetryOffloadQueue

(message has no fields)

Configuration for the retry offload queue: the ability to offload metrics to durable storage to be retried later.

Used in: RetryPolicy

• optional uint32 max_send_attempts = 1

  The maximum number of send attempts. If not set, retries are unbounded and only governed by the window defined below.

• optional google.protobuf.Duration backoff = 2

  The base backoff time for each request. The backoff is multiplied by the current send attempt. Defaults to 20s.

• optional google.protobuf.Duration window = 3

  The total duration each request will be attempted, across all retries. Defaults to 20m.

• oneof queue_type

  • AwsSqsRetryOffloadQueue aws_sqs = 4

    Configure AWS SQS for offloading.

  • LoopbackForTestOffloadQueue loopback_for_test = 5

    Configure local loopback. This is for integration testing.

Retry policy configuration.

Used in: outflow.v1.OtlpClientConfig, outflow.v1.PromRemoteWriteClientConfig, processor.v1.InternodeConfig.RequestPolicy

• optional double budget = 1

  Controls the number of retries that are allowed concurrently. The "budget" is defined as a % where the number of retries is a % of the number of active requests. The default if not specified is 0.1 (10%). Valid values are > 0.0 and <= 1.0. For example, with a budget of 10%, if there are 10 active requests, 1 retry will be allowed. If there are 20, 2 will be allowed, and so on.

• optional uint32 max_retries = 2

  Sets the maximum number of retry attempts. Default is unlimited and governed only by the request timeout and expontential backoff policy

• optional RetryOffloadQueue offload_queue = 3

  Configuration for the retry offload queue.

A file that is watched on the filesystem, typically within a K8s config map. Note that `dir` watches for *renames* in this directory only without recursion. This limits watched changes and is required for Kubernetes `ConfigMap` deployments. A Kubernetes `ConfigMap` deployment might work as follows: 1. Mount `ConfigMap` to `/config_map/foo`. 2. Set `dir` to `/config_map/foo`. 3. Set `file` to `/config_map/foo/foo.yaml`. Internally Kubernetes will create the following structure: 1. `/config_map/foo/real_data/foo.yaml`. 2. `/config_map/foo/..data` -> `/config_map/foo/real_data`. 3. `/config_map/foo/foo.yaml` -> `/config_map/foo/..data/foo.yaml`. Further data swaps will only rename the `..data` symlink.

Used in: bootstrap.v1.Config, bootstrap.v1.MergedConfig, LocalFileSourceConfig

• string dir = 1

  Directory to watch for updates. See above. This needs to be the directory that owns whatever symlink is being atomically swapped.

• string file = 2

  File to watch for updates. This is the actual full file path.

Wire protocol type.

Used in: inflow.v1.MetricGeneratorConfig, inflow.v1.TcpServerConfig, inflow.v1.UdpServerConfig, inflow.v1.UnixServerConfig, outflow.v1.CommonWireClientConfig

• oneof protocol_type

  • WireProtocol.Carbon carbon = 1

  • WireProtocol.StatsD statsd = 2

Used in: WireProtocol

(message has no fields)

Used in: WireProtocol

• bool lyft_tags = 1

  Whether to attempt parsing lyft/statsrelay style tags of the form: foo.__bar=baz:3.0|c This will produce the ("bar", "baz") tag. This is currently only supported for inflow. It will be ignored on outflow.

• bool sanitize_tags = 2

  Sanitize tag names and values by replacing ':', '.', and '=' with '_'. This matches statsrelay behavior.