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

Events API implementation #4054

Merged
merged 35 commits into from
Aug 21, 2024
Merged

Events API implementation #4054

merged 35 commits into from
Aug 21, 2024

Conversation

soumyadeepm04
Copy link
Contributor

@soumyadeepm04 soumyadeepm04 commented Jul 14, 2024

Description

Addresses #3053

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

Does This PR Require a Contrib Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

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

@soumyadeepm04 soumyadeepm04 requested a review from a team July 14, 2024 20:05
@soumyadeepm04
Copy link
Contributor Author

@lzchen Could you please have a look at this?

@lzchen
Copy link
Contributor

lzchen commented Jul 19, 2024

@soumyadeepm04

I think there are a few things missing from the api, such as setting the global provider, the corrensponding NoOp classes, the Proxy classes similar to the other apis. If you plan on keeping those to separate PRs (which is totally fine), I would simply change your description to not actually "fixes" the issue but addresses part of it.

@lzchen
Copy link
Contributor

lzchen commented Jul 19, 2024

@soumyadeepm04

Please add a CHANGELOG.md entry.

@lzchen lzchen added the Approve Public API check This label shows that the public symbols added or changed in a PR are strictly necessary label Jul 19, 2024
@soumyadeepm04
Copy link
Contributor Author

soumyadeepm04 commented Jul 19, 2024

@soumyadeepm04

I think there are a few things missing from the api, such as setting the global provider, the corrensponding NoOp classes, the Proxy classes similar to the other apis. If you plan on keeping those to separate PRs (which is totally fine), I would simply change your description to not actually "fixes" the issue but addresses part of it.

Changed the description. Will create a separate PR once this is merged.

@lzchen
Copy link
Contributor

lzchen commented Jul 22, 2024

@soumyadeepm04

Thanks for the contribution. Please add some tests to test the api is working correctly.

CHANGELOG.md Outdated Show resolved Hide resolved
@soumyadeepm04
Copy link
Contributor Author

soumyadeepm04 commented Jul 23, 2024

@soumyadeepm04

Thanks for the contribution. Please add some tests to test the api is working correctly.

@lzchen All the classes in this code change are abstract and I was wondering if you could tell me how I could test it? I was looking at the tests for logs and only the NoOpLogger and ProxyLogger are tested as they inherit the abstract classes.
I could also include all the code in this PR to be able to test it.

Copy link

@codefromthecrypt codefromthecrypt left a comment

Choose a reason for hiding this comment

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

Maybe rename this PR and the directory to "Event" not "Events"?

CHANGELOG.md Outdated Show resolved Hide resolved
@xrmx
Copy link
Contributor

xrmx commented Jul 25, 2024

Maybe rename this PR and the directory to "Event" not "Events"?

Maybe we should double check with the documentation people. Need to update the heading here too 😅 https://opentelemetry.io/docs/specs/otel/logs/event-api/. Also the "Events SDK" is plural.

@codefromthecrypt
Copy link

hah yeah after I made that comment I realized there is no consistency quorum across langs on Events vs Event 🤷, nagging my favorite linter @svrnm

@lzchen
Copy link
Contributor

lzchen commented Aug 8, 2024

@soumyadeepm04

Are you still working on this? If you can address the remaining points we can get this PR merged quickly :)

@soumyadeepm04
Copy link
Contributor Author

@soumyadeepm04

Are you still working on this? If you can address the remaining points we can get this PR merged quickly :)

@lzchen

Sorry, have been a bit busy. Will have it fixed by the weekend.

@codefromthecrypt
Copy link

@jack-berg do you mind doing a pass despite this being in python? I know practice is different per lang, but possibly there are some corner cases, tests or otherwise that pop out at you as being wise to handle.

@lzchen
Copy link
Contributor

lzchen commented Aug 12, 2024

@soumyadeepm04

We have a couple of folks who want to test the functionality of the events api so this PR would be blocking for them. Would you be able to streamline the work for this or would it be okay for someone else to take over?

Copy link
Contributor

@xrmx xrmx left a comment

Choose a reason for hiding this comment

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

To move things forward we can merge this and I can followup with the fix for the default attributes. Or a maintainer can fix that if you prefer.

@lzchen lzchen merged commit b380e53 into open-telemetry:main Aug 21, 2024
376 checks passed
@lzchen lzchen mentioned this pull request Aug 28, 2024
hyoinandout pushed a commit to hyoinandout/opentelemetry-python that referenced this pull request Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approve Public API check This label shows that the public symbols added or changed in a PR are strictly necessary
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants