-
Notifications
You must be signed in to change notification settings - Fork 234
DOC-5338: RDI enchance observability page with more metrics information #1701
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC-5338: RDI enchance observability page with more metrics information #1701
Conversation
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR enhances the observability documentation page for RDI by adding detailed metrics tables and alerting recommendations.
- Added a collector metrics table with descriptions and alerting guidelines.
- Introduced a second table covering stream processor metrics with detailed contextual notes.
- Updated the recommended alerting strategy section for critical and informational monitoring.
Comments suppressed due to low confidence (3)
content/integrate/redis-data-integration/observability.md:110
- [nitpick] Consider clarifying which specific states for 'rdi_engine_state' should trigger a critical alert to eliminate ambiguity for users.
| `rdi_engine_state` | Gauge | Current state of the RDI engine with labels for `state` (e.g., STARTED, RUNNING) and `sync_mode` (e.g., SNAPSHOT, STREAMING) | **Critical Alert**: Alert if state indicates failure or error condition |
content/integrate/redis-data-integration/observability.md:106
- [nitpick] Consider expanding the description for 'incoming_records_created' to explain its purpose and usage, since reporting a timestamp as a gauge might be confusing for some users.
| `incoming_records_created` | Gauge | Timestamp when the incoming records counter was created | Informational - no alerting needed |
content/integrate/redis-data-integration/observability.md:55
- [nitpick] Metric naming conventions differ between the first table (CamelCase) and the second table (snake_case). Consider aligning these conventions to avoid potential confusion.
| **ChangesApplied** | Counter | Total number of schema changes applied during recovery and runtime | Informational - monitor for trends |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few minor suggestions and questions, but they're easy to fix, so I'll approve. Great addition to the info in this page :-)
I used some AI magic and a few sources - Example metrics from a running RDI instance, the codebase, Debezium docs, etc.
I think the format is good, but the alerting recommendations I'm not sure if the alerting recommendations are correct.