Chapter 3. Cluster logging

Procedure

• Configure the log settings for Serving and Eventing by setting or modifying the loglevel value in the KnativeServing and KnativeEventing CR respectively. Here are two example configurations with all possible logging options set to level info:

  KnativeServing CR

  apiVersion: operator.knative.dev/v1beta1
  kind: KnativeServing
  metadata:
    name: knative-serving
    namespace: knative-serving
  spec:
    config:
      logging:
        loglevel.controller: "info"
        loglevel.autoscaler: "info"
        loglevel.queueproxy: "info"
        loglevel.webhook: "info"
        loglevel.activator: "info"
        loglevel.hpaautoscaler: "info"
        loglevel.net-certmanager-controller: "info"
        loglevel.net-istio-controller: "info"
        loglevel.net-kourier-controller: "info"

  Copy to Clipboard Toggle word wrap

  KnativeEventing CR

  apiVersion: operator.knative.dev/v1beta1
  kind: KnativeEventing
  metadata:
    name: knative-eventing
    namespace: knative-eventing
  spec:
    config:
      logging:
        loglevel.controller: "info"
        loglevel.eventing-webhook: "info"
        loglevel.inmemorychannel-dispatcher: "info"
        loglevel.inmemorychannel-webhook: "info"
        loglevel.mt-broker-controller: "info"
        loglevel.mt_broker_filter: "info"
        loglevel.mt_broker_ingress: "info"
        loglevel.pingsource-mt-adapter: "info"

  Copy to Clipboard Toggle word wrap

Procedure

• Configure request logging for your service by modifying the observability field in your KnativeServing CR:

  Example KnativeServing CR

  apiVersion: operator.knative.dev/v1beta1
  kind: KnativeServing
  metadata:
    name: knative-serving
    namespace: knative-serving
  # ...
  spec:
    config:
      observability:
          logging.enable-request-log: true
          logging.enable-probe-request-log: true
          logging.request-log-template: '{"httpRequest": {"requestMethod": "{{.Request.Method}}", "requestUrl": "{{js .Request.RequestURI}}", "requestSize": "{{.Request.ContentLength}}", "status": {{.Response.Code}}, "responseSize": "{{.Response.Size}}", "userAgent": "{{js .Request.UserAgent}}", "remoteIp": "{{js .Request.RemoteAddr}}", "serverIp": "{{.Revision.PodIP}}", "referer": "{{js .Request.Referer}}", "latency": "{{.Response.Latency}}s", "protocol": "{{.Request.Proto}}"}, "traceId": "{{index .Request.Header "X-B3-Traceid"}}"}'
  # ...

  Copy to Clipboard Toggle word wrap

• Request is an http.Request representing an HTTP request received by the server.

• Response represents the HTTP response and includes the following fields:

  • Code is the HTTP status code.
  • Size is the response size in bytes.
  • Latency is the response latency in seconds.

• Revision contains revision details and includes the following fields:

  • Name is the name of the revision.
  • Namespace is the namespace of the revision.
  • Service is the name of the service.
  • Configuration is the name of the configuration.
  • PodName is the name of the pod hosting the revision.
  • PodIP is the IP address of the hosting pod.