Auditing and Logging Configuration
This guide describes the configuration properties for auditing and logging across SAMO services.
Kafka Configuration
| Property | Type | Required | Description | Example value |
|---|---|---|---|---|
kafka.url | string | true | Kafka cluster URL | server.company.local:10092 |
audit.kafka.topic | string | false | Kafka topic name for auditing messages, default: audit | dev_audit |
logging.kafka.topic | string | false | Kafka topic name for logging messages, default: logs | dev_logs |
logging.[logger].writeToKafka | boolean | false | Flag to indicate which log messages should be sent to Kafka | true, false |
LIDS AS
Environment Properties
| Property | Type | Required | Description | Example value |
|---|---|---|---|---|
lids.audit.type | string | true | Output source of auditing | kafka, database |
lids.audit.actions | string | true | List of actions which will be audited. Instead of list, value all can be used. | authentication,features |
XML Configuration (Future work)
This configuration is enabled if value features is present in lids.audit.actions property. In that case, audit.xml file under /lids-as/extensions in metadata should be created.
info
This feature is planned for future implementation.
<?xml version="1.0" encoding="UTF-8"?>
<ber:audit xmlns="http://www.berit.com/ber">
<ber:version>
<ber:metadata>1</ber:metadata>
<ber:minClient>?</ber:minClient>
<ber:minAS>?</ber:minAS>
</version>
<ber:featureTypeArray>
<ber:featureType xlink:href="model.xml#ftexample">
<ber:operations>
<ber:select/>
<ber:insert/>
<ber:update/>
<ber:delete/>
</ber:operations>
</ber:featureType>
</ber:featureTypeArray>
</ber:audit>
Gateway
Environment Properties
| Property | Type | Required | Description | Example value |
|---|---|---|---|---|
gateway.audit.type | string | true | Output source of auditing | kafka, database |
gateway.audit.actions | string | true | List of actions which will be audited. Instead of list, value all can be used. | authentication |
Security Server
Environment Properties
| Property | Type | Required | Description | Example value |
|---|---|---|---|---|
security.audit.type | string | true | Output source of auditing | kafka, database |
security.audit.actions | string | true | List of actions which will be audited. Instead of list, value all can be used. | authentication,accessRightsModification,userModification,userImport |
User Service
Environment Properties
| Property | Type | Required | Description | Example value |
|---|---|---|---|---|
userService.audit.type | string | true | Output source of auditing | kafka, database |
userService.audit.actions | string | true | List of actions which will be audited. Instead of list, value all can be used. | authentication |
License Server
Environment Properties
| Property | Type | Required | Description | Example value |
|---|---|---|---|---|
licenseServer.audit.type | string | true | Output source of auditing | kafka, database |
licenseServer.audit.actions | string | true | List of actions which will be audited. Instead of list, value all can be used. | authentication |