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.

Sign up for GitHub

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

doc(data): add micrometer as communitry tracer #180

Merged
merged 5 commits into from
Sep 22, 2024
Merged

doc(data): add micrometer as communitry tracer #180

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6a9b25b
doc(data): add micrometer as communitry tracer
Jul 24, 2024
f110f76
doc(_data.communityTracersInstrumentation): add review comments
Aug 20, 2024
fa23917
doc(_data/communityTracersInstrumentation): review comments
dancer1325 Aug 21, 2024
77961b8
doc(_data.communityTracersInstrumentation): add review comments
dancer1325 Aug 21, 2024
18ff8a5
doc(_data.communityTracersInstrumentation): add review comments
Sep 22, 2024
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
10 changes: 9 additions & 1 deletion _data/community_tracers_instrumentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
library: >-
[zipkin-go-opentracing](https://github.com/openzipkin-contrib/zipkin-go-opentracing)
framework: >-
[Go kit](https://gokit.io), or roll your own with [OpenTracing](http://opentracing.io)

Check warning on line 5 in _data/community_tracers_instrumentation.yml

View workflow job for this annotation

GitHub Actions / test 

5:81 [line-length] line too long (90 > 80 characters)
propagation: Http (B3), gRPC (B3)
transports: Http, Kafka, Scribe
sampling: "Yes"
Expand Down Expand Up @@ -30,28 +30,36 @@
- language: Java
library: >-
[Spring Cloud Sleuth](https://github.com/spring-cloud/spring-cloud-sleuth)
[Micrometer Tracing](https://github.com/micrometer-metrics/tracing)
framework: Spring, Spring Cloud (e.g. Stream, Netflix)
propagation: Http (B3), Messaging (B3)
transports: Http, Spring Cloud Stream Compatible (e.g. RabbitMQ, Kafka, Redis or anything with a custom Binder)

Check warning on line 35 in _data/community_tracers_instrumentation.yml

View workflow job for this annotation

GitHub Actions / test 

35:81 [line-length] line too long (113 > 80 characters)
sampling: "Yes"
notes: Java 7 or higher

- language: Java
library: >-
[Micrometer Tracing](https://github.com/micrometer-metrics/tracing)
framework: Spring, Quarkus, Micronaut, Helidon
Copy link
Member

Choose a reason for hiding this comment

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

May seem like a nit, but I think this question has come up (what about Spring Boot 2)

Suggested change
framework: Spring, Quarkus, Micronaut, Helidon
framework: Spring Boot 3+, Quarkus, Micronaut, Helidon

Copy link
Member

Choose a reason for hiding this comment

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

technically, Spring Framework 6+

I'm not sure if Quarkus, Micronaut and Helidon support Micrometer Tracing besides Metrics.

For example, in the Helidon doc, only OpenTelemetry is referred.
https://helidon.io/docs/v4/mp/telemetry

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated to "Spring Framework 6+". About frameworks related ...?

Copy link
Member

@making making Aug 23, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Quarkus, Micronaut, Helidon

Have you tested that it works?
If not, it's probably safe to remove the mention.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Quarkus, Micronaut, Helidon

Have you tested that it works? If not, it's probably safe to remove the mention.

I have NOT had time to tested it. Should I remove it for safety reasons?

Copy link
Member

Choose a reason for hiding this comment

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

I would remove them. Iooked at the other docs and unlike spring boot, there are no zipkin tracing integrations/registries/instructions in Quarkus, Micronaut, Helidon. The closest they come is otel, and that's stretch to say is a community integration for zipkin.

p.s. @making still think it should be about spring boot because spring itself has no zipkin integration. It is a bit misleading and inconsistent to say Spring Framework 6+ which doesn't have an integration path for zipkin, unless I'm missing something https://docs.spring.io/spring-boot/reference/actuator/tracing.html

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated @codefromthecrypt

propagation: Http (B3), Messaging (B3), W3C(B3)
dancer1325 marked this conversation as resolved.
Show resolved Hide resolved
transports: Http
sampling: "Yes"
notes: Java 8+

- language: Java
library: >-
[Wingtips](https://github.com/Nike-Inc/wingtips)
framework: >-
[Any Servlet API framework](https://github.com/Nike-Inc/wingtips/tree/master/wingtips-servlet-api),

Check warning on line 52 in _data/community_tracers_instrumentation.yml

View workflow job for this annotation

GitHub Actions / test 

52:81 [line-length] line too long (103 > 80 characters)
[roll-your-own](https://github.com/Nike-Inc/wingtips#generic-application-pseudo-code),
[async framework support](https://github.com/Nike-Inc/wingtips#usage-in-reactive-asynchronous-nonblocking-scenarios)

Check warning on line 54 in _data/community_tracers_instrumentation.yml

View workflow job for this annotation

GitHub Actions / test 

54:81 [line-length] line too long (120 > 80 characters)
propagation: Http (B3)
transports: Http
sampling: "Yes"
notes: Java 7 or higher, [SLF4J MDC support](https://github.com/Nike-Inc/wingtips#mdc_info) for auto-tagging all log messages with tracing info

Check warning on line 58 in _data/community_tracers_instrumentation.yml

View workflow job for this annotation

GitHub Actions / test 

58:81 [line-length] line too long (145 > 80 characters)

- language: Lua
library: >-
[Apache APISIX-plugin-zipkin](https://github.com/apache/apisix/tree/master/apisix/plugins/zipkin)

Check warning on line 62 in _data/community_tracers_instrumentation.yml

View workflow job for this annotation

GitHub Actions / test 

62:81 [line-length] line too long (101 > 80 characters)
framework: >-
[Apache APISIX](https://apisix.apache.org/)
propagation: Http (B3)
Expand Down
Loading