• Documentation
  • Tutorials
  • Blogs
  • Product

What's on this Page

  • Controller logs
    • Verbosity
    • Audit logs
  • Agent logs
    • Java Agent
    • .NET Agent
  • Step
  • Set up Step
  • Configuration
  • Logging
Categories: CONFIGURATION
This article references one of our previous releases, click here to go to our latest version instead.

Logging

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

To customize the logback configuration using our Helm chart, refer to this documentation

Controller logs

Per 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 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 using the special logger AuditLogger.

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

Per 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

Per 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.

  • Home
  • Whats new?
  • Set up
    • Requirements
    • Download
    • Installation
    • Configuration
      • Important settings
      • Logging
      • Identity management
      • Licensing settings
      • SSL settings
      • Time Series Configuration
      • Customization
      • Encryption Manager
      • Agent configuration
      • Agent provisioning configuration
  • Administration
  • SaaS guide
  • User guide
  • Developer guide
  • DevOps
  • Plugins
  • Libraries
Step Logo
    • Documentation
    • Tutorials
    • Blogs
    • Product
    • Home
    • Whats new?
    • Set up
      • Requirements
      • Download
      • Installation
      • Configuration
        • Important settings
        • Logging
        • Identity management
        • Licensing settings
        • SSL settings
        • Time Series Configuration
        • Customization
        • Encryption Manager
        • Agent configuration
        • Agent provisioning configuration
    • Administration
    • SaaS guide
    • User guide
    • Developer guide
    • DevOps
    • Plugins
    • Libraries