HTTP tap data¶

This documentation is for the Envoy v3 API.

As of Envoy v1.18 the v2 API has been removed and is no longer supported.

If you are upgrading from v2 API config you may wish to view the v2 API documentation:

data/tap/v2alpha/http.proto

data.tap.v3.HttpBufferedTrace¶

A fully buffered HTTP trace message.

{
  "request": "{...}",
  "response": "{...}"
}

request: (data.tap.v3.HttpBufferedTrace.Message) Request message.

response: (data.tap.v3.HttpBufferedTrace.Message) Response message.

data.tap.v3.HttpBufferedTrace.Message¶

[data.tap.v3.HttpBufferedTrace.Message proto]

HTTP message wrapper.

{
  "headers": [],
  "body": "{...}",
  "trailers": []
}

headers: (repeated config.core.v3.HeaderValue) Message headers.

body: (data.tap.v3.Body) Message body.

trailers: (repeated config.core.v3.HeaderValue) Message trailers.

data.tap.v3.HttpStreamedTraceSegment¶

[data.tap.v3.HttpStreamedTraceSegment proto]

A streamed HTTP trace segment. Multiple segments make up a full trace.

{
  "trace_id": "...",
  "request_headers": "{...}",
  "request_body_chunk": "{...}",
  "request_trailers": "{...}",
  "response_headers": "{...}",
  "response_body_chunk": "{...}",
  "response_trailers": "{...}"
}

trace_id: (uint64) Trace ID unique to the originating Envoy only. Trace IDs can repeat and should not be used for long term stable uniqueness.

request_headers

(config.core.v3.HeaderMap) Request headers.

Only one of request_headers, request_body_chunk, request_trailers, response_headers, response_body_chunk, response_trailers may be set.

request_body_chunk

(data.tap.v3.Body) Request body chunk.

Only one of request_headers, request_body_chunk, request_trailers, response_headers, response_body_chunk, response_trailers may be set.

request_trailers

(config.core.v3.HeaderMap) Request trailers.

Only one of request_headers, request_body_chunk, request_trailers, response_headers, response_body_chunk, response_trailers may be set.

response_headers

(config.core.v3.HeaderMap) Response headers.

Only one of request_headers, request_body_chunk, request_trailers, response_headers, response_body_chunk, response_trailers may be set.

response_body_chunk

(data.tap.v3.Body) Response body chunk.

Only one of request_headers, request_body_chunk, request_trailers, response_headers, response_body_chunk, response_trailers may be set.

response_trailers

(config.core.v3.HeaderMap) Response trailers.

Only one of request_headers, request_body_chunk, request_trailers, response_headers, response_body_chunk, response_trailers may be set.