This page describes how to configure the logging in the different component of Step.

Controller logs

By default, the controller logs are written to the file log/controller.log.

The default logging settings can be changed in the file bin/logback.xml.

Verbosity

You can easily change the logging verbosity by tweaking the “root” log level present in the file bin/logback.xml. You can also tweak the verbosity for specific features. Below is an example with the root log level verbosity set to error and tracing enabled for alerting events:

<configuration scan="true">
...
<logger name="step.plugins.alerting" level="trace" />
...
<root level="error">
 <appender-ref ref="STDOUT" />
 <appender-ref ref="FILE" />
</root>
</configuration>

Audit logs

Security-relevant events such as user login/logout, session invalidation, and password changes are logged at loglevel info using the special logger AuditLogger.

Modification actions to entities (such as creation, update, deletion etc. of Automation Packages, Plans and other entities) can also be logged to this logger, by adjusting the controller configuration. Entity modifications logging is not enabled by default; to enable it, add the following configuration item to step.properties:

auditLog.logEntityModifications = true

Step Enterprise already ships a tailored log configuration which logs these events to the file audit-logger.log in the log/ directory.

You can increase the verbosity of the audit logger to trace to show all interactions with the Step controller:

<logger name="AuditLogger" level="trace" additivity="false">
    <appender-ref ref="AUDIT" />
</logger>

Agent logs

Java Agent

By default, the logs of the Java Agent are written to the file log/agent.log.

The default logging settings can be changed in the file bin/logback.xml.

.NET Agent

By default, the logs of the Java Agent are written to the file log/agent.log.

The default logging settings can be changed in the file bin/StepAgent.dll.config.