MeshAccessLog (beta)

With the MeshAccessLog policy you can easily set up access logs on every data plane proxy in a mesh.

This policy uses a new policy matching algorithm and is in beta state. It should not be combined with TrafficLog.

This guide assumes you have already configured your observability tools to work with Kuma. If you haven’t, see the observability docs.

targetRef support matrix

targetRef.kindtop leveltofrom
Mesh✅✅✅
MeshSubset✅❌❌
MeshService✅✅❌
MeshServiceSubset✅❌❌

To learn more about the information in this table, see the matching docs.

Configuration

Format

Kuma gives you full control over the format of the access logs.

The shape of a single log record is defined by a template string that uses command operators to extract and format data about a TCP connection or an HTTP request.

For example:

  1. %START_TIME% %KUMA_SOURCE_SERVICE% => %KUMA_DESTINATION_SERVICE% %DURATION%

%START_TIME% and %KUMA_SOURCE_SERVICE% are examples of available command operators.

All command operators defined by Envoy are supported, along with additional command operators defined by Kuma:

Command OperatorDescription
%KUMA_MESH%Name of the mesh in which traffic is flowing.
%KUMA_SOURCE_SERVICE%Name of a service that is the source of traffic.
%KUMA_DESTINATION_SERVICE%Name of a service that is the destination of traffic.
%KUMA_SOURCE_ADDRESS_WITHOUT_PORT%Address of a Dataplane that is the source of traffic.
%KUMA_TRAFFIC_DIRECTION%Direction of the traffic, INBOUND, OUTBOUND, or UNSPECIFIED.

All additional access log command operators are valid to use with both TCP and HTTP traffic.

Internally, Kuma determines traffic protocol based on the value of kuma.io/protocol tag on the inbound interface of a destination Dataplane.

There are two types of format, plain and json.

Plain accepts a string with command operators and produces a string output.

JSON accepts a list of key-value pairs that produces a valid JSON object.

It is up to the user to decide which format type to use. Some system will automatically parse JSON logs and allow you to filter and query based on available keys.

If a command operator is specific to HTTP traffic, such as %REQ(X?Y):Z% or %RESP(X?Y):Z%, in the case of TCP traffic it will be replaced by a symbol “-” for plain and a null value for json. You can set the format.omitEmptyValues boolean option to change this to "" for plain and omit them entirely for json.

Plain

The default format string for TCP traffic is:

  1. [%START_TIME%] %RESPONSE_FLAGS% %KUMA_MESH% %KUMA_SOURCE_ADDRESS_WITHOUT_PORT%(%KUMA_SOURCE_SERVICE%)->%UPSTREAM_HOST%(%KUMA_DESTINATION_SERVICE%) took %DURATION%ms, sent %BYTES_SENT% bytes, received: %BYTES_RECEIVED% bytes

The default format string for HTTP traffic is:

  1. [%START_TIME%] %KUMA_MESH% "%REQ(:METHOD)% %REQ(X-ENVOY-ORIGINAL-PATH?:PATH)% %PROTOCOL%" %RESPONSE_CODE% %RESPONSE_FLAGS% %BYTES_RECEIVED% %BYTES_SENT% %DURATION% %RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)% "%REQ(X-FORWARDED-FOR)%" "%REQ(USER-AGENT)%" "%REQ(X-REQUEST-ID)%" "%REQ(:AUTHORITY)%" "%KUMA_SOURCE_SERVICE%" "%KUMA_DESTINATION_SERVICE%" "%KUMA_SOURCE_ADDRESS_WITHOUT_PORT%" "%UPSTREAM_HOST%"

Example configuration:

  1. format:
  2.   plain: '[%START_TIME%] %BYTES_RECEIVED%'

Example output:

  1. [2016-04-15T20:17:00.310Z] 154

JSON

Example configuration:

  1. format:
  2.   json:
  3.     - key: "start_time"
  4.       value: "%START_TIME%"
  5.     - key: "bytes_received"
  6.       value: "%BYTES_RECEIVED%"

Example output:

  1. {
  2.   "start_time": "2016-04-15T20:17:00.310Z",
  3.   "bytes_received": "154"
  4. }

