package opentelemetry.proto.collector.metrics.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Service that can be used to push metrics between one Application instrumented with OpenTelemetry and a collector, or between a collector and a central collector.

• rpc Export (ExportMetricsServiceRequest, ExportMetricsServiceResponse)

  metrics_service.proto:33

  For performance reasons, it is recommended to keep this RPC alive for the entire life of the application.

  message ExportMetricsServiceRequest

  metrics_service.proto:36

  • repeated metrics.v1.ResourceMetrics resource_metrics = 1

    An array of ResourceMetrics. For data coming from a single resource this array will typically contain one element. Intermediary nodes (such as OpenTelemetry Collector) that receive data from multiple origins typically batch the data before forwarding further and in that case this array will contain multiple elements.

  message ExportMetricsServiceResponse

  metrics_service.proto:45

  • optional ExportMetricsPartialSuccess partial_success = 1

    The details of a partially successful export request. If the request is only partially accepted (i.e. when the server accepts only parts of the data and rejects the rest) the server MUST initialize the `partial_success` field and MUST set the `rejected_<signal>` with the number of items it rejected. Servers MAY also make use of the `partial_success` field to convey warnings/suggestions to senders even when the request was fully accepted. In such cases, the `rejected_<signal>` MUST have a value of `0` and the `error_message` MUST be non-empty. A `partial_success` message with an empty value (rejected_<signal> = 0 and `error_message` = "") is equivalent to it not being set/present. Senders SHOULD interpret it the same way as in the full success case.

Used in: ExportMetricsServiceResponse

• int64 rejected_data_points = 1

  The number of rejected data points. A `rejected_<signal>` field holding a `0` value indicates that the request was fully accepted.

• string error_message = 2

  A developer-facing human-readable message in English. It should be used either to explain why the server rejected parts of the data during a partial success or to convey warnings/suggestions during a full success. The message should offer guidance on how users can address such issues. error_message is an optional field. An error_message with an empty value is equivalent to it not being set.