redis / redis/docs

Feedback: Audit database commands and connections

Open
#3,902 0 comments 0 reactions 1 assignee View on GitHub

@kaitlynmichael is already working on this.

Since Aug 31, 2026.

Dominant language
Java
Stars
79
Forks
361
Avg merge
22h 53m
Merged PRs (30d)
181

Description

Page https://redis.io/docs/latest/operate/rs/security/audit-events

Hi @kaitlynmichael,

I found a few more misalignments between the API examples and the rladmin examples.
Pasting here the correct rladmin snippets:

  • Configure cluster audit destination:
    The rladmin example was missing the sixth field.
    Here is the full snippet:
    rladmin cluster config auditing db_conns \
    audit_protocol TCP \
    audit_address audit-sink.example.com \
    audit_port \
    audit_reconnect_interval \
    audit_reconnect_max_attempts \
    audit_queue_max_bytes

  • Enable command and connection auditing
    Here is the full rladmin snippet:
    To enable command and connection auditing and configure filters using rladmin:
    rladmin tune db db: audit_settings username_filter usernames application-user
    rladmin tune db db: audit_settings username_filter filter_type inclusive
    rladmin tune db db: audit_settings username_filter allow_while_username_unknown disabled
    rladmin tune db db: audit_settings username_filter enabled enabled
    rladmin tune db db: audit_settings source_ip_filter ip_addresses ""
    rladmin tune db db: audit_settings source_ip_filter cidr_ranges 10.20.0.0/16
    rladmin tune db db: audit_settings source_ip_filter filter_type inclusive
    rladmin tune db db: audit_settings source_ip_filter enabled enabled
    rladmin tune db db: audit_settings max_total_key_bytes 131072
    rladmin tune db db: audit_settings audit_mode connection_and_crud

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.