Skip to content

Commit

Permalink
[WFLY-17510] Remove MicroProfile OpenTracing
Browse files Browse the repository at this point in the history
Analysis doc for MP OpenTracing Removal
  • Loading branch information
jasondlee committed Feb 14, 2023
1 parent 3d188c8 commit 910fe72
Showing 1 changed file with 78 additions and 0 deletions.
78 changes: 78 additions & 0 deletions microprofile/WFLY-17510-remove-microprofile-opentracing.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
= WFLY-17510: Remove MicroProfile OpenTracing
:author: Jason Lee
:email: [email protected]
:toc: left
:icons: font
:idprefix:
:idseparator: -

== Overview

WildFly has long offered MicroProfile OpenTracing as part of its overall MicroProfile support. Since its inclusion in WildFly, however, OpenTracing has merged with OpenCensus to form https://opentelemetry.io[OpenTelemetry]. Because of this merger, the OpenTracing project itself has been abandoned, and the MicroProfile Working Group has decided to remove OpenTracing from the platform specification, replacing it with MicroProfile Telemetry, which wraps and exposes https://opentelemetry.io[OpenTelemetry]. The effort under this JIRA will cover only the effort to remove MicroProfile OpenTracing (MicroProfile OpenTracing) from the server and migrate installations to MicroProfile Telemetry.

== Issue Metadata

=== Issue

* https://issues.redhat.com/browse/WFLY-17510[WFLY-17510]

=== Related Issues

* https://issues.redhat.com/browse/WFLY-17156[WFLY-17156]
* https://issues.redhat.com/browse/EAP7-2002[EAP7-2002]

=== Dev Contacts

* mailto:{email}[{author}]

=== QE Contacts

=== Testing By
* [x] Engineering
* [x] QE

=== Affected Projects or Components

All the code changes will be confined to the MicroProfile OpenTracing extension and subsystem, which includes the Java code, Galleon modules/layers, etc.

=== Other Interested Projects

OpenTelemetry/MicroProfile Telemetry are involved but unchanged.

=== Relevant Installation Types
* [x] Traditional standalone server (unzipped or provisioned by Galleon)
* [x] Managed domain
* [x] OpenShift s2i
* [x] Bootable jar

== Requirements

=== Hard Requirements

* MicroProfile OpenTracing will be migrated to a legacy module
* MicroProfile OpenTracing will be removed from the standard configurations of WildFly
* Upon server start in admin-only mode:
** The subsystem and extension will be removed, if needed, from the running server's config
** For systems with MicroProfile OpenTracing configured, OpenTelemetry will be configured using default values

=== Nice-to-Have Requirements

=== Non-Requirements

* Converting MicroProfile OpenTracing config to OpenTelemetry config. The configuration options and default values vary enough that a meaningful conversion is not possible.

== Backwards Compatibility

This represents the removal of a subsystem, so any application the depends on these APIs will fail to deploy. Likewise, any installation that is expecting (Jaeger) tracing data to be exported will see a behavior change that may or may not impact any external monitoring solutions.

== Test Plan

Tests will be added to verify that MicroProfile OpenTracing has been removed, and parsing tests will be modified as needed to verify that the system can continue to read/parse the subsystem config during migration.

== Community Documentation

Any documentation related to MicroProfile OpenTracing will be removed.

== Release Note Content

MicroProfile OpenTracing has been removed by the MicroProfile Working Group, so this feature has been removed from WildFly as well. Applications that depend on OpenTracing APIs will no longer deploy and will need to be migrated to another tracing solution such as OpenTelemetry.

0 comments on commit 910fe72

Please sign in to comment.