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: create an instrumentation package for ogma #1746

Closed

Conversation

jmcdo29
Copy link

@jmcdo29 jmcdo29 commented Oct 18, 2023

Which problem is this PR solving?

  • Providing Instrumentation support for the Ogma logger

Short description of the changes

  • I'm the author of the Ogma logger and wanted to provide instrumentation support for it, as I've had requests for such in the past. I took a similar approach as the pino instrumentation implementation, and modified it for how Ogma works. All tests should be passing, and I've assigned myself as the codeowner for this instrumentation. If there's anything else I need to do, please let me know, I'll be more than happy to do so

@jmcdo29 jmcdo29 requested a review from a team October 18, 2023 18:09
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Oct 18, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

@codecov
Copy link

codecov bot commented Oct 19, 2023

Codecov Report

Merging #1746 (6d5ec8c) into main (84e1a6b) will decrease coverage by 0.04%.
The diff coverage is 100.00%.

❗ Current head 6d5ec8c differs from pull request most recent head e5348bc. Consider uploading reports for the commit e5348bc to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1746      +/-   ##
==========================================
- Coverage   91.50%   91.47%   -0.04%     
==========================================
  Files         145      144       -1     
  Lines        7431     7342      -89     
  Branches     1489     1466      -23     
==========================================
- Hits         6800     6716      -84     
+ Misses        631      626       -5     
Files Coverage Δ
...emetry-instrumentation-ogma/src/instrumentation.ts 100.00% <100.00%> (ø)

... and 23 files with indirect coverage changes

@jmcdo29 jmcdo29 force-pushed the feat/instrumentation-ogma branch from 840509d to 9abf5b1 Compare October 30, 2023 03:07
@jmcdo29
Copy link
Author

jmcdo29 commented Oct 31, 2023

Would I be able to request a review for this? Please and thank you

@jmcdo29 jmcdo29 force-pushed the feat/instrumentation-ogma branch from 9abf5b1 to 16e47ed Compare November 6, 2023 18:25
@jmcdo29 jmcdo29 force-pushed the feat/instrumentation-ogma branch from f104178 to 6d5ec8c Compare November 13, 2023 18:51
@jmcdo29 jmcdo29 force-pushed the feat/instrumentation-ogma branch 3 times, most recently from 6b2a81a to aaebc90 Compare November 22, 2023 18:20
@jmcdo29 jmcdo29 force-pushed the feat/instrumentation-ogma branch 2 times, most recently from 6cc97c7 to 85e993e Compare November 28, 2023 19:00
@jmcdo29
Copy link
Author

jmcdo29 commented Nov 28, 2023

I'm doing what I can top keep this PR active and current so it can be reviewed and merged when ready. Let me know if there's anything else that can be done here 😄

Copy link
Contributor

@seemk seemk left a comment

Choose a reason for hiding this comment

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

Looks great!

@jmcdo29 jmcdo29 force-pushed the feat/instrumentation-ogma branch 3 times, most recently from cdd680e to 3315307 Compare December 7, 2023 22:04
@jmcdo29 jmcdo29 force-pushed the feat/instrumentation-ogma branch from 3315307 to a3b5692 Compare December 18, 2023 16:56
@SocketSomeone
Copy link

Any updates?

@jmcdo29 jmcdo29 force-pushed the feat/instrumentation-ogma branch from a3b5692 to 916d9e5 Compare December 25, 2023 01:48
@jmcdo29 jmcdo29 force-pushed the feat/instrumentation-ogma branch from ff58f45 to e5348bc Compare February 1, 2024 17:57
@pichlermarc
Copy link
Member

pichlermarc commented Jun 6, 2024

I'm the author of the Ogma logger and wanted to provide instrumentation support for it, as I've had requests for such in the past. I took a similar approach as the pino instrumentation implementation, and modified it for how Ogma works. All tests should be passing, and I've assigned myself as the codeowner for this instrumentation. If there's anything else I need to do, please let me know, I'll be more than happy to do so

Hi @jmcdo29 usually there's an instrumentation request issue that should preceed a pull request adding a new instrumentation.

Is there a reason why you decided to add this instrumentation here as opposed to hosting it in the ogma repo and adding it to the instrumentation registry?

Usually we recommend that projects host their own instrumentations as it provides them with more control over the instrumentation. It also is easier for us as we're often not familiar with the library that's being instrumented.

@pichlermarc
Copy link
Member

Adding native instrumentation might also be an option (directly depending on the @opentelemetry/api package and emitting telemetry this way).

@jmcdo29
Copy link
Author

jmcdo29 commented Jun 6, 2024

I'm not opposed to hosting it in the ogma repo at all. Thanks for getting back to me on this. It seemed that adding the instrumentation to the repo was a "proper" way to go about it, but obviously any kind of hosted packages can work. I'll close this out and host it in my own repo as to not keep this open longer than it needs to be. Thanks.

@jmcdo29 jmcdo29 closed this Jun 6, 2024
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.