gRPC Access Log Service (ALS)

service.accesslog.v2.StreamAccessLogsResponse

[service.accesslog.v2.StreamAccessLogsResponse proto]

Empty response for the StreamAccessLogs API. Will never be sent. See below.

  1. {}

service.accesslog.v2.StreamAccessLogsMessage

[service.accesslog.v2.StreamAccessLogsMessage proto]

Stream message for the StreamAccessLogs API. Envoy will open a stream to the server and stream access logs without ever expecting a response.

  1. {
  2. "identifier": "{...}",
  3. "http_logs": "{...}",
  4. "tcp_logs": "{...}"
  5. }

identifier

(service.accesslog.v2.StreamAccessLogsMessage.Identifier) Identifier data that will only be sent in the first message on the stream. This is effectively structured metadata and is a performance optimization.

http_logs

(service.accesslog.v2.StreamAccessLogsMessage.HTTPAccessLogEntries) Batches of log entries of a single type. Generally speaking, a given stream should only ever include one type of log entry.

Precisely one of http_logs, tcp_logs must be set.

tcp_logs

(service.accesslog.v2.StreamAccessLogsMessage.TCPAccessLogEntries) Batches of log entries of a single type. Generally speaking, a given stream should only ever include one type of log entry.

Precisely one of http_logs, tcp_logs must be set.

service.accesslog.v2.StreamAccessLogsMessage.Identifier

[service.accesslog.v2.StreamAccessLogsMessage.Identifier proto]

  1. {
  2. "node": "{...}",
  3. "log_name": "..."
  4. }

node

(core.Node, REQUIRED) The node sending the access log messages over the stream.

log_name

(string, REQUIRED) The friendly name of the log configured in CommonGrpcAccessLogConfig.

service.accesslog.v2.StreamAccessLogsMessage.HTTPAccessLogEntries

[service.accesslog.v2.StreamAccessLogsMessage.HTTPAccessLogEntries proto]

Wrapper for batches of HTTP access log entries.

  1. {
  2. "log_entry": []
  3. }

log_entry

(data.accesslog.v2.HTTPAccessLogEntry, REQUIRED)

service.accesslog.v2.StreamAccessLogsMessage.TCPAccessLogEntries

[service.accesslog.v2.StreamAccessLogsMessage.TCPAccessLogEntries proto]

Wrapper for batches of TCP access log entries.

  1. {
  2. "log_entry": []
  3. }

log_entry

(data.accesslog.v2.TCPAccessLogEntry, REQUIRED)