TCP configuration with default fields:

  1. format:
  2.   json:
  3.     - key: "start_time"
  4.       value: "%START_TIME%"
  5.     - key: "response_flags"
  6.       value: "%RESPONSE_FLAGS%"
  7.     - key: "kuma_mesh"
  8.       value: "%KUMA_MESH%"
  9.     - key: "kuma_source_address_without_port"
  10.       value: "%KUMA_SOURCE_ADDRESS_WITHOUT_PORT%"
  11.     - key: "kuma_source_service"
  12.       value: "%KUMA_SOURCE_SERVICE%"
  13.     - key: "upstream_host"
  14.       value: "%UPSTREAM_HOST%"
  15.     - key: "kuma_destination_service"
  16.       value: "%KUMA_DESTINATION_SERVICE%"
  17.     - key: "duration_ms"
  18.       value: "%DURATION%"
  19.     - key: "bytes_sent"
  20.       value: "%BYTES_SENT%"
  21.     - key: "bytes_received"
  22.       value: "%BYTES_RECEIVED%"
  23. ``` HTTP configuration with default fields:

format: json:

  1. - key: "start_time"
  2.   value: "%START_TIME%"
  3. - key: "kuma_mesh"
  4.   value: "%KUMA_MESH%"
  5. - key: 'method'
  6.   value: '"%REQ(:METHOD)%'
  7. - key: "path"
  8.   value: "%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%"
  9. - key: 'protocol'
  10.   value: '%PROTOCOL%'
  11. - key: "response_code"
  12.   value: "%RESPONSE_CODE%"
  13. - key: "response_flags"
  14.   value: "%RESPONSE_FLAGS%"
  15. - key: "bytes_received"
  16.   value: "%BYTES_RECEIVED%"
  17. - key: "bytes_sent"
  18.   value: "%BYTES_SENT%"
  19. - key: "duration_ms"
  20.   value: "%DURATION%"
  21. - key: "upstream_service_time"
  22.   value: "%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%"
  23. - key: 'x_forwarded_for'
  24.   value: '"%REQ(X-FORWARDED-FOR)%"'
  25. - key: 'user_agent'
  26.   value: '"%REQ(USER-AGENT)%"'
  27. - key: 'request_id'
  28.   value: '"%REQ(X-REQUEST-ID)%"'
  29. - key: 'authority'
  30.   value: '"%REQ(:AUTHORITY)%"'
  31. - key: "kuma_source_service"
  32.   value: "%KUMA_SOURCE_SERVICE%"
  33. - key: "kuma_destination_service"
  34.   value: "%KUMA_DESTINATION_SERVICE%"
  35. - key: "kuma_source_address_without_port"
  36.   value: "%KUMA_SOURCE_ADDRESS_WITHOUT_PORT%"
  37. - key: "upstream_host"
  38.   value: "%UPSTREAM_HOST%"
  2. ### Backends
  4. A backend determines where the logs end up.
  6. #### TCP
  8. A TCP backend streams logs to a server via TCP protocol. You can configure a TCP backend with an address:

backends:

  • tcp: address: 127.0.0.1:5000 ```

File

A file backend streams logs to a text file. You can configure a file backend with a path:

  1. backends:
  2.   - file:
  3.       path: /tmp/access.log

OpenTelemetry

An OpenTelemetry (OTel) backend sends data to an OpenTelemetry server. You can configure an OpenTelemetry backend with an endpoint:

  1. backends:
  2.   - openTelemetry:
  3.       endpoint: otel-collector:4317

Examples

Log outgoing traffic from specific frontend version to a backend service

  1. apiVersion: kuma.io/v1alpha1
  2. kind: MeshAccessLog
  3. metadata:
  4.   name: default
  5.   namespace: kuma-system
  6.   labels:
  7.     kuma.io/mesh: default # optional, defaults to `default` if it isn't configured
  8. spec:
  9.   targetRef:
  10.     kind: MeshServiceSubset
  11.     name: frontend
  12.     tags:
  13.       version: canary
  14.   to:
  15.     - targetRef:
  16.         kind: MeshService
  17.         name: backend
  18.       default:
  19.         backends:
  20.           - file:
  21.               path: /tmp/access.log

