Update Log Level#

By default, ESS uses INFO level logging. As part of your infrastructure-as-code deployment, you may wish to control log levels of the deployments using a customization.

For example, when debugging an issue you may temporarily enable DEBUG (or even TRACE) level logs to get more granular information on system behavior.

To change a service’s log level, you can create an overlay to update the QUARKUS_LOG_LEVEL environment variable to a supported value.

To enable TRACE level logs (the most verbose log level supported) you must also adjust the QUARKUS_LOG_MIN_LEVEL environment variable (which defaults to DEBUG) to TRACE.

Example Debug Logging Customization File#

You can use the following procedure to enable DEBUG level logging for pod-provisioning:

  1. Go to your ESS installation directory:

    cd ${HOME}/ess
    
  2. Modify the kustomization.yaml (i.e., step 3 of the Applying Your Customizations procedure).

    Specifically, add the highlighted content to the kustomization.yaml file under the patches key:

    Tip

    If patches list does not exist in kustomization.yaml, add the key patches as well.

    # kustomization.yaml in your ESS installation directory
    
    # ...  Preceding content omitted for brevity 
    # ...
    
    patches:
      - target:
          kind: Deployment
          name: ess-pod-provision
        patch: |-
          apiVersion: apps/v1
          kind: Deployment
          metadata:
            name: ess-pod-provision
          spec:
            template:
              spec:
                containers:
                  - env:
                    - name: QUARKUS_LOG_LEVEL
                      value: DEBUG
                    name: ess-pod-provision
    
  3. Continue with the rest of the Applying Your Customizations procedure.

Tip

Remember to reset the log level when you’re finished debugging.

Example Trace Logging Customization File#

You can use the following procedure to enable TRACE level logging for openid:

  1. Go to your ESS installation directory:

    cd ${HOME}/ess
    
  2. Modify the kustomization.yaml (i.e., step 3 of the Applying Your Customizations procedure).

    Specifically, add the highlighted content to the kustomization.yaml file under the patches key:

    Tip

    If patches list does not exist in kustomization.yaml, add the key patches as well.

    # kustomization.yaml in your ESS installation directory
    
    # ...  Preceding content omitted for brevity
    # ...
    
    patches:
      - target:
          kind: Deployment
          name: ess-openid
        patch: |-
          apiVersion: apps/v1
          kind: Deployment
          metadata:
            name: ess-openid
          spec:
            template:
              spec:
                containers:
                  - env:
                    - name: QUARKUS_LOG_MIN_LEVEL
                      value: TRACE
                    - name: QUARKUS_LOG_LEVEL
                      value: TRACE
                    name: ess-openid
    
  3. Continue with the rest of the Applying Your Customizations procedure.

Tip

Remember to reset the log level when you’re finished debugging.