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

Compatibility updates for v2 in README #6316

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jkowall
Copy link
Contributor

@jkowall jkowall commented Dec 6, 2024

Which problem is this PR solving?

Addresses part of jaegertracing/documentation#117

Description of the changes

Update text to match Jaeger v2

How was this change tested?

Not tested

Checklist

Signed-off-by: Jonah Kowall <[email protected]>
@jkowall jkowall requested a review from a team as a code owner December 6, 2024 08:26
@jkowall jkowall requested a review from pavolloffay December 6, 2024 08:26
Copy link

codecov bot commented Dec 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.22%. Comparing base (2d546d0) to head (3868e9b).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6316   +/-   ##
=======================================
  Coverage   96.22%   96.22%           
=======================================
  Files         356      356           
  Lines       20454    20454           
=======================================
  Hits        19681    19681           
  Misses        585      585           
  Partials      188      188           
Flag Coverage Δ
badger_v1 8.83% <ø> (ø)
badger_v2 1.62% <ø> (ø)
cassandra-4.x-v1-manual 14.73% <ø> (ø)
cassandra-4.x-v2-auto 1.56% <ø> (ø)
cassandra-4.x-v2-manual 1.56% <ø> (ø)
cassandra-5.x-v1-manual 14.73% <ø> (ø)
cassandra-5.x-v2-auto 1.56% <ø> (ø)
cassandra-5.x-v2-manual 1.56% <ø> (ø)
elasticsearch-6.x-v1 18.46% <ø> (ø)
elasticsearch-7.x-v1 18.54% <ø> (ø)
elasticsearch-8.x-v1 18.71% <ø> (ø)
elasticsearch-8.x-v2 1.62% <ø> (ø)
grpc_v1 10.29% <ø> (ø)
grpc_v2 7.84% <ø> (ø)
kafka-v1 8.52% <ø> (ø)
kafka-v2 1.62% <ø> (ø)
memory_v2 1.62% <ø> (ø)
opensearch-1.x-v1 18.59% <ø> (ø)
opensearch-2.x-v1 18.59% <ø> (-0.01%) ⬇️
opensearch-2.x-v2 1.61% <ø> (-0.01%) ⬇️
tailsampling-processor 0.45% <ø> (ø)
unittests 95.13% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -67,7 +67,7 @@ For example, any given Jaeger installation at Uber is typically processing sever

### Relationship with OpenTelemetry
Copy link
Member

Choose a reason for hiding this comment

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

Hm, I recently removed this section altogether, moved it to the documentation.

https://www.jaegertracing.io/docs/next-release-v2/#relationship-with-opentelemetry

@@ -124,19 +124,19 @@ of routing the traffic from Zipkin libraries to the Jaeger backend.

## Version Compatibility Guarantees

Occasionally, CLI flags can be deprecated due to, for example, usability improvements or new functionality.
Since Jaeger uses many components from the [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector/) we try to maintain configuration compatibility between Jaeger releases. Occasionally, configuration elements in Jaeger (or in Jaeger v1 CLI flags) can be deprecated due to usability improvements, new functionality, or changes in our dependencies.
Copy link
Member

Choose a reason for hiding this comment

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

I think "configuration option" used in L129 sounds better than "element", perhaps converge to that one for consistency?

Copy link
Member

@yurishkuro yurishkuro left a comment

Choose a reason for hiding this comment

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

changes lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants