otlp2records 0.11.0

Transform OTLP telemetry to flattened records
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

//! Canonical OpenTelemetry Arrow Protocol envelope definitions.
//!
//! Synced from `opentelemetry/proto/experimental/arrow/v1/arrow_service.proto`
//! in open-telemetry/otel-arrow commit
//! `f8cd17f084c1a766f887530531ad06f546080c90`.

/// A collection of Arrow payloads sharing an OTAP batch ID.
#[derive(Clone, PartialEq, prost::Message)]
pub struct BatchArrowRecords {
    #[prost(int64, tag = "1")]
    pub batch_id: i64,
    #[prost(message, repeated, tag = "2")]
    pub arrow_payloads: Vec<ArrowPayload>,
    #[prost(bytes = "vec", tag = "3")]
    pub headers: Vec<u8>,
}

/// Per-batch acknowledgement the server returns on an OTAP stream: one
/// `BatchStatus` per received [`BatchArrowRecords`], echoing its `batch_id`.
#[derive(Clone, PartialEq, prost::Message)]
pub struct BatchStatus {
    #[prost(int64, tag = "1")]
    pub batch_id: i64,
    #[prost(enumeration = "StatusCode", tag = "2")]
    pub status_code: i32,
    #[prost(string, tag = "3")]
    pub status_message: String,
}

/// OTAP stream status codes (otel-arrow `StatusCode`), mirroring the canonical
/// gRPC status codes. The numbering matches the proto and is intentionally
/// non-contiguous.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, prost::Enumeration)]
#[repr(i32)]
pub enum StatusCode {
    Ok = 0,
    Canceled = 1,
    InvalidArgument = 3,
    DeadlineExceeded = 4,
    PermissionDenied = 7,
    ResourceExhausted = 8,
    Aborted = 10,
    Internal = 13,
    Unavailable = 14,
    Unauthenticated = 16,
}

/// One Arrow IPC stream fragment in a [`BatchArrowRecords`] envelope.
#[derive(Clone, PartialEq, Eq, Hash, prost::Message)]
pub struct ArrowPayload {
    #[prost(string, tag = "1")]
    pub schema_id: String,
    #[prost(enumeration = "ArrowPayloadType", tag = "2")]
    pub r#type: i32,
    #[prost(bytes = "vec", tag = "3")]
    pub record: Vec<u8>,
}

/// OTLP `AnyValue` discriminants as encoded in the OTAP attribute `type`
/// column (otel-arrow `AttributeValueType`).
///
/// `Map` (5) and `Slice` (6) payloads are CBOR-serialized into the `ser`
/// column; the remaining variants map to their like-named typed columns. They
/// are shared by the decoder (`otap::logs`) and the structural validator
/// (`otap::validation`) so the column reader and validator cannot disagree on
/// the numbering.
pub(crate) const VALUE_EMPTY: u8 = 0;
pub(crate) const VALUE_STR: u8 = 1;
pub(crate) const VALUE_I64: u8 = 2;
pub(crate) const VALUE_F64: u8 = 3;
pub(crate) const VALUE_BOOL: u8 = 4;
pub(crate) const VALUE_MAP: u8 = 5;
pub(crate) const VALUE_SLICE: u8 = 6;
pub(crate) const VALUE_BYTES: u8 = 7;

/// Column names of an OTAP `AnyValue` record — the `type` discriminator plus
/// the typed payload columns, which line up 1:1 with the `VALUE_*` constants
/// above (`VALUE_STR` → `ATTR_STR`, etc.) — together with the attribute `key`.
/// This same column layout backs attribute records and the log `body` struct.
/// Shared by the structural validator (`otap::validation`) and the decoder
/// (`otap::logs`) so a rename cannot silently desync the validator from the
/// reader.
pub(crate) const ATTR_KEY: &str = "key";
pub(crate) const ATTR_TYPE: &str = "type";
pub(crate) const ATTR_STR: &str = "str";
pub(crate) const ATTR_INT: &str = "int";
pub(crate) const ATTR_DOUBLE: &str = "double";
pub(crate) const ATTR_BOOL: &str = "bool";
pub(crate) const ATTR_BYTES: &str = "bytes";
pub(crate) const ATTR_SER: &str = "ser";

/// Canonical OTAP payload type numbers.
#[non_exhaustive]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, prost::Enumeration)]
#[repr(i32)]
pub enum ArrowPayloadType {
    Unknown = 0,
    ResourceAttrs = 1,
    ScopeAttrs = 2,
    UnivariateMetrics = 10,
    NumberDataPoints = 11,
    SummaryDataPoints = 12,
    HistogramDataPoints = 13,
    ExpHistogramDataPoints = 14,
    NumberDpAttrs = 15,
    SummaryDpAttrs = 16,
    HistogramDpAttrs = 17,
    ExpHistogramDpAttrs = 18,
    NumberDpExemplars = 19,
    HistogramDpExemplars = 20,
    ExpHistogramDpExemplars = 21,
    NumberDpExemplarAttrs = 22,
    HistogramDpExemplarAttrs = 23,
    ExpHistogramDpExemplarAttrs = 24,
    MultivariateMetrics = 25,
    MetricAttrs = 26,
    Logs = 30,
    LogAttrs = 31,
    Spans = 40,
    SpanAttrs = 41,
    SpanEvents = 42,
    SpanLinks = 43,
    SpanEventAttrs = 44,
    SpanLinkAttrs = 45,
}