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 java_generic_services = true;
15option (udpa.annotations.file_status).package_version_status = FROZEN;
16
17// [#protodoc-title: Tap Sink Service]
18
19// [#not-implemented-hide:] A tap service to receive incoming taps. Envoy will call
20// StreamTaps to deliver captured taps to the server
21service TapSinkService {
22 // Envoy will connect and send StreamTapsRequest messages forever. It does not expect any
23 // response to be sent as nothing would be done in the case of failure. The server should
24 // disconnect if it expects Envoy to reconnect.
25 rpc StreamTaps(stream StreamTapsRequest) returns (StreamTapsResponse) {
26 }
27}
28
29// [#not-implemented-hide:] Stream message for the Tap API. Envoy will open a stream to the server
30// and stream taps without ever expecting a response.
31message StreamTapsRequest {
32 message Identifier {
33 // The node sending taps over the stream.
34 api.v2.core.Node node = 1 [(validate.rules).message = {required: true}];
35
36 // The opaque identifier that was set in the :ref:`output config
37 // <envoy_api_field_service.tap.v2alpha.StreamingGrpcSink.tap_id>`.
38 string tap_id = 2;
39 }
40
41 // Identifier data effectively is a structured metadata. As a performance optimization this will
42 // only be sent in the first message on the stream.
43 Identifier identifier = 1;
44
45 // The trace id. this can be used to merge together a streaming trace. Note that the trace_id
46 // is not guaranteed to be spatially or temporally unique.
47 uint64 trace_id = 2;
48
49 // The trace data.
50 data.tap.v2alpha.TraceWrapper trace = 3;
51}
52
53// [#not-implemented-hide:]
54message StreamTapsResponse {
55}
View as plain text