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

Include Open Telemetry tracing #451

Merged
merged 1 commit into from
Oct 19, 2023
Merged

Conversation

simaoribeiro
Copy link
Contributor

@simaoribeiro simaoribeiro commented Oct 11, 2023

Description

Includes several changes that allow telemetry events to be created when producing and consuming messages:

  • Includes an event system that notifies the listeners of the following events
  1. Message consume start
  2. Message consume complete
  3. Message consume error
  4. Message produce start
  5. Message produce complete
  6. Message produce error
  • Includes a new project KafkaFlow.OpenTelemetry that can be used to export trace information regarding the internal kafka events mentioned above.

Note: The trace information may not be reliable when using batch consumers. This drawback is scheduled to be solved in a new major version https://github.com/Farfetch/kafkaflow/tree/release/3.0

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have added tests to cover my changes
  • I have made corresponding changes to the documentation

Disclaimer

By sending us your contributions, you are agreeing that your contribution is made subject to the terms of our Contributor Ownership Statement

samples/KafkaFlow.Sample/Program.cs Outdated Show resolved Hide resolved
src/KafkaFlow.Abstractions/MessageEventContext.cs Outdated Show resolved Hide resolved
src/KafkaFlow.Abstractions/MessageEventExceptionContext.cs Outdated Show resolved Hide resolved
src/KafkaFlow/Configuration/KafkaConfigurationBuilder.cs Outdated Show resolved Hide resolved
@simaoribeiro simaoribeiro marked this pull request as ready for review October 12, 2023 17:11
samples/KafkaFlow.Sample/Program.cs Outdated Show resolved Hide resolved
src/KafkaFlow.Abstractions/IEvent.cs Show resolved Hide resolved
src/KafkaFlow/MessageContext.cs Show resolved Hide resolved
src/KafkaFlow.IntegrationTests/GlobalEventsTest.cs Outdated Show resolved Hide resolved
src/KafkaFlow.IntegrationTests/GlobalEventsTest.cs Outdated Show resolved Hide resolved
website/docs/guides/global-events.md Outdated Show resolved Hide resolved
website/docs/guides/global-events.md Outdated Show resolved Hide resolved
Include events for message produce and consume:
- MessageConsumeCompleted
- MessageConsumeError
- MessageConsumeStarted
- MessageProduceCompleted
- MessageProduceError
- MessageProduceStarted

Include OpenTelemetry support for traces and baggage signals.
@simaoribeiro simaoribeiro merged commit 0926b94 into master Oct 19, 2023
3 checks passed
@simaoribeiro simaoribeiro deleted the feat/include-open-telemetry branch October 19, 2023 09:48
@simaoribeiro simaoribeiro mentioned this pull request Nov 23, 2023
4 tasks
@gsferreira gsferreira mentioned this pull request Nov 27, 2023
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request version 2.0
Development

Successfully merging this pull request may close these issues.

8 participants