1syntax = "proto3";
2
3package envoy.service.tap.v2alpha;
4
5import "envoy/api/v2/core/base.proto";
6import "envoy/data/tap/v2alpha/wrapper.proto";
7
8import "udpa/annotations/status.proto";
9import "validate/validate.proto";
10
11option java_package = "io.envoyproxy.envoy.service.tap.v2alpha";
12option java_outer_classname = "TapProto";
13option java_multiple_files = true;
14option go_package = "github.com/envoyproxy/go-control-plane/envoy/service/tap/v2alpha";
15option java_generic_services = true;
16option (udpa.annotations.file_status).package_version_status = FROZEN;
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 message Identifier {
34 // The node sending taps over the stream.
35 api.v2.core.Node node = 1 [(validate.rules).message = {required: true}];
36
37 // The opaque identifier that was set in the :ref:`output config
38 // <envoy_api_field_service.tap.v2alpha.StreamingGrpcSink.tap_id>`.
39 string tap_id = 2;
40 }
41
42 // Identifier data effectively is a structured metadata. As a performance optimization this will
43 // only be sent in the first message on the stream.
44 Identifier identifier = 1;
45
46 // The trace id. this can be used to merge together a streaming trace. Note that the trace_id
47 // is not guaranteed to be spatially or temporally unique.
48 uint64 trace_id = 2;
49
50 // The trace data.
51 data.tap.v2alpha.TraceWrapper trace = 3;
52}
53
54// [#not-implemented-hide:]
55message StreamTapsResponse {
56}
View as plain text