On this page
AccessLogPolicy
AccessLogPolicy API reference.
Proto: access_log_policy.proto
Package: observability.policy.gloo.solo.io
Types:
- AccessLogPolicyReport
- AccessLogPolicyReport.WorkspacesEntry
- AccessLogPolicySpec
- AccessLogPolicySpec.Config
- AccessLogPolicySpec.Config.Filter
- AccessLogPolicyStatus
AccessLogPolicyReport
| Field | Description |
|---|---|
workspaces | (repeated AccessLogPolicyReport.WorkspacesEntry) |
selectedWorkloads | (repeated common.gloo.solo.io.WorkloadReference)A list of workloads selected by the policy. |
AccessLogPolicyReport.WorkspacesEntry
| Field | Description |
|---|---|
key | (string) |
value | (common.gloo.solo.io.Report) |
AccessLogPolicySpec
AccessLogPolicy is used to collect access logs from workloads which have injected (sidecars) or are standalone proxies (gateways). AccessLogPolicies are applied at the Workload level.
| Field | Description |
|---|---|
applyToWorkloads | (repeated common.gloo.solo.io.WorkloadSelector)Select the workloads where access logs will be collected. If left empty, will apply to all workloads in the workspace. |
config | (AccessLogPolicySpec.Config)The details of the policy specifying how to collect access logs from the selected workloads. |
AccessLogPolicySpec.Config
| Field | Description |
|---|---|
filters | (repeated AccessLogPolicySpec.Config.Filter)Configure criteria for determining which access logs will be recorded. The list is disjunctive, a request will be recorded if it matches any filter. Leave empty to emit all access logs. |
includedRequestHeaders | (repeated string)Specify request headers to include in access logs. |
includedResponseHeaders | (repeated string)Specify response headers to include in access logs. |
includedResponseTrailers | (repeated string)Specify response trailers to include in access logs. |
includedFilterStateObjects | (repeated string)Specify filter state objects to include in access logs. |
AccessLogPolicySpec.Config.Filter
Specify criteria for recording access logs. A request must match all specified criteria to be recorded.
| Field | Description |
|---|---|
statusCodeMatcher | (common.gloo.solo.io.StatusCodeMatcher)Matches against a response status code. Omit to match any status code. |
headerMatcher | (common.gloo.solo.io.HeaderMatcher)Matches against a request or response header. Omit to match any headers. |
AccessLogPolicyStatus
Reflects the status of the AccessLogPolicy.
| Field | Description |
|---|---|
common | (common.gloo.solo.io.Status) |
numSelectedWorkloads | (uint32)The number of workloads selected by the policy. |