Skip to content

Commit 7d0f025

Browse files
committed
OBSDOCS-1330: Add the metrics refrence table for remote write
1 parent dfa0b0d commit 7d0f025

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/monitoring/troubleshooting-monitoring-issues.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="table-of-remote-write-metrics_{context}"]
7+
= Table of remote write metrics
8+
9+
The following table contains remote write and remote write-adjacent metrics with further description to help solve issues during remote write configuration.
10+
11+
[options="header"]
12+
|===
13+
| Metric | Description
14+
| `prometheus_remote_storage_highest_timestamp_in_seconds` | Shows the newest timestamp that Prometheus stored in the write-ahead log (WAL) for any sample.
15+
| `prometheus_remote_storage_queue_highest_sent_timestamp_seconds` | Shows the newest timestamp that the remote write queue successfully sent.
16+
| `prometheus_remote_storage_samples_retried_total` | The number of samples that remote write failed to send and had to resend to remote storage. A steady high rate for this metric indicates problems with the network or remote storage endpoint.
17+
| `prometheus_remote_storage_shards` | Shows how many shards are currently running for each remote endpoint.
18+
| `prometheus_remote_storage_shards_desired` | Shows the calculated needed number of shards based on the current write throughput and the rate of incoming versus sent samples.
19+
| `prometheus_remote_storage_shards_max` | Shows the maximum number of shards based on the current configuration.
20+
| `prometheus_remote_storage_shards_min` | Shows the minimum number of shards based on the current configuration.
21+
| `prometheus_tsdb_wal_segment_current` | The WAL segment file that Prometheus is currently writing new data to.
22+
| `prometheus_wal_watcher_current_segment` | The WAL segment file that each remote write instance is currently reading from.
23+
|===

observability/monitoring/configuring-the-monitoring-stack.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,8 @@ ifndef::openshift-dedicated,openshift-rosa[]
215215
* xref:../../nodes/pods/nodes-pods-secrets.adoc#nodes-pods-secrets-about_nodes-pods-secrets[Understanding secrets]
216216
endif::openshift-dedicated,openshift-rosa[]
217217

218+
include::modules/monitoring-table-of-remote-write-metrics.adoc[leveloffset=+2]
219+
218220
// Configuring labels for outgoing metrics
219221
include::modules/monitoring-adding-cluster-id-labels-to-metrics.adoc[leveloffset=+1]
220222
include::modules/monitoring-creating-cluster-id-labels-for-metrics.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)