Skip to content

Commit

Permalink
Add release notes and tidy up (#111)
Browse files Browse the repository at this point in the history
* add release notes and tidy up
  • Loading branch information
Emily-Jiang committed Aug 10, 2023
1 parent 59c3ac5 commit d6945fc
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
2 changes: 1 addition & 1 deletion pom.xml
Expand Up @@ -32,7 +32,7 @@
<properties>
<inceptionYear>2022</inceptionYear>
<opentelemetry.java.version>1.28.0</opentelemetry.java.version>
<version.microprofile.tck.bom>3.0</version.microprofile.tck.bom>
<version.microprofile.tck.bom>3.1</version.microprofile.tck.bom>
</properties>

<issueManagement>
Expand Down
Expand Up @@ -32,10 +32,7 @@ ifdef::backend-pdf[]
:pagenums:
endif::[]
// Attributes defined in the microprofile-telemetry (parent) maven POM:
//:otel-spec-version:
//:otel-spec-main-version:
//:otel-java-version:
//:otel-java-main-version:


// == License
Expand Down Expand Up @@ -533,3 +530,26 @@ GlobalTracer.registerIfAbsent(tracer);
[[sec:microprofile-telemetry-and-microprofile-opentracing]]
== MicroProfile Telemetry and MicroProfile OpenTracing
If MicroProfile Telemetry and MicroProfile OpenTracing are both present in one application, it is recommended to only enable one of them, otherwise non-portable behaviour may occur.

== Release Notes
This section documents the changes introduced by individual releases.

[[release_notes_11]]
=== Release Notes for MicroProfile Telemetry 1.1

A full list of changes delivered in the 1.1 release can be found at link:https://github.com/eclipse/microprofile-telemetry/milestone/1?closed=1[MicroProfile Telemetry 1.1 Milestone].

==== Incompatible Changes
no

==== API/SPI Changes
Consume the OpenTelemetry Java release link:https://github.com/open-telemetry/opentelemetry-java/releases/tag/v1.28.0[v1.28.0]. The full comparison with the link:https://github.com/open-telemetry/opentelemetry-java/releases/tag/v1.19.0[v1.19.0] supported by MicroProfile Telemetry 1.0 can be found link:https://github.com/open-telemetry/opentelemetry-java/compare/v1.19.0...v1.28.0[here].

==== Other Changes
- Consume the lastest OpenTelemetry Tracing (link:https://github.com/eclipse/microprofile-telemetry/issues/88[88])
- Clarify which API classes must be available to users (https://github.com/eclipse/microprofile-telemetry/issues/91[91])
- Clarify the behaviour of Span and Baggage beans when the current span or baggage changes (link:https://github.com/eclipse/microprofile-telemetry/issues/90[90])
- TCK: Implement tests in a way that is not timestamp dependent (link:https://github.com/eclipse/microprofile-telemetry/issues/44[44])
- TCK: TCK RestClientSpanTest Span Name Doesn't Follow Semantic Conv (link:https://github.com/eclipse/microprofile-telemetry/issues/86[86])
- TCK: Adding missing TCKs (link:https://github.com/eclipse/microprofile-telemetry/issues/89[89])
- TCK: TCK cannot be run using the Arquillian REST protocol (link:https://github.com/eclipse/microprofile-telemetry/issues/72[72])

0 comments on commit d6945fc

Please sign in to comment.