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

Separate MeterFilter from Meters #34

Merged
merged 6 commits into from
Jun 11, 2024

Conversation

runeflobakk
Copy link
Member

@runeflobakk runeflobakk commented Jun 6, 2024

The MeterFilter which add the common tag application="YourApp" to all meters is removed from the ApplicationInfoMetrics, and instead must be configured separately when initializing your MeterRegistry in order to ensure the filter is configured before any bound Meter.

This allows for some flexibility. E.g to actually configure the filter or not:

MeterFilters
    .tryIncludeApplicationNameCommonTag()
    .ifPresentOrElse(
        meterRegistry.config()::meterFilter,
        () -> LOG.warn("Unable to include application name common tag in MeterRegistry"));

Alternatively if you do not care if the filter was configured or not, and don't need it logged:

MeterFilters
    .tryIncludeApplicationNameCommonTag().ifPresent(meterRegistry.config()::meterFilter)

Or resolve to a fallback filter, should the application name discovery from the MANIFEST.MF fail:

var applicationCommonTag = MeterFilters
    .tryIncludeApplicationNameCommonTag()
    .orElseGet(() -> MeterFilters.includeApplicationNameCommonTag("your-application"));
meterRegistry.config().meterFilter(applicationCommonTag);

Or You may also simply do this, and avoid all magic discovery, should you prefer to avoid magic discovery:

meterRegistry.config().meterFilter(MeterFilters.includeApplicationNameCommonTag("your-application"))

Note: this should be done before any meters are bound to the registry, in order for the filter to be effective for all meters.

@runeflobakk runeflobakk requested review from eivinhb and hermanwh June 6, 2024 13:53
The MeterFilter which add the common tag application="YourApp" to all
meters is removed from the ApplicationInfoMetrics, and instead must be
configured separately when initializing your MeterRegistry in order to
ensure the filter is configured _before_ any bound Meter.
@runeflobakk runeflobakk force-pushed the separate-appinfo-and-application-tag branch from 85f1589 to 30c8111 Compare June 6, 2024 13:54
Comment on lines -87 to -105
private void addTagIfValuePresent(List<Tag> tags, String tagKey, String valueName) {
fromManifestOrEnv(valueName).ifPresent(value -> tags.add(Tag.of(tagKey, value)));
}

private Optional<String> fromManifestOrEnv(String name) {
String value = environmentVariableOrSystemProperty(name);
if (value == null) {
value = manifest.getMainAttributes().getValue(name);
}
return ofNullable(value);
}

private static String environmentVariableOrSystemProperty(String name) {
String value = System.getProperty(name);
if (value == null) {
value = System.getenv(name);
}
return value;
}
Copy link
Member Author

Choose a reason for hiding this comment

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

The use of these methods has been refactored to the concept of a KeyValueResolver which are composed of possibly multiple sources in order of precedence. This is set up in the constructor to first check system props, then environment args, and lastly the MANIFEST.MF.

@runeflobakk runeflobakk marked this pull request as ready for review June 6, 2024 14:15
@runeflobakk runeflobakk merged commit c62ce4a into main Jun 11, 2024
5 checks passed
@runeflobakk runeflobakk deleted the separate-appinfo-and-application-tag branch June 11, 2024 14:42
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