You are viewing the RapidMiner Hub documentation for version 9.10 - Check here for latest version

Audit

RapidMiner Server provides the functionality to log certain activities of users. Those activities include

creating, updating or deleting connections and their related secret entries stored in RapidMiner Server,
creating, updating or deleting scheduled processes and
submitting or stopping jobs.

This behaviour is disabled by default. If you like to increase the verbosity of actions taken by users within RapidMiner Server, you have to enable the auditing functionality. Do so by adding audit.enabled = true to the <rapidminer-server-home>/configuration/execution.properties file within the RapidMiner Server home directory.

Additional information will now be added to the RapidMiner Server log, e.g.

User 'admin' has submitted a new job with ID '43c7ad28-79bc-42e8-8cc1-320892188343' (owner: 'admin') for the process location '/home/admin/Process'. Selected queue is 'DEFAULT'

Authentication Audit Logs

SAML Authentication utilizes the a log file location for auditing purposes, this is defaulted to the RapidMiner Server home /log directory. The file default name is authentication-audit.log.

The configs for this are under the <subsystem xmlns="urn:jboss:domain:logging:1.5"> section in the standalone.xml file.

Note: A RapidMiner server that is upgraded may not have this section, so user must manually add it.

Here is an example of what should be in the <subsystem xmlns="urn:jboss:domain:logging:1.5"> section. It is setup to create a new authentication-audit.log file every day and rotate the previous days logs to a file with a naming pattern of authentication-audit.log.yyy.MM-dd.

The logger being attached to the file-handler is the org.springframework.security.saml.log which is designed to log Spring SAML authentication messages, it can also be controlled from the local-security.properties file when it is setup with a SAML configuration.

Authentication Audit Logger Example

    <periodic-rotating-file-handler name="authentication-audit" autoflush="true">
            <formatter>
                    <named-formatter name="PATTERN"/>
            </formatter>
            <file relative-to="jboss.server.log.dir" path="authentication-audit.log"/>
            <suffix value=".yyyy-MM-dd"/>
            <append value="true"/>
    </periodic-rotating-file-handler>
    <logger category="org.springframework.security.saml.log">
            <level name="INFO"/>
            <handlers>
                    <handler name="authentication-audit"/>
            </handlers>
    </logger>

If values are changed/added RapidMiner server must be restarted.

See JBoss Best Practices on Logging for debug help.

Categories

Versions

Audit

Authentication Audit Logs