Skip to main content

Configure logging

Configuring logging​

The Identity component uses the Log4j2 framework to control the log level and log format.

The logging configuration that is included in the Identity image is:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN" monitorInterval="30">
<Properties>
<Property name="LOG_PATTERN">%clr{%d{yyyy-MM-dd HH:mm:ss.SSS}}{faint} %clr{%5p} %clr{${sys:PID}}{magenta}
%clr{---}{faint} %clr{[%15.15t]}{faint} %clr{%-40.40c{1.}}{cyan} %clr{:}{faint} %m%n%xwEx
</Property>
<Property name="LOG_FILE_PATTERN">%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{1.} %enc{%msg}%n
</Property>
<Property name="LOG_FILE_NAME_PATTERN">logs/identity.%d{yyyy-MM-dd-mm-ss}.log</Property>
</Properties>
<Appenders>
<Console name="Console" target="SYSTEM_OUT" follow="true">
<PatternLayout pattern="${env:IDENTITY_LOG_PATTERN:-${LOG_PATTERN}}"/>
</Console>
<Console name="Stackdriver" target="SYSTEM_OUT" follow="true">
<JsonTemplateLayout eventTemplateUri="classpath:GcpLayout.json" locationInfoEnabled="true"/>
</Console>
</Appenders>
<Loggers>
<Logger name="io.camunda.identity" level="${env:IDENTITY_LOG_LEVEL:-info}"/>
<Root level="warn">
<AppenderRef ref="${env:IDENTITY_LOG_APPENDER:-Console}"/>
</Root>
</Loggers>
</Configuration>

General configuration options​

Identity provides support for configuring the log level:

Environment variableAccepted values
IDENTITY_LOG_LEVELOFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL

Supported logging outputs​

As part of configuration Identity provides multiple appenders for outputting logs, to configure which logging appender is used, set the IDENTITY_LOG_APPENDER environment variable to one of the following Console, or Stackdriver:

Console logging produces messages to standard output and is the default log appender. The Console log appender offers additional configuration options, these are:

Environment variableAccepted values
IDENTITY_LOG_PATTERNSee the Log4j2 pattern layout docs for possible placeholders.

Providing your own logging configuration​

You can provide your own configuration by mounting a configuration file to the Identity container and setting the path to the file using the following variable:

Environment variablePurpose
LOGGING_CONFIGThe path to your Log4j2 config XML file
note

To write logs to a file in a containerized environment, the mounted directory containing the log file has to be writable under the user running Identity.