From 42a141cf34a57bc1289abd241ef1eec7db2767fb Mon Sep 17 00:00:00 2001 From: "Luis (LT) Carbonell" Date: Tue, 10 Oct 2023 17:00:34 -0400 Subject: [PATCH] Update Telemetry Docs (#23535) * update remote wal docs * Update website/content/partials/telemetry-metrics/vault/replication/fsm/last_remote_wal.mdx Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> --------- Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com> --- website/content/docs/internals/telemetry/metrics/all.mdx | 2 ++ .../docs/internals/telemetry/metrics/availability.mdx | 2 ++ .../vault/replication/fsm/last_remote_wal.mdx | 7 ++++++- .../vault/replication/fsm/last_upstream_remote_wal.mdx | 5 +++++ 4 files changed, 15 insertions(+), 1 deletion(-) create mode 100644 website/content/partials/telemetry-metrics/vault/replication/fsm/last_upstream_remote_wal.mdx diff --git a/website/content/docs/internals/telemetry/metrics/all.mdx b/website/content/docs/internals/telemetry/metrics/all.mdx index f3258afd5729..7293d144b12c 100644 --- a/website/content/docs/internals/telemetry/metrics/all.mdx +++ b/website/content/docs/internals/telemetry/metrics/all.mdx @@ -538,6 +538,8 @@ alphabetic order by name. @include 'telemetry-metrics/vault/replication/fsm/last_remote_wal.mdx' +@include 'telemetry-metrics/vault/replication/fsm/last_upstream_remote_wal.mdx' + @include 'telemetry-metrics/vault/replication/merkle/commit_index.mdx' @include 'telemetry-metrics/vault/replication/merklediff.mdx' diff --git a/website/content/docs/internals/telemetry/metrics/availability.mdx b/website/content/docs/internals/telemetry/metrics/availability.mdx index 52d957106352..90c9d6593cd1 100644 --- a/website/content/docs/internals/telemetry/metrics/availability.mdx +++ b/website/content/docs/internals/telemetry/metrics/availability.mdx @@ -73,6 +73,8 @@ your Vault instance. Enterprise installations also include @include 'telemetry-metrics/vault/replication/fsm/last_remote_wal.mdx' +@include 'telemetry-metrics/vault/replication/fsm/last_upstream_remote_wal.mdx' + @include 'telemetry-metrics/vault/replication/merkle/commit_index.mdx' @include 'telemetry-metrics/vault/replication/merklediff.mdx' diff --git a/website/content/partials/telemetry-metrics/vault/replication/fsm/last_remote_wal.mdx b/website/content/partials/telemetry-metrics/vault/replication/fsm/last_remote_wal.mdx index ee0cab26459c..40c5834c747a 100644 --- a/website/content/partials/telemetry-metrics/vault/replication/fsm/last_remote_wal.mdx +++ b/website/content/partials/telemetry-metrics/vault/replication/fsm/last_remote_wal.mdx @@ -2,4 +2,9 @@ Metric type | Value | Description ----------- | ------- | ----------- -gauge | number | Index of the last remote write-ahead log \ No newline at end of file +gauge | number | Index of the last remote write-ahead log. + + + + Standby nodes do not emit `last_remote_wal` details. + diff --git a/website/content/partials/telemetry-metrics/vault/replication/fsm/last_upstream_remote_wal.mdx b/website/content/partials/telemetry-metrics/vault/replication/fsm/last_upstream_remote_wal.mdx new file mode 100644 index 000000000000..859a83cbb207 --- /dev/null +++ b/website/content/partials/telemetry-metrics/vault/replication/fsm/last_upstream_remote_wal.mdx @@ -0,0 +1,5 @@ +### vault.replication.fsm.last_upstream_remote_wal ((#vault-replication-fsm-last_upstream_remote_wal)) + +Metric type | Value | Description +----------- | ------- | ----------- +gauge | number | Index of the last remote WAL segment received from the upstream cluster by the local cluster leader.