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

[4.x.] - Deprecate MicroProfile Tracing #5909

Merged
merged 6 commits into from
Jan 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2022 Oracle and/or its affiliates.
* Copyright (c) 2022, 2023 Oracle and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -110,12 +110,12 @@ private void processModule(Element moduleElement) {
annotation.getElementValues()
.forEach((method, value) -> {
if (method.getSimpleName().contentEquals("since")) {
descriptor.since((String) value.getValue());
descriptor.deprecatedSince((String) value.getValue());
}
});
if (descriptor.noDeprecatedSince()) {
messager.printMessage(Diagnostic.Kind.ERROR, "Failed to process feature metadata annotation processor. "
+ " Module " + moduleName + " has @Deprecated without since. Since must be defined");
+ " Module " + moduleName + " has @Deprecated without since. Since must be defined.");
throw new IllegalStateException("Deprecated without since in module " + moduleName);
}
break;
Expand Down
5 changes: 4 additions & 1 deletion docs/mp/tracing.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2018, 2022 Oracle and/or its affiliates.
Copyright (c) 2018, 2023 Oracle and/or its affiliates.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -39,6 +39,9 @@ include::{rootdir}/includes/mp.adoc[]

== Overview

WARNING: The OpenTracing Specification that MP OpenTracing is based on is no longer maintained.
The MP OpenTracing specification is no longer required by MicroProfile. This feature is marked as `@Deprecated` in Helidon. The specification is Superseded by link:https://github.com/eclipse/microprofile-telemetry[MicroProfile Telemetry specification].

Distributed tracing is a critical feature of micro-service based applications, since it traces workflow both
within a service and across multiple services. This provides insight to sequence and timing data for specific blocks of work,
which helps you identify performance and operational issues. Helidon MP includes support for distributed tracing
Expand Down
6 changes: 1 addition & 5 deletions microprofile/bundles/helidon-microprofile/pom.xml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--

Copyright (c) 2019, 2022 Oracle and/or its affiliates.
Copyright (c) 2019, 2023 Oracle and/or its affiliates.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -70,10 +70,6 @@
<groupId>io.helidon.microprofile.rest-client</groupId>
<artifactId>helidon-microprofile-rest-client</artifactId>
</dependency>
<dependency>
<groupId>io.helidon.microprofile.tracing</groupId>
<artifactId>helidon-microprofile-tracing</artifactId>
</dependency>
<dependency>
<groupId>org.glassfish.jersey.media</groupId>
<artifactId>jersey-media-json-binding</artifactId>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2019, 2021 Oracle and/or its affiliates.
* Copyright (c) 2019, 2023 Oracle and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -24,7 +24,6 @@
requires transitive io.helidon.microprofile.metrics;
requires transitive io.helidon.microprofile.faulttolerance;
requires transitive io.helidon.microprofile.jwt.auth;
requires transitive io.helidon.microprofile.tracing;
requires transitive io.helidon.microprofile.restclient;
requires transitive io.helidon.microprofile.openapi;
requires transitive jakarta.json.bind;
Expand Down
7 changes: 6 additions & 1 deletion microprofile/tests/tck/tck-opentracing/pom.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2019, 2022 Oracle and/or its affiliates.
Copyright (c) 2019, 2023 Oracle and/or its affiliates.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -56,6 +56,11 @@
<artifactId>opentracing-mock</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.helidon.microprofile.tracing</groupId>
<artifactId>helidon-microprofile-tracing</artifactId>
<scope>test</scope>
</dependency>
</dependencies>

<build>
Expand Down
5 changes: 3 additions & 2 deletions microprofile/tracing/src/main/java/module-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,9 @@
@Feature(value = "Tracing",
description = "MicroProfile tracing spec implementation",
in = HelidonFlavor.MP,
path = "Tracing"
)
path = "Tracing",
since = "1.0.0")
@Deprecated(since="4.0.0", forRemoval = true)
module io.helidon.microprofile.tracing {
requires static io.helidon.common.features.api;

Expand Down
6 changes: 5 additions & 1 deletion tests/integration/zipkin-mp-2.2/pom.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2019, 2022 Oracle and/or its affiliates.
Copyright (c) 2019, 2023 Oracle and/or its affiliates.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -38,6 +38,10 @@
<groupId>io.helidon.tracing</groupId>
<artifactId>helidon-tracing-zipkin</artifactId>
</dependency>
<dependency>
<groupId>io.helidon.microprofile.tracing</groupId>
<artifactId>helidon-microprofile-tracing</artifactId>
</dependency>
<dependency>
<groupId>org.jboss</groupId>
<artifactId>jandex</artifactId>
Expand Down