package protocol.observability

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: MetricsConfig, SpanCreateRequest, TracingConfig

• oneof value

  • string value_string = 2

  • int64 value_long = 3

  • bool value_boolean = 4

Used in: shared.ClusterConfig

• optional TracingConfig tracing = 1

  If not sent, the performer should not enable tracing output.

• bool use_noop_tracer = 2

  If set, the performer should set a NoopTracer as the requestTracer. The driver will not send `tracing` config if this is set.

• optional MetricsConfig metrics = 3

  If not sent, the performer should not enable metrics output.

• optional ThresholdLoggingTracerConfig threshold_logging_tracer = 4

• optional LoggingMeterConfig logging_meter = 5

• optional OrphanResponseConfig orphan_response = 6

• repeated SemanticConvention observability_semantic_convention_opt_in = 7

  If sent, the performer should set the corresponding ClusterOptions field. Will only be sent iff the performer declares support for SDK_STABLE_OTEL_SEMANTIC_CONVENTIONS, but not SDK_STABLE_OTEL_SEMANTIC_CONVENTIONS_EMITTED_BY_DEFAULT

Used in: Config

• optional int32 emit_interval_millis = 1

• optional bool enabled = 2

Configures the performer to output OpenTelemetry metrics data.

Used in: Config

• string endpoint_hostname = 1

  Where to send the OTLP metrics traffic.

• int32 export_every_millis = 2

  How frequently to export data, as a best effort. This lets us tune for quick observability during integration tests, and reducing traffic and overhead in performance tests.

• map<string, Attribute> resources = 3

  Attributes to provide to the MeterProvider. While this is under-documented in OpenTelemetry, the intent here is to provide fields such as "service.name".

Used in: Config

• optional int32 emit_interval_millis = 1

• optional int32 sample_size = 2

• optional bool enabled = 3

Used in: Config

• DATABASE = 0

• DATABASE_DUP = 1

The performer creates and starts a new RequestSpan, via the RequestTracer associated with a particular previously-created Cluster. The performer needs to hold onto this in a global Map<String, RequestSpan>, with the key being the provided `id`.

Used as request type in: PerformerService.spanCreate

• string cluster_connection_id = 1

  The performer can assume it's a driver bug if this references a non-existent Cluster, and throw an error.

• string name = 2

  The span is created with this name.

• string id = 3

  This is used to reference the RequestSpan later.

• optional string parent_span_id = 4

  References a previously created RequestSpan to supply as a parent. If it's not present then don't provide a parent. The performer can assume it's a driver bug if this references a non-existent span, and throw an error.

• map<string, Attribute> attributes = 5

  Attributes to set on the span.

Empty but included anyway per GRPC best practices.

Used as response type in: PerformerService.spanCreate

(message has no fields)

The performer finishes a span and removes it from its map. The performer can assume it's a driver bug if this references a non-existent span, and throw an error.

Used as request type in: PerformerService.spanFinish

• string id = 1

Empty but included anyway per GRPC best practices.

Used as response type in: PerformerService.spanFinish

(message has no fields)

Used in: Config

• optional int32 emit_interval_millis = 1

• optional int32 kv_threshold_millis = 2

• optional int32 query_threshold_millis = 3

• optional int32 views_threshold_millis = 4

• optional int32 search_threshold_millis = 5

• optional int32 analytics_threshold_millis = 6

• optional int32 transactions_threshold_millis = 7

• optional int32 sample_size = 8

• optional bool enabled = 9

Configures the performer to output OpenTelemetry tracing data.

Used in: Config

• string endpoint_hostname = 1

  Where to send the OTLP traffic.

• float sampling_percentage = 2

  [0-1]: what percentage of the traces emitted should be sent to the endpoint. The performer should use an epsilon based check, and if this value ~= 0, set it to never output, and if ~= 1, always output.

• bool batching = 3

  Whether the performer should enable batching of the traces.

• int32 export_every_millis = 4

  How frequently to export data, as a best effort. This lets us tune for quick observability during integration tests, and reducing traffic and overhead in performance tests.

• map<string, Attribute> resources = 5

  Attributes to provide to the TracerProvider. While this is under-documented in OpenTelemetry, the intent here is to provide fields such as "service.name".