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

Update SPM docs to reflect support for spanmetrics connector #640

Merged

Conversation

albertteoh
Copy link
Contributor

Which problem is this PR solving?

Short description of the changes

  • Updates the SPM documentation to reflect support for the spanmetrics connector.
  • Provides link referencing documentation that provides guidance for migrating to the spanmetrics connector.
  • Provides version compatibility guidance between jaeger and OTEL.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Signed-off-by: albertteoh <see.kwang.teoh@gmail.com>
Signed-off-by: albertteoh <see.kwang.teoh@gmail.com>
Signed-off-by: albertteoh <see.kwang.teoh@gmail.com>
@netlify
Copy link

netlify bot commented Jun 1, 2023

Deploy Preview for romantic-neumann-1959d7 ready!

Name Link
🔨 Latest commit 7d76dbd
🔍 Latest deploy log https://app.netlify.com/sites/romantic-neumann-1959d7/deploys/647b371a0e4a0e0007f7294e
😎 Deploy Preview https://deploy-preview-640--romantic-neumann-1959d7.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

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.

Suggested much simpler banner text. Please make sure to run the dead links checker (I don't think it works reliably from CI)

Comment on lines 60 to 69
The [SpanMetrics Processor](https://github.com/jaegertracing/jaeger/blob/main/docker-compose/monitor/README.md#migrating-to-span-metrics-connector)
is deprecated in favour of the [SpanMetrics Connector](https://github.com/jaegertracing/jaeger/blob/main/docker-compose/monitor/README.md#migrating-to-span-metrics-connector).

Specifically for the SPM feature, Jaeger versions &le; 1.45.0 will support Opentelemetry Collector versions &le; 0.70.0.

As a corollary, Jaeger versions &ge; 1.46.0 will support Opentelemetry Collector versions &ge; 0.71.0.

For details on migrating your Jaeger components to use the metrics produced by the
[SpanMetrics Connector](https://github.com/jaegertracing/jaeger/blob/main/docker-compose/monitor/README.md#migrating-to-span-metrics-connector)
please refer to the [migration guide](https://github.com/jaegertracing/jaeger/blob/main/docker-compose/monitor/README.md#migrating-to-span-metrics-connector).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
The [SpanMetrics Processor](https://github.com/jaegertracing/jaeger/blob/main/docker-compose/monitor/README.md#migrating-to-span-metrics-connector)
is deprecated in favour of the [SpanMetrics Connector](https://github.com/jaegertracing/jaeger/blob/main/docker-compose/monitor/README.md#migrating-to-span-metrics-connector).
Specifically for the SPM feature, Jaeger versions &le; 1.45.0 will support Opentelemetry Collector versions &le; 0.70.0.
As a corollary, Jaeger versions &ge; 1.46.0 will support Opentelemetry Collector versions &ge; 0.71.0.
For details on migrating your Jaeger components to use the metrics produced by the
[SpanMetrics Connector](https://github.com/jaegertracing/jaeger/blob/main/docker-compose/monitor/README.md#migrating-to-span-metrics-connector)
please refer to the [migration guide](https://github.com/jaegertracing/jaeger/blob/main/docker-compose/monitor/README.md#migrating-to-span-metrics-connector).
Starting with v1.46.0, Jaeger supports the OpenTelemetry [SpanMetrics Connector][spanmetrics-conn], which is replacing the deprecated [SpanMetrics Processor][spanmetrics]. Please refer to the [migration guide](https://github.com/jaegertracing/jaeger/blob/main/docker-compose/monitor/README.md#migrating-to-span-metrics-connector).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That looks a lot better, thanks! I intended to provide guidance for users who weren't ready to upgrade to jaeger 1.46.0, but I think it's safe to assume more users are happy to upgrade jaeger, given they're willing to upgrade OTEL.

Updated in faab703 and added back the spanmetrics reference in: 7d76dbd.

Signed-off-by: albertteoh <see.kwang.teoh@gmail.com>
Signed-off-by: albertteoh <see.kwang.teoh@gmail.com>
@albertteoh albertteoh merged commit f477243 into jaegertracing:main Jun 3, 2023
@albertteoh albertteoh deleted the spanmetrics-processor-connector branch June 3, 2023 13:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants