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

DOC-353 Prometheus metrics standardization #434

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

Conversation

Rob-Hazelcast
Copy link
Contributor

@Rob-Hazelcast Rob-Hazelcast commented Jan 29, 2025

Copy link

netlify bot commented Jan 29, 2025

Deploy Preview for frosty-curran-1fc0c4 ready!

Name Link
🔨 Latest commit e9ec81c
🔍 Latest deploy log https://app.netlify.com/sites/frosty-curran-1fc0c4/deploys/67a25a24ff87490008273c02
😎 Deploy Preview https://deploy-preview-434--frosty-curran-1fc0c4.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@jgardiner68 jgardiner68 self-requested a review February 4, 2025 14:23
…ter so that the customer can use any Prometheus compatible monnitoring tool.
@hazelcast hazelcast deleted a comment from pollett Feb 4, 2025
Copy link
Contributor

@oliverhowell oliverhowell left a comment

Choose a reason for hiding this comment

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

Looks good to me - some suggestions but only for consideration so approving in advance


The updated metrics are based on link:https://prometheus.io/docs/practices/naming/[Prometheus conventions].

The following examples illustrate the differences between the original and updated metrics.
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if an explicit hint is needed e.g.

Suggested change
The following examples illustrate the differences between the original and updated metrics.
The following examples illustrate the differences between the original and updated metrics (in each example, the original metric is shown first and then the updated metric).

I might be overthinking it but thinking about Kapa consuming this content and also the 'rename and remove...' tense does read a little like a direction rather than something that has changed, if that makes sense.


By default, Management Center exposes both the original metrics and the updated versions. Existing integrations will therefore continue to work, but you should consider the original metrics deprecated and plan to migrate to the updated versions. You can optionally xref:config[change which set of metrics is exposed].

Management Center makes the following changes to metrics exposed by Hazelcast clusters.
Copy link
Contributor

Choose a reason for hiding this comment

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

Would a heading help?

Suggested change
Management Center makes the following changes to metrics exposed by Hazelcast clusters.
== Changes to metrics
Management Center makes the following changes to metrics exposed by Hazelcast clusters.


== Disabling Timestamp
== Disabling Timestamps
Copy link
Contributor

Choose a reason for hiding this comment

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

I was reticent to suggest changing the headings away from gerunds but if you're fixing grammar you might want to consider it here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants