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

Generate TaggedMetricRegistry registry() method #1192

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

schlosna
Copy link
Contributor

Before this PR

The generated metrics classes do not expose a mechanism to interact with the underlying TaggedMetricRegistry. This is needed for example to unregister metrics.

After this PR

==COMMIT_MSG==
Generate TaggedMetricRegistry registry() method
==COMMIT_MSG==

Possible downsides?

This breaks encapsulation of the TaggedMetricRegistry

@changelog-app
Copy link

changelog-app bot commented Jun 10, 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

Generate TaggedMetricRegistry registry() method

Check the box to generate changelog(s)

  • Generate changelog entry

@carterkozak
Copy link
Contributor

I could go either way on this, given it's uncommon, it may be reasonable to expect code which unregisters metrics to hold a reference to the original registry as well as the generated *Metrics wrapper.

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.

2 participants