...

Text file src/github.com/datawire/ambassador/v2/api/envoy/service/tap/v3/tap.proto

Documentation: github.com/datawire/ambassador/v2/api/envoy/service/tap/v3

     1syntax = "proto3";
     2
     3package envoy.service.tap.v3;
     4
     5import "envoy/config/core/v3/base.proto";
     6import "envoy/data/tap/v3/wrapper.proto";
     7
     8import "udpa/annotations/status.proto";
     9import "udpa/annotations/versioning.proto";
    10import "validate/validate.proto";
    11
    12option java_package = "io.envoyproxy.envoy.service.tap.v3";
    13option java_outer_classname = "TapProto";
    14option java_multiple_files = true;
    15option java_generic_services = true;
    16option (udpa.annotations.file_status).package_version_status = ACTIVE;
    17
    18// [#protodoc-title: Tap Sink Service]
    19
    20// [#not-implemented-hide:] A tap service to receive incoming taps. Envoy will call
    21// StreamTaps to deliver captured taps to the server
    22service TapSinkService {
    23  // Envoy will connect and send StreamTapsRequest messages forever. It does not expect any
    24  // response to be sent as nothing would be done in the case of failure. The server should
    25  // disconnect if it expects Envoy to reconnect.
    26  rpc StreamTaps(stream StreamTapsRequest) returns (StreamTapsResponse) {
    27  }
    28}
    29
    30// [#not-implemented-hide:] Stream message for the Tap API. Envoy will open a stream to the server
    31// and stream taps without ever expecting a response.
    32message StreamTapsRequest {
    33  option (udpa.annotations.versioning).previous_message_type =
    34      "envoy.service.tap.v2alpha.StreamTapsRequest";
    35
    36  message Identifier {
    37    option (udpa.annotations.versioning).previous_message_type =
    38        "envoy.service.tap.v2alpha.StreamTapsRequest.Identifier";
    39
    40    // The node sending taps over the stream.
    41    config.core.v3.Node node = 1 [(validate.rules).message = {required: true}];
    42
    43    // The opaque identifier that was set in the :ref:`output config
    44    // <envoy_api_field_config.tap.v3.StreamingGrpcSink.tap_id>`.
    45    string tap_id = 2;
    46  }
    47
    48  // Identifier data effectively is a structured metadata. As a performance optimization this will
    49  // only be sent in the first message on the stream.
    50  Identifier identifier = 1;
    51
    52  // The trace id. this can be used to merge together a streaming trace. Note that the trace_id
    53  // is not guaranteed to be spatially or temporally unique.
    54  uint64 trace_id = 2;
    55
    56  // The trace data.
    57  data.tap.v3.TraceWrapper trace = 3;
    58}
    59
    60// [#not-implemented-hide:]
    61message StreamTapsResponse {
    62  option (udpa.annotations.versioning).previous_message_type =
    63      "envoy.service.tap.v2alpha.StreamTapsResponse";
    64}

View as plain text