Skip to content

Commit b17f5c4

Browse files
Update the RDI openapi and observability documentation by adding information for the newly exposed processor performance metrics
1 parent ea3c563 commit b17f5c4

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

content/integrate/redis-data-integration/observability.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,9 @@ RDI reports with their descriptions.
113113
| `monitor_time_elapsed_created` | Gauge | Timestamp when the monitor time elapsed counter was created | Informational - no alerting needed |
114114
| `rdi_incoming_entries` | Gauge | Count of incoming events by `data_source` and `operation` type (pending, inserted, updated, deleted, filtered, rejected) | Informational - monitor for trends, alert only on "rejected" > 0 |
115115
| `rdi_stream_event_latency_ms` | Gauge | Latency in milliseconds of the oldest event in each data stream, labeled by `data_source` | Informational - monitor based on business SLA requirements |
116+
| `rdi_processed_batches_total` | Counter | Count of the total processed batches | Informational - use for data ingestion and load tracking |
117+
| `rdi_processed_batches_created` | Gauge | Timestamp when the processed batches counter was created | Informational - no alerting needed |
118+
| `rdi_processor_performance_batch_avg` | Gauge | Average processor performance for all batches | Informational - use for data ingestion tracking and debugging purposes |
116119

117120
{{< note >}}
118121
**Additional information about stream processor metrics:**
@@ -121,6 +124,7 @@ RDI reports with their descriptions.
121124
- Metrics with the `_created` suffix are automatically generated by Prometheus for counters and gauges to track when they were first created.
122125
- The `rdi_incoming_entries` metric provides a detailed breakdown for each data source by operation type.
123126
- The `rdi_stream_event_latency_ms` metric helps monitor data freshness and processing delays.
127+
- The `rdi_processor_performance_batch_avg` metric provides detailed performance insights.
124128
{{< /note >}}
125129

126130
## Recommended alerting strategy

content/integrate/redis-data-integration/reference/api-reference/openapi.json

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4627,6 +4627,22 @@
46274627
10.5
46284628
]
46294629
},
4630+
"transform_time_avg": {
4631+
"type": "number",
4632+
"minimum": 0.0,
4633+
"title": "Transform Time Avg",
4634+
"examples": [
4635+
2.3
4636+
]
4637+
},
4638+
"write_time_avg": {
4639+
"type": "number",
4640+
"minimum": 0.0,
4641+
"title": "Write Time Avg",
4642+
"examples": [
4643+
4.4
4644+
]
4645+
},
46304646
"process_time_avg": {
46314647
"type": "number",
46324648
"minimum": 0.0,
@@ -4665,6 +4681,8 @@
46654681
"total_batches",
46664682
"batch_size_avg",
46674683
"read_time_avg",
4684+
"transform_time_avg",
4685+
"write_time_avg",
46684686
"process_time_avg",
46694687
"ack_time_avg",
46704688
"total_time_avg",

0 commit comments

Comments
 (0)