syntax = "proto3";

package envoy.data.tap.v3;

import "envoy/data/tap/v3/http.proto";
import "envoy/data/tap/v3/transport.proto";
import "envoy/type/v3/percent.proto";

import "udpa/annotations/status.proto";
import "udpa/annotations/versioning.proto";
import "validate/validate.proto";

option java_package = "io.envoyproxy.envoy.data.tap.v3";
option java_outer_classname = "WrapperProto";
option java_multiple_files = true;
option go_package = "github.com/envoyproxy/go-control-plane/envoy/data/tap/v3;tapv3";
option (udpa.annotations.file_status).package_version_status = ACTIVE;

// [#protodoc-title: Tap data wrappers]

// Wrapper for all fully buffered and streamed tap traces that Envoy emits. This is required for
// sending traces over gRPC APIs or more easily persisting binary messages to files.
// [#next-free-field: 6]
message TraceWrapper {
  option (udpa.annotations.versioning).previous_message_type =
      "envoy.data.tap.v2alpha.TraceWrapper";

  oneof trace {
    option (validate.required) = true;

    // An HTTP buffered tap trace.
    HttpBufferedTrace http_buffered_trace = 1;

    // An HTTP streamed tap trace segment.
    HttpStreamedTraceSegment http_streamed_trace_segment = 2;

    // A socket buffered tap trace.
    SocketBufferedTrace socket_buffered_trace = 3;

    // A socket streamed tap trace segment.
    SocketStreamedTraceSegment socket_streamed_trace_segment = 4;
  }

  // The configured sample rate at the time this trace was admitted, sourced from the
  // :ref:`default_value
  // <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.default_value>` of
  // :ref:`tap_enabled <envoy_v3_api_field_config.tap.v3.TapConfig.tap_enabled>`. For
  // buffered output (where each ``TraceWrapper`` carries a complete trace) the rate is
  // always present when sampling is configured. For streamed output (where a trace is
  // split across multiple ``TraceWrapper`` segments) the rate is set on the first
  // emitted segment only; subsequent segments belonging to the same trace can be
  // joined to it via the ``trace_id`` carried on each inner segment message. Absent
  // when sampling is unconfigured.
  //
  // .. note::
  //
  //   When :ref:`runtime_key
  //   <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.runtime_key>` is
  //   configured and an active runtime override is in effect, the effective sampling
  //   rate that admitted the trace may differ from the recorded configured value.
  type.v3.FractionalPercent configured_sample_rate = 5;
}
