Use Non-JSON Formatted Logging

ESS services uses JSON as the default log message format.

ESS services refer specifically to ESS code and not its dependencies. Dependencies (such as Kafka) use their own logging libraries and as such may use another format and have different fields.

Although JSON formatting allows the log messages to be enriched with details that non-JSON formatting does not allow, you can change the log format to non-JSON messages.

Example Customization

To change log messages to non-JSON formatting, you can use the disable-json-logging-for-quarkus component.

Note Non-JSON formatted messages do not contain all the details that JSON messages contain.

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 components field in the kustomization.yaml file:

   
    # kustomization.yaml in your ESS installation directory
    # ...  Preceding content omitted for brevity 
    # ...
    components:
      - ../release/ess/deployment/kubernetes/components/disable-json-logging-for-quarkus
    
    

3. Continue with the rest of the Applying Your Customizations procedure.

Tip To return to JSON-formatted logging, remove (or revert) the above changes.