Cassandra Documentation

Version:

enableauditlog

Usage

NAME
        nodetool enableauditlog - Enable the audit log

SYNOPSIS
        nodetool [(-h <host> | --host <host>)] [(-p <port> | --port <port>)]
                [(-pp | --print-port)] [(-pw <password> | --password <password>)]
                [(-pwf <passwordFilePath> | --password-file <passwordFilePath>)]
                [(-u <username> | --username <username>)] enableauditlog
                [--archive-command <archive_command>] [--blocking <blocking>]
                [--excluded-categories <excluded_categories>]
                [--excluded-keyspaces <excluded_keyspaces>]
                [--excluded-users <excluded_users>]
                [--included-categories <included_categories>]
                [--included-keyspaces <included_keyspaces>]
                [--included-users <included_users>] [--logger <logger>]
                [--max-archive-retries <archive_retries>]
                [--max-log-size <max_log_size>] [--max-queue-weight <max_queue_weight>]
                [--roll-cycle <roll_cycle>]

OPTIONS
        --archive-command <archive_command>
            Command that will handle archiving rolled audit log files. Format is
            "/path/to/script.sh %path" where %path will be replaced with the
            file to archive Enable this by setting the
            audit_logging_options.allow_nodetool_archive_command: true in the
            config.

        --blocking <blocking>
            If the queue is full whether to block producers or drop samples
            [true|false].

        --excluded-categories <excluded_categories>
            Comma separated list of Audit Log Categories to be excluded for
            audit log. If not set the value from cassandra.yaml will be used

        --excluded-keyspaces <excluded_keyspaces>
            Comma separated list of keyspaces to be excluded for audit log. If
            not set the value from cassandra.yaml will be used

        --excluded-users <excluded_users>
            Comma separated list of users to be excluded for audit log. If not
            set the value from cassandra.yaml will be used

        -h <host>, --host <host>
            Node hostname or ip address

        --included-categories <included_categories>
            Comma separated list of Audit Log Categories to be included for
            audit log. If not set the value from cassandra.yaml will be used

        --included-keyspaces <included_keyspaces>
            Comma separated list of keyspaces to be included for audit log. If
            not set the value from cassandra.yaml will be used

        --included-users <included_users>
            Comma separated list of users to be included for audit log. If not
            set the value from cassandra.yaml will be used

        --logger <logger>
            Logger name to be used for AuditLogging. Default BinAuditLogger. If
            not set the value from cassandra.yaml will be used

        --max-archive-retries <archive_retries>
            Max number of archive retries.

        --max-log-size <max_log_size>
            How many bytes of log data to store before dropping segments. Might
            not be respected if a log file hasn't rolled so it can be deleted.

        --max-queue-weight <max_queue_weight>
            Maximum number of bytes of query data to queue to disk before
            blocking or dropping samples.

        -p <port>, --port <port>
            Remote jmx agent port number

        -pp, --print-port
            Operate in 4.0 mode with hosts disambiguated by port number

        -pw <password>, --password <password>
            Remote jmx agent password

        -pwf <passwordFilePath>, --password-file <passwordFilePath>
            Path to the JMX password file

        --roll-cycle <roll_cycle>
            How often to roll the log file (MINUTELY, HOURLY, DAILY).

        -u <username>, --username <username>
            Remote jmx agent username