Send access logs to OpenTelemetry collector service

This topic describes how to use the OpenTelemetry Access Logging Envoy extension to send access logs to OpenTelemetry collector service.

Workflow

Complete the following steps to use the OpenTelemetry Access Logging extension:

1. Configure an EnvoyExtensions block in a service defaults or proxy defaults configuration entry.
2. Apply the configuration entry.

Add the EnvoyExtensions

Add Envoy extension configurations to a proxy defaults or service defaults configuration entry. Place the extension configuration in an EnvoyExtensions block in the configuration entry.

• When you configure Envoy extensions on proxy defaults, they apply to every service.
• When you configure Envoy extensions on service defaults, they apply to a specific service.

Consul applies Envoy extensions configured in proxy defaults before it applies extensions in service defaults. As a result, the Envoy extension configuration in service defaults may override configurations in proxy defaults.

The following example shows a service defaults configuration entry for the api service that directs the Envoy proxy to make gRPC OpenTelemetry Access Logging requests to the otel-collector service:

Kind = "service-defaults"
Name = "api"
EnvoyExtensions = [
  {
    Name = "builtin/otel-access-logging"
    Arguments = {
      ProxyType = "connect-proxy"
      Config = {
        GrpcService = {
          Target = {
            Service = {
              Name = "otel-collector"
            }
          }
        }
      }
    }
  }
]

{
  "Kind": "service-defaults",
  "Name": "api",
  "EnvoyExtensions": [{
    "Name": "builtin/otel-access-logging",
    "Arguments": {
      "ProxyType": "connect-proxy",
      "Config": {
        "GrpcService": {
          "Target": {
            "Service": {
              "Name": "otel-collector"
            }
          }
        }
      }
    }
  }]
}

apiVersion: consul.hashicorp.com/v1alpha1
kind: ServiceDefaults
metadata:
  name: api
  namespace: default
spec:
  envoyExtensions:
  - name: builtin/otel-access-logging
    arguments:
      proxyType: connect-proxy
      config:
        grpcService:
          target:
            service:
              name: otel-collector
              namespace: otel-collector

Refer to the OpenTelemetry Access Logging extension configuration reference for details on how to configure the extension.

Refer to the proxy defaults configuration entry reference and service defaults configuration entry reference for details on how to define the configuration entries.

Unsupported Envoy configuration fields

The following Envoy configurations are not supported:

Apply the configuration entry

If your network is deployed to virtual machines, use the consul config write command and specify the proxy defaults or service defaults configuration entry to apply the configuration. For Kubernetes-orchestrated networks, use the kubectl apply command. The following example applies the extension in a proxy defaults configuration entry.

$ consul config write api-otel-collector-service-defaults.hcl

$ consul config write api-otel-collector-service-defaults.json

$ kubectl apply -f api-otel-collector-service-defaults.yaml