summaryrefslogtreecommitdiff
path: root/src/rpc/envoy.extensions.request_id.uuid.v3.rs
blob: e8f5905fc36f97af5b7207f4830349b9a9ce0a56 (plain)
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
// @generated
// This file is @generated by prost-build.
// \[#protodoc-title: UUID\]
// \[#extension: envoy.request_id.uuid\]

/// Configuration for the default UUID request ID extension which has the following behavior:
///
/// 1. Request ID is propagated using the :ref:`x-request-id
///     <config_http_conn_man_headers_x-request-id>` header.
///
/// 2. Request ID is a universally unique identifier `(UUID4)
///     <<https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random>)>`_.
///
/// 3. Tracing decision (sampled, forced, etc) is set in 14th nibble of the UUID. By default this will
///     overwrite existing UUIDs received in the ``x-request-id`` header if the trace sampling decision
///     is changed. The 14th nibble of the UUID4 has been chosen because it is fixed to '4' by the
///     standard. Thus, '4' indicates a default UUID and no trace status. This nibble is swapped to:
///
///       a. '9': Sampled.
///       b. 'a': Force traced due to server-side override.
///       c. 'b': Force traced due to client-side request ID joining.
///
///     See the :ref:`x-request-id <config_http_conn_man_headers_x-request-id>` documentation for
///     more information.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct UuidRequestIdConfig {
    /// Whether the implementation alters the UUID to contain the trace sampling decision as per the
    /// ``UuidRequestIdConfig`` message documentation. This defaults to true. If disabled no
    /// modification to the UUID will be performed. It is important to note that if disabled,
    /// stable sampling of traces, access logs, etc. will no longer work and only random sampling will
    /// be possible.
    #[prost(message, optional, tag="1")]
    pub pack_trace_reason: ::core::option::Option<super::super::super::super::super::google::protobuf::BoolValue>,
    /// Set whether to use :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` for sampling or not.
    /// This defaults to true. See the :ref:`context propagation <arch_overview_tracing_context_propagation>`
    /// overview for more information.
    #[prost(message, optional, tag="2")]
    pub use_request_id_for_trace_sampling: ::core::option::Option<super::super::super::super::super::google::protobuf::BoolValue>,
}
// @@protoc_insertion_point(module)