RS 8.2.x release docs#3640
Conversation
Added a new metric for total coordinator dispatch time in ms. Co-authored-by: Rachel Elledge <86307637+rrelledge@users.noreply.github.com>
…g with new API examples
|
|
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
|
|
||
| | Port | Process name | Usage | | ||
| |------|--------------|-------| | ||
| | 3357 | reconciliation_tree_grpc | Internal communication | |
There was a problem hiding this comment.
Duplicate port 3357 table
Low Severity
The reserved-ports section lists port 3357 (reconciliation_tree_grpc) twice in back-to-back identical markdown tables, which reads like an accidental copy-paste in new 8.2.x release notes.
Reviewed by Cursor Bugbot for commit 462c3aa. Configure here.
|
|
||
| - _audit\_reconnect\_max\_attempts_ defines the maximum number of attempts to reconnect. Default is 0. (infinite) | ||
| - _audit\_reconnect\_max\_attempts_ sets the maximum number of reconnection attempts. Default is 0 (infinite). | ||
|
|
There was a problem hiding this comment.
Missing a description for the "audit_queue_max_bytes" field:
Maximum amount of audit data that can wait in the outgoing audit queue. When the queue has no remaining capacity, new audit records can be dropped.
| {{< /multitabs >}} | ||
|
|
||
| The socket file and path must be accessible by the user and group running Redis Software. | ||
|
|
There was a problem hiding this comment.
Add a section for "Audit modes":
Auditing is configured independently for each database with audit_settings.audit_mode.
Maybe add a 2-column table for "value" and "Description":
disabled: Disables connection, authentication, and command audit records for the database. This is the default mode.
connection: Audits database connection, disconnection, and authentication events only.
connection_and_crud: Audits connection and authentication events and individual database commands.
Command auditing cannot be enabled without connection auditing. The connection_and_crud mode always includes the connection and authentication events generated by connection mode.
| | `10` | The command failed. The `error` field contains the returned error message. | | ||
|
|
||
| ## Monitor auditing metrics | ||
|
|
There was a problem hiding this comment.
Let's incorporate the below content in the metrics section (or any other location you think is better...):
Audit delivery during sink interruptions
If the audit destination becomes unavailable, Redis Software continues serving database traffic and attempts to reconnect according to audit_reconnect_interval and audit_reconnect_max_attempts.
Audit records can wait in the outgoing audit queue while delivery is unavailable. The amount of queued data is limited by audit_queue_max_bytes. Redis Software can discard audit records in the following situations:
- The outgoing queue has reached its configured capacity.
- A single audit record exceeds the supported queue or record-size limit.
- No active connection to the audit destination is available when the record must be delivered.
- An attempt to send the record fails.
- Queuing is disabled or unavailable.
Audit delivery is best effort. Database operations are not delayed or rejected because audit records cannot be delivered.
Use the following metrics to identify delivery problems:
- audit_sink_pending_bytes indicates how much audit data is currently waiting to be sent.
- audit_sink_dropped_messages and audit_sink_dropped_bytes indicate total audit data discarded before delivery.
- audit_sink_dropped_queue_full_messages indicates that the outgoing queue did not have enough capacity.
- audit_sink_dropped_record_too_large_messages indicates that an individual audit record exceeded the permitted size.
- audit_sink_reconnect_attempts_exhausted indicates that the configured reconnect-attempt limit was reached.
| {{</note>}} | ||
|
|
||
| When a tracked event occurs, Redis Software sends a notification over TCP to the address and port you configure when you enable auditing. Notifications arrive in near real time for an external listener to consume, such as a TCP listener, third-party service, or related utility. | ||
|
|
There was a problem hiding this comment.
State the tool-agnostic integration model explicitly. The page lists example listeners, but does not clearly say that Redis Software does not require or enforce any particular SIEM/DAM vendor.
yoavredis
left a comment
yoavredis
left a comment
There was a problem hiding this comment.
@kaitlynmichael I've added comments for auditing, 10x
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.
There are 2 total unresolved issues (including 1 from previous review).
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit c8c9162. Configure here.
|
|
||
| Make sure the following ports are open before upgrading Redis Software. | ||
|
|
||
| The following port was added as a reserved port in Redis Software version 8.0.18; however, it is optional instead of reserved in Redis Software version 8.0.20-44: |
There was a problem hiding this comment.
Wrong optional-port release version
Medium Severity
The 8.2.x release index states port 3357 became optional in version 8.0.20-44, while the 8.2.0 release notes in the same PR say it became optional in “this release” (8.2). Those statements cannot both be accurate for the same change.
Additional Locations (1)
Reviewed by Cursor Bugbot for commit c8c9162. Configure here.
5 participants
These are drafts and this PR is still a work in progress.
Note
Low Risk
Documentation-only changes with no runtime impact; reviewers should still validate breaking-change and security guidance (auditing, REST auth, module upload defaults) before GA.
Overview
Adds Redis Software 8.2.x documentation: draft 8.2.0 release notes (highlights, breaking changes, deprecations, CVE lists), an 8.2.x release index, and updates to product lifecycle, supported platforms, upgrade paths, and bundled DB versions (8.2.0 row, default Redis 8.6).
Expands operational and API coverage for 8.2 capabilities: per-database
audit_settings(connection + CRUD auditing, filters, metrics) with a major rewrite of audit-events;resourceson roles for db_member/db_viewer scoping; new disable basic authentication guide andcontrol_plane_basic_authentication/allow_modules_uploadcluster fields;gradual_sync_policyon databases; richer database availability /bdb_unavailable_*error documentation; and a new RediSearch v2 Prometheus metricredis_server_search_total_coord_dispatch_time_ms.Reviewed by Cursor Bugbot for commit 8f889a5. Bugbot is set up for automated code reviews on this repo. Configure here.