To enable the automatic audit function, you must have a PostgreSQL database instance, and there are several properties that you must add to platform.conf.

Note!

The PostgreSQL database must be running before you start the Platform.

Create a Database to Store Messages

In your PostgreSQL database instance, you must create a database where you can store the messages sent to the uptime table and/or the throughput table. You enter the name of the database as the value for the property mz.audit.db.database. The user specified in the property mz.audit.db.user must have access to this database. See the Properties section below.

Properties

There are several properties that you must add to platform.conf using the topo command:

$ mzsh topo set topo://container:main1/pico:platform '{
    template:mz.standard-platform
    config {
        properties {
            mz.audit.customerid :"<customer id>"
            mz.audit.uptime.interval :<interval>
            mz.audit.throughput.interval :<interval>
            mz.audit.db.database :"<name of database>"
            mz.audit.db.host :"<host>"
            mz.audit.db.port :<port>
            mz.audit.db.user :"<db username>"
            mz.audit.db.password :"<encrypted db password>"
        }
    }
}'

If the properties listed below are not set, automatic audit is disabled.

The configuration includes the following properties:

Property	Description
mz.audit.customerid	Default value: " " Use this property to specify the relevant customer ID. The customer ID must be unique.
mz.audit.uptime.interval	Default value: " " Use this property to specify how often the connection to the PostgreSQL database instance is checked. The time interval is in seconds. If the value for this property is set to 0 or less, automatic audit for uptime is disabled.
mz.audit.throughput.interval	Default value:" " Use this property to specify how often the average throughput per second for the running workflows is written to the PostgreSQL database instance. The time interval is in seconds. If the value for this property is set to 0 or less, automatic audit for throughput is disabled.
mz.audit.db.database	Default value:" " Use this property to name a database where you can store the messages sent to the uptime table and/or the throughput table. The user specified in the property `mz.audit.db.user` must have access to this database.
mz.audit.db.host	Default value: " " Use this property to specify the host for the relevant PostgreSQL database instance.
mz.audit.db.port	Default value: " " Use this property to specify the port for the relevant PostgreSQL database instance.
mz.audit.db.user	Default value: " " Use this property to specify the username for the relevant PostgreSQL database instance.
mz.audit.db.password	Default value: " " Use this property to specify the password for the relevant PostgreSQL database instance. You must encrypt the password using the command `mzsh encryptpassword`, see 2.1.4 encryptpassword in the Command Line Tool User's Guide.

Example - Automatic Audit configuration in platform.conf

mz.audit.customerid="cust1"
mz.audit.uptime.interval=3
mz.audit.throughput.interval=60
mz.audit.db.database="postgresql"
mz.audit.db.host="localhost"
mz.audit.db.port=5432
mz.audit.db.user="dbusername"
mz.audit.db.password="DR_DEFAULT_KEY-9E5885A757778BFB153C6C877A7D9A86"

13.1 Automatic Audit Configuration

Create a Database to Store Messages

Properties