Apply the configuration with kubectl apply -f [..].

  1. type: MeshAccessLog
  2. name: default
  3. mesh: default
  4. spec:
  5.   targetRef:
  6.     kind: MeshServiceSubset
  7.     name: frontend
  8.     tags:
  9.       version: canary
  10.   to:
  11.     - targetRef:
  12.         kind: MeshService
  13.         name: backend
  14.       default:
  15.         backends:
  16.           - file:
  17.               path: /tmp/access.log

Apply the configuration with kumactl apply -f [..] or with the HTTP API.

Logging to multiple backends

This configuration logs to three backends: TCP, file and OpenTelemetry.

  1. apiVersion: kuma.io/v1alpha1
  2. kind: MeshAccessLog
  3. metadata:
  4.   name: default
  5.   namespace: kuma-system
  6.   labels:
  7.     kuma.io/mesh: default # optional, defaults to `default` if it isn't configured
  8. spec:
  9.   targetRef:
  10.     kind: Mesh
  11.   from:
  12.     - targetRef:
  13.         kind: Mesh
  14.       default:
  15.         backends:
  16.           - tcp:
  17.               address: 127.0.0.1:5000
  18.               format:
  19.                 json:
  20.                   - key: "start_time"
  21.                     value: "%START_TIME%"
  22.           - file:
  23.               path: /tmp/access.log
  24.               format:
  25.                 plain: '[%START_TIME%]'
  26.           - openTelemetry:
  27.               endpoint: otel-collector:4317
  28.               attributes:
  29.                 - key: "start_time"
  30.                   value: "%START_TIME%"

Apply the configuration with kubectl apply -f [..].

  1. type: MeshAccessLog
  2. name: default
  3. mesh: default
  4. spec:
  5.   targetRef:
  6.     kind: Mesh
  7.   from:
  8.     - targetRef:
  9.         kind: Mesh
  10.       default:
  11.         backends:
  12.           - tcp:
  13.               address: 127.0.0.1:5000
  14.               format:
  15.                 json:
  16.                   - key: "start_time"
  17.                     value: "%START_TIME%"
  18.           - file:
  19.               path: /tmp/access.log
  20.               format:
  21.                 plain: '[%START_TIME%]'
  22.           - openTelemetry:
  23.               endpoint: otel-collector:4317
  24.               attributes:
  25.                 - key: "start_time"
  26.                   value: "%START_TIME%"

Apply the configuration with kumactl apply -f [..] or with the HTTP API.

Log all incoming and outgoing traffic

  1. apiVersion: kuma.io/v1alpha1
  2. kind: MeshAccessLog
  3. metadata:
  4.   name: default
  5.   namespace: kuma-system
  6.   labels:
  7.     kuma.io/mesh: default # optional, defaults to `default` if it isn't configured
  8. spec:
  9.   targetRef:
  10.     kind: Mesh
  11.   from: # delete this section if you don't want to log incoming traffic
  12.     - targetRef:
  13.         kind: Mesh
  14.       default:
  15.         backends:
  16.           - file:
  17.               path: /tmp/access.log
  18.   to: # delete this section if you don't want to log outgoing traffic
  19.     - targetRef:
  20.         kind: Mesh
  21.       default:
  22.         backends:
  23.           - file:
  24.               path: /tmp/access.log

Apply the configuration with kubectl apply -f [..].

  1. type: MeshAccessLog
  2. name: default
  3. mesh: default
  4. spec:
  5.   targetRef:
  6.     kind: Mesh
  7.   from: # delete this section if you don't want to log incoming traffic
  8.     - targetRef:
  9.         kind: Mesh
  10.       default:
  11.         backends:
  12.           - file:
  13.               path: /tmp/access.log
  14.   to: # delete this section if you don't want to log outgoing traffic
  15.     - targetRef:
  16.         kind: Mesh
  17.       default:
  18.         backends:
  19.           - file:
  20.               path: /tmp/access.log

Apply the configuration with kumactl apply -f [..] or with the HTTP API.

Logging traffic going outside the Mesh

To target ExternalServices, use MeshService as the targetRef kind with name set to
the kuma.io/service value.

To target other non-mesh traffic, i.e. passthrough traffic, use Mesh as the targetRef kind. In this case, %KUMA_DESTINATION_SERVICE% is set to external.

Select a built-in gateway

You can select a built-in gateway using the kuma.io/service value. A current limitation is that traffic routed from a gateway to a service is logged by that gateway as having destination "*".