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

Use metric-schema to report JVM Buffer Pool metrics #2018

Merged
merged 4 commits into from
Sep 12, 2024

Conversation

mpritham
Copy link
Contributor

Before this PR

We weren't using metric-schema when registering the JVM Buffer Pool metrics. Using metric-schema gives us some nice tooling, like markdown file generation allowing devs to find all published metrics easily.

After this PR

==COMMIT_MSG==
Use metric-schema to report JVM Buffer Pool metrics
==COMMIT_MSG==

Possible downsides?

N/A

@changelog-app
Copy link

changelog-app bot commented Sep 12, 2024

Generate changelog in changelog/@unreleased

What do the change types mean?
  • feature: A new feature of the service.
  • improvement: An incremental improvement in the functionality or operation of the service.
  • fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
  • break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
    and external consumers of the service's API (e.g. customer-written software or integrations).
  • deprecation: Advertises the intention to remove service functionality without any change to the
    operation of the service itself.
  • manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
    performing database surgery, ...) at the time of upgrade for it to succeed.
  • migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?
  • ❗The break and manual task changelog types will result in a major release!
  • 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
  • ✨ All others will result in a minor version release.

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

Use metric-schema to report JVM Buffer Pool metrics

Check the box to generate changelog(s)

  • Generate changelog entry

@mpritham mpritham marked this pull request as draft September 12, 2024 15:40
@mpritham mpritham force-pushed the pm/jvm-buffer-pool-metrics branch 2 times, most recently from efbfbf0 to 5e48fb1 Compare September 12, 2024 15:58
@mpritham mpritham force-pushed the pm/jvm-buffer-pool-metrics branch from 5e48fb1 to 98a4399 Compare September 12, 2024 15:59
@mpritham mpritham marked this pull request as ready for review September 12, 2024 15:59
JvmBuffersMetrics jvmBuffersMetrics = JvmBuffersMetrics.of(registry);
for (BufferPoolMXBean pool : ManagementFactory.getPlatformMXBeans(BufferPoolMXBean.class)) {
String poolName = pool.getName();
if (poolName.equals("direct")) {
Copy link
Contributor

Choose a reason for hiding this comment

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

If you want to be particularly defensive against nulls, you could do something like this:

Suggested change
if (poolName.equals("direct")) {
if ("direct".equals(poolName)) {

Or Objects.equals(poolName, "direct") which handles both values being null (although that's impossible for a constant string). I wouldn't expect getName to ever return null either, but we've seen crazier things...

Entirely up to you whether to change this :-]

Copy link
Contributor Author

@mpritham mpritham Sep 12, 2024

Choose a reason for hiding this comment

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

Ah good call. I'll change this to the first idea: "direct".equals(poolName) for the null protection.

Copy link
Contributor

@carterkozak carterkozak left a comment

Choose a reason for hiding this comment

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

Thanks!

@bulldozer-bot bulldozer-bot bot merged commit 772880f into develop Sep 12, 2024
5 checks passed
@bulldozer-bot bulldozer-bot bot deleted the pm/jvm-buffer-pool-metrics branch September 12, 2024 17:22
@autorelease3
Copy link

autorelease3 bot commented Sep 12, 2024

Released 0.93.0

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

Successfully merging this pull request may close these issues.

3 participants