Skip to content
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

Add new metrics to aid troubleshooting tombstone convergence. #4231

Merged
merged 2 commits into from
Jun 2, 2021

Conversation

stevesg
Copy link
Contributor

@stevesg stevesg commented May 28, 2021

What this PR does:
Add new metrics to aid troubleshooting tombstone convergence.

  • memberlist_client_kv_store_value_tombstones
    Expose the number of tombstones currently in the value for each key
    in the store. If the tombstones are being propagated as expected,
    then each instance should have the same value for this metric.
  • memberlist_client_kv_store_value_tombstones_removed_total
    Count the number of tombstones which have been removed because they
    aged out. This can be used to troubleshoot whether tombstones are
    being removed too soon (i.e. before the state is converged).
  • memberlist_client_messages_to_broadcast_dropped_total
    Count occurrences of messages being quietly dropped when they were
    expecting to have been broadcast. As log messages already existed
    for these events, the logs have had the key field added instead
    of exposing per-key metrics, for consistency with other metrics
    of this nature in the package.

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

@stevesg stevesg force-pushed the memberlist-metrics branch 2 times, most recently from 3b45a7d to 91cb47b Compare May 28, 2021 18:44
@stevesg stevesg marked this pull request as ready for review May 28, 2021 20:43
Copy link
Contributor

@pstibrany pstibrany left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

Copy link
Contributor

@pracucci pracucci left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! (modulo Peter's comment)

stevesg added 2 commits June 2, 2021 09:45
- `memberlist_client_kv_store_value_tombstones`
    Expose the number of tombstones currently in the value for each key
    in the store. If the tombstones are being propagated as expected,
    then each instance should have the same value for this metric.
- `memberlist_client_kv_store_value_tombstones_removed_total`
    Count the number of tombstones which have been removed because they
    aged out. This can be used to troubleshoot whether tombstones are
    being removed too soon (i.e. before the state is converged).
- `memberlist_client_messages_to_broadcast_dropped_total`
    Count occurrences of messages being quietly dropped when they were
    expecting to have been broadcast. As log messages already existed
    for these events, the logs have had the `key` field added instead
    of exposing per-key metrics, for consistency with other metrics
    of this nature in the package.

Signed-off-by: Steve Simpson <[email protected]>
Signed-off-by: Steve Simpson <[email protected]>
@stevesg stevesg force-pushed the memberlist-metrics branch from 1b0826f to dfb80dc Compare June 2, 2021 07:45
@pstibrany pstibrany enabled auto-merge (squash) June 2, 2021 07:55
@pstibrany pstibrany merged commit fc8fa31 into cortexproject:master Jun 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants