Skip to content

Commit f21aa5c

Browse files
Merge pull request #2119 from zhivko-kirishev-redis/RDSC-3989-add-information-for-new-performance-metrics
RDSC-3989: Add information for new performance metrics
2 parents fc3fc0e + aabebfe commit f21aa5c

File tree

2 files changed

+41
-1
lines changed

2 files changed

+41
-1
lines changed

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

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,25 @@ 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+
| **Processor Performance Total Metrics** | | | |
117+
| `rdi_processed_batches_total` | Counter | Total number of processed batches | Informational - use for data ingestion and load tracking |
118+
| `rdi_processor_batch_size_total` | Counter | Total batch size across all processed batches | Informational - use for throughput analysis |
119+
| `rdi_processor_read_time_ms_total` | Counter | Total read time in milliseconds across all batches | Informational - use for performance analysis |
120+
| `rdi_processor_transform_time_ms_total` | Counter | Total transform time in milliseconds across all batches | Informational - use for performance analysis |
121+
| `rdi_processor_write_time_ms_total` | Counter | Total write time in milliseconds across all batches | Informational - use for performance analysis |
122+
| `rdi_processor_process_time_ms_total` | Counter | Total process time in milliseconds across all batches | Informational - use for performance analysis |
123+
| `rdi_processor_ack_time_ms_total` | Counter | Total acknowledgment time in milliseconds across all batches | Informational - use for performance analysis |
124+
| `rdi_processor_total_time_ms_total` | Counter | Sum of the total `read_time`, `process_time` and `ack_time` values in milliseconds across all batches | Informational - use for performance analysis |
125+
| `rdi_processor_rec_per_sec_total` | Gauge | Total records per second across all batches | Informational - use for throughput analysis |
126+
| **Processor Performance Last Batch Metrics** | | | |
127+
| `rdi_processor_batch_size_last` | Gauge | Last batch size processed | Informational - use for real-time monitoring |
128+
| `rdi_processor_read_time_ms_last` | Gauge | Last batch read time in milliseconds | Informational - use for real-time performance monitoring |
129+
| `rdi_processor_transform_time_ms_last` | Gauge | Last batch transform time in milliseconds | Informational - use for real-time performance monitoring |
130+
| `rdi_processor_write_time_ms_last` | Gauge | Last batch write time in milliseconds | Informational - use for real-time performance monitoring |
131+
| `rdi_processor_process_time_ms_last` | Gauge | Last batch process time in milliseconds | Informational - use for real-time performance monitoring |
132+
| `rdi_processor_ack_time_ms_last` | Gauge | Last batch acknowledgment time in milliseconds | Informational - use for real-time performance monitoring |
133+
| `rdi_processor_total_time_ms_last` | Gauge | Last batch total time in milliseconds | Informational - use for real-time performance monitoring |
134+
| `rdi_processor_rec_per_sec_last` | Gauge | Last batch records per second | Informational - use for real-time throughput monitoring |
116135

117136
{{< note >}}
118137
**Additional information about stream processor metrics:**
@@ -121,11 +140,14 @@ RDI reports with their descriptions.
121140
- Metrics with the `_created` suffix are automatically generated by Prometheus for counters and gauges to track when they were first created.
122141
- The `rdi_incoming_entries` metric provides a detailed breakdown for each data source by operation type.
123142
- The `rdi_stream_event_latency_ms` metric helps monitor data freshness and processing delays.
143+
- The processor performance metrics are divided into two categories:
144+
- **Total metrics**: Accumulate values across all processed batches for historical analysis
145+
- **Last batch metrics**: Show real-time performance data for the most recently processed batch
124146
{{< /note >}}
125147

126148
## Recommended alerting strategy
127149

128-
The alerting strategy described in the sections below focuses on system failures and data integrity issues that require immediate attention. Most ther metrics are informational, so you should monitor them for trends rather than trigger alerts.
150+
The alerting strategy described in the sections below focuses on system failures and data integrity issues that require immediate attention. Most other metrics are informational, so you should monitor them for trends rather than trigger alerts.
129151

130152
### Critical alerts (immediate response required)
131153

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)