OpsCenter logback.xml configuration

The OpsCenter daemon process uses the Java logback library. All logging configuration is done in the logback.xml file. This section highlights some of the most common configuration properties. Refer to the logback configuration guides for additional details.

Configuration files
Filename	Package installation location	Tarball installation location
`opscenterd.log`	`/var/log/opscenter/opscenterd.log`	`INSTALL_DIRECTORY/log/opscenterd.log`
`logback.xml`	`/etc/opscenter/logback.xml`	`INSTALL_DIRECTORY/conf/logback.xml`

Restart OpsCenter for logging changes to take effect.

opscenterd_log appender

The main logback appender used by default for OpsCenter is the opscenterd_log appender that controls appending log messages to the application log file. The base log <file> name is opscenterd.log. Below is a sample default block.

<appender name="opscenterd_log" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>./log/opscenterd.log</file>
    <encoder>
       <pattern>%date{ISO8601, UTC} [%X{cluster_id:-opscenterd}] %5level: %msg (%thread)%n%exception{20}</pattern>
    </encoder>
    <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
       <fileNamePattern>./log/opscenterd.%i.log</fileNamePattern>
       <minIndex>1</minIndex>
       <maxIndex>10</maxIndex>
     </rollingPolicy>
     <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
        <maxFileSize>10MB</maxFileSize>
     </triggeringPolicy>
</appender>

Some common configuration parameters include:

<file>: This is the base log file name that the current log messages are logged to.
<fileNamePattern>: This is the pattern logback follows when rolling a log file over. By default, the log file count is inserted into the filename (with the %i parameter).
<minIndex>: This is the integer that logback uses to start counting log files with. The default value is 1.
<maxIndex>: The integer that logback uses as the max number of log files to keep. If a new log is needed and there are already maxIndex files, logback deletes the minIndex logfile and rolls the remaining log files. The default value is 10.
<maxFileSize>: The log file size that causes logback to rotate the log files. By default, OpsCenter uses 10MB as a limit. Valid values can be found at https://logback.qos.ch/manual/appenders.html#SizeBasedTriggeringPolicy.

The same basic properties also apply to the http_log appender, which is the log destination for HTTP requests, and the repair_log appender, which is the log destination for repair service logs.

Change OpsCenter daemon logging level

Changing the level parameter in the <root> XML element only changes the logging level for the OpsCenter daemon and the cluster logging. Below is an example <root> block.

<root level="INFO">
    <appender-ref ref="opscenterd_log"/>
    <appender-ref ref="STDOUT"/>
</root>

Valid values for level include DEBUG, INFO, WARN, ERROR or OFF. By default, OpsCenter is configured to log at the INFO level. Setting the logging level to DEBUG or TRACE increases the verbosity of the log messages for troubleshooting.

In addition to the <root> logging level, there are also a set of granular logging-level configurations defined using the <logger> directive.

<logger name="com.datastax.driver" level="WARN" additivity="false"/>
<logger name="com.datastax.driver.core.FrameCompressor" level="ERROR"/>
<logger name="org.python" level="ERROR"/>
<logger name="org.jboss.netty" level="ERROR"/>
<logger name="org.apache.http" level="ERROR"/>
<logger name="com.mchange" level="ERROR"/>
<logger name="lcm" level="INFO"/>
<logger name="lcm.database.migration" level="WARN"/>

DataStax recommends leaving these levels set at their default points. Setting the log levels to a more verbose level might impact the performance of OpsCenter while generating unnecessary output.

Change console log level, HTTP request log level, Repair Service log level, and security log level

Based on some limitations with logback configurations, changing the log level of the HTTP request logs or the repair service logs requires changing the filter inside of the http_log and repair_log respectively.

<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
     <level>INFO</level>
</filter>

The valid values for this level are the same as the valid values listed in the section above.

Set the `DEBUG` logging level in the OpsCenter server and agents

The DEBUG logging level should only be used to investigate and test issues. Reset the logging level to INFO when you’re finished troubleshooting.

If you have an issue to troubleshoot, add one of the following entries to increase the logging level.

To set the logging level to DEBUG in OpsCenter, add or modify the following entry in the logback.xml file of your OpsCenter server (set <root> level to DEBUG):
```
----
<root level="DEBUG">
    <appender-ref ref="opscenterd_log"/>
    <appender-ref ref="STDOUT"/>
</root>
----
```
To set the logging level to DEBUG in the agent of a specific node, add or modify the following entry in the /etc/datastax-agent/log4j.properties file of the node:
```
----
log4j.rootLogger=DEBUG,R,stdout
----
```

You must restart OpsCenter and your agent to activate the DEBUG logging level.

OpsCenter logback.xml configuration

opscenterd_log appender

Change OpsCenter daemon logging level

Change console log level, HTTP request log level, Repair Service log level, and security log level

Set the `DEBUG` logging level in the OpsCenter server and agents

Was this helpful?

Give Feedback

OpsCenter logback.xml configuration

opscenterd_log appender

Change OpsCenter daemon logging level

Change console log level, HTTP request log level, Repair Service log level, and security log level

Set the DEBUG logging level in the OpsCenter server and agents

Was this helpful?

Set the `DEBUG` logging level in the OpsCenter server and agents