-
Notifications
You must be signed in to change notification settings - Fork 19
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
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for frosty-curran-1fc0c4 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
…ter so that the customer can use any Prometheus compatible monnitoring tool.
There was a problem hiding this 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. |
There was a problem hiding this comment.
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.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would a heading help?
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 |
There was a problem hiding this comment.
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
https://hazelcast.atlassian.net/browse/MC-3171
Related platform docs changes: hazelcast/hz-docs#1508