On this page

AccessLogging

AccessLogging API reference.

Proto: access_logging.proto

Package: rpc.solo.io

The logging service provides structured retrieval of event logs captured by Gloo Platform. For more information, see the access logging documentation.

AccessLog

Field	Description
`workloadMetadata`	(`AccessLog.WorkloadMetadata`) Metadata for the workload for which to record access logs.
`httpAccessLog`	(`envoy.data.accesslog.v3.HTTPAccessLogEntry`) An Envoy HTTP access log. For more information, see the Envoy API reference documentation.

AccessLog.WorkloadMetadata

Field	Description
`name`	(`string`) Workload name.
`namespace`	(`string`) Namespace that the workload is in.
`cluster`	(`string`) Cluster that the workload is in.
`labels`	(`repeated AccessLog.WorkloadMetadata.LabelsEntry`) Labels for the workload.

AccessLog.WorkloadMetadata.LabelsEntry

Field	Description
`key`	(`string`)
`value`	(`string`)

AccessLogs

Field	Description
`accessLogs`	(`repeated AccessLog`) An Envoy access log. For more information, see the Envoy API reference documentation.

GetAccessLogsRequest

Field	Description
`workloadSelectors`	(`repeated common.gloo.solo.io.ObjectSelector`) The workloads from which to get access logs. Leave empty to get access logs for all workloads.
`retrievalNumber`	(`google.protobuf.UInt32Value`) Maximum number of access logs to get. If empty, the default value of 20 is used. For information about the value format, see the Google protocol buffer documentation.

WatchAccessLogsRequest

Field	Description
`workloadSelectors`	(`repeated common.gloo.solo.io.ObjectSelector`) The workloads for which to stream access logs. Leave empty to stream access logs for all workloads.

Logging

Method Name	Request Type	Response Type	Description
`WatchAccessLogs`	WatchAccessLogsRequest	AccessLog stream	Stream Envoy access logs as they are captured.
`GetAccessLogs`	GetAccessLogsRequest	AccessLogs	Retrieve Envoy access logs for a workload.