How server logging works

Fine-tune the log levels of individual loggers available in the Che server to control output verbosity and isolate issues during troubleshooting.

The log level of the whole Che server is configured globally using the cheLogLevel configuration property of the Operator. See CheCluster Custom Resource fields reference. To set the global log level in installations not managed by the Operator, specify the CHE_LOG_LEVEL environment variable in the che ConfigMap.

It is possible to configure the log levels of the individual loggers in the Che server using the CHE_LOGGER_CONFIG environment variable.

Configure log levels

Configure the log levels of individual loggers in the Che server using the CHE_LOGGER_CONFIG environment variable to control log verbosity and simplify troubleshooting.

Prerequisites

  • An active kubectl session with administrative permissions to the destination Kubernetes cluster. See Overview of kubectl.

Procedure

  1. Configure the CheCluster Custom Resource. See Using the CLI to configure the CheCluster Custom Resource.

    spec:
  components:
    cheServer:
      extraProperties:
        CHE_LOGGER_CONFIG: "<key1=value1,key2=value2>" (1)
    1 Comma-separated list of key-value pairs, where keys are the names of the loggers as seen in the Che server log output and values are the required log levels.
    Example 1. Configuring debug mode for the WorkspaceManager
    spec:
  components:
    cheServer:
      extraProperties:
        CHE_LOGGER_CONFIG: "org.eclipse.che.api.workspace.server.WorkspaceManager=DEBUG"
Additional resources

How logger names work

The names of the loggers follow the class names of the internal server classes that use those loggers.

Log HTTP traffic

Log the HTTP traffic between the Che server and the API server of the Kubernetes or Kubernetes cluster to troubleshoot communication issues and debug API errors.

Prerequisites

  • An active kubectl session with administrative permissions to the destination Kubernetes cluster. See Overview of kubectl.

Procedure

  1. Configure the CheCluster Custom Resource. See Using the CLI to configure the CheCluster Custom Resource.

    spec:
  components:
    cheServer:
      extraProperties:
        CHE_LOGGER_CONFIG: "che.infra.request-logging=TRACE"
Additional resources