Skip to content

Commit 8bd5d41

Browse files
authored
Add deprecation logging and mention in Micrometer integration doc pages (helidon-io#9100)
Signed-off-by: Tim Quinn <tim.quinn@oracle.com>
1 parent b9f19f4 commit 8bd5d41

3 files changed

Lines changed: 17 additions & 1 deletion

File tree

docs/src/main/asciidoc/includes/metrics/micrometer-shared.adoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,14 @@ endif::[]
2929
:keywords: helidon, java, micrometer, integration, se, mp
3030
3131
== Overview
32+
33+
[NOTE]
34+
====
35+
Micrometer integration is deprecated beginning in Helidon 4.1 and is planned for removal in a future major release. Please use
36+
ifdef::se-flavor[the link:{rootdir}/se/metrics/metrics.adoc[Helidon neutral metrics API].]
37+
ifdef::mp-flavor[the link:{rootdir}/mp/metrics/metrics.adoc[Helidon MicroProfile Metrics API implementation and annotations].]
38+
====
39+
3240
Helidon {h1-prefix} simplifies how you can use Micrometer for application-specific metrics:
3341
3442
* The endpoint `/micrometer`: A configurable endpoint that exposes metrics according to which Micrometer meter registry

integrations/micrometer/cdi/src/main/java/io/helidon/integrations/micrometer/cdi/MicrometerCdiExtension.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2021, 2023 Oracle and/or its affiliates.
2+
* Copyright (c) 2021, 2024 Oracle and/or its affiliates.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -57,7 +57,10 @@
5757

5858
/**
5959
* CDI extension for handling Micrometer artifacts.
60+
*
61+
* @deprecated To be removed in a future release. No replacement.
6062
*/
63+
@Deprecated(forRemoval = true, since = "4.1")
6164
public class MicrometerCdiExtension extends HelidonRestCdiExtension {
6265

6366
private static final System.Logger LOGGER = System.getLogger(MicrometerCdiExtension.class.getName());
@@ -126,6 +129,8 @@ public void registerService(@Observes @Priority(LIBRARY_BEFORE + 10) @Initialize
126129
annotation.annotationType(),
127130
MeterWorkItem.create(newMeter, isOnlyOnException));
128131
});
132+
133+
LOGGER.log(Level.WARNING, "Micrometer integration is deprecated and will be removed in a future major release.");
129134
}
130135
MeterRegistry meterRegistry() {
131136
if (feature == null) {

integrations/micrometer/micrometer/src/main/java/io/helidon/integrations/micrometer/MicrometerFeature.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ public class MicrometerFeature extends HelidonFeatureSupport {
4949

5050
static final String DEFAULT_CONTEXT = "/micrometer";
5151
private static final String SERVICE_NAME = "Micrometer";
52+
private static final System.Logger LOGGER = System.getLogger(MicrometerFeature.class.getName());
5253

5354
private final MeterRegistryFactory meterRegistryFactory;
5455

@@ -105,6 +106,8 @@ protected void postSetup(HttpRouting.Builder defaultRouting, HttpRouting.Builder
105106
@Override
106107
public void beforeStart() {
107108
Contexts.globalContext().register(registry());
109+
LOGGER.log(System.Logger.Level.WARNING,
110+
"Micrometer integration is deprecated and will be removed in a future major release.");
108111
}
109112

110113
private void getOrOptions(ServerRequest serverRequest, ServerResponse serverResponse) throws Exception {

0 commit comments

Comments
 (0)