[READ ONLY MIRROR] Envoy REST/proto API definitions and documentation. (grpc依赖)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 

70 lines
2.7 KiB

syntax = "proto3";
package envoy.service.accesslog.v3alpha;
option java_outer_classname = "AlsProto";
option java_multiple_files = true;
option java_package = "io.envoyproxy.envoy.service.accesslog.v3alpha";
option java_generic_services = true;
import "envoy/api/v3alpha/core/base.proto";
import "envoy/data/accesslog/v3alpha/accesslog.proto";
import "validate/validate.proto";
// [#protodoc-title: gRPC Access Log Service (ALS)]
// Service for streaming access logs from Envoy to an access log server.
service AccessLogService {
// Envoy will connect and send StreamAccessLogsMessage messages forever. It does not expect any
// response to be sent as nothing would be done in the case of failure. The server should
// disconnect if it expects Envoy to reconnect. In the future we may decide to add a different
// API for "critical" access logs in which Envoy will buffer access logs for some period of time
// until it gets an ACK so it could then retry. This API is designed for high throughput with the
// expectation that it might be lossy.
rpc StreamAccessLogs(stream StreamAccessLogsMessage) returns (StreamAccessLogsResponse) {
}
}
// Empty response for the StreamAccessLogs API. Will never be sent. See below.
message StreamAccessLogsResponse {
}
// Stream message for the StreamAccessLogs API. Envoy will open a stream to the server and stream
// access logs without ever expecting a response.
message StreamAccessLogsMessage {
message Identifier {
// The node sending the access log messages over the stream.
api.v3alpha.core.Node node = 1 [(validate.rules).message = {required: true}];
// The friendly name of the log configured in :ref:`CommonGrpcAccessLogConfig
// <envoy_api_msg_config.accesslog.v3alpha.CommonGrpcAccessLogConfig>`.
string log_name = 2 [(validate.rules).string = {min_bytes: 1}];
}
// Wrapper for batches of HTTP access log entries.
message HTTPAccessLogEntries {
repeated data.accesslog.v3alpha.HTTPAccessLogEntry log_entry = 1
[(validate.rules).repeated = {min_items: 1}];
}
// Wrapper for batches of TCP access log entries.
message TCPAccessLogEntries {
repeated data.accesslog.v3alpha.TCPAccessLogEntry log_entry = 1
[(validate.rules).repeated = {min_items: 1}];
}
// Identifier data that will only be sent in the first message on the stream. This is effectively
// structured metadata and is a performance optimization.
Identifier identifier = 1;
// Batches of log entries of a single type. Generally speaking, a given stream should only
// ever include one type of log entry.
oneof log_entries {
option (validate.required) = true;
HTTPAccessLogEntries http_logs = 2;
TCPAccessLogEntries tcp_logs = 3;
}
}