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

feat: support batch (getmany) in aiokafka instrumentation #3257

Open
wants to merge 18 commits into
base: main
Choose a base branch
from

Conversation

dimastbk
Copy link
Contributor

@dimastbk dimastbk commented Feb 11, 2025

Description

This PR adds support for reading batches in aiokafka (method getmany).
And some fixes:

  • improve typing
  • fix warnings about unclosed resources in tests
  • fix error if headers are immutable

partial fix #3087

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A

Does This PR Require a Core Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

@dimastbk dimastbk marked this pull request as ready for review February 12, 2025 08:13
@dimastbk dimastbk requested a review from a team as a code owner February 12, 2025 08:13
@dimastbk dimastbk force-pushed the add-aiokafka-batch branch from 1347b0d to 76c8faa Compare March 30, 2025 09:18
@dimastbk
Copy link
Contributor Author

@xrmx Hi. Could you take a look at this PR?

) -> asyncio.Future[RecordMetadata]: ...


ProduceHookT = Optional[
Copy link
Member

Choose a reason for hiding this comment

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

should be under if type_checking?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@@ -13,12 +26,60 @@
from opentelemetry.trace import Tracer
from opentelemetry.trace.span import Span

if TYPE_CHECKING:
Copy link
Member

Choose a reason for hiding this comment

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

since you are doing a lot of changes in terms of typing, would you care to add the package to be run with strict mode in pyright?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I attempted to run in strict mode, but aiokafka doesn't have type hints and I received many errors. It requires a lot of work (and a lot of # type: ignore).

)

for topic, topic_records in records.items():
span_name = _get_span_name("receive", topic.topic)
Copy link
Member

Choose a reason for hiding this comment

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

shouldn't the operation name be poll ? Like in the examples here

Copy link
Member

Choose a reason for hiding this comment

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

oops, selected the wrong line, I mean the poll_span

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, but I made a mistake and getone use "receive topic" (and see #3257 (comment) too). So for code consistency, I use "receive" and here. I think it should be fixed in the next MR.


expected_spans = [
{
"name": "topic_1 receive",
Copy link
Member

Choose a reason for hiding this comment

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

Probably we need to revisit this later, but I think the span name should be: receive topic_1

Copy link
Contributor Author

@dimastbk dimastbk Apr 10, 2025

Choose a reason for hiding this comment

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

Yes, see also #3257 (comment) and 76c8faa.

@dimastbk dimastbk requested a review from emdneto April 10, 2025 05:57
@dimastbk dimastbk force-pushed the add-aiokafka-batch branch from 72d396d to c7704ef Compare April 11, 2025 05:26
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.

Instrumentation for AIOKafka's getmany method
3 participants