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

Jump to bottom

Add Enabled method to Logger #4020

Merged
merged 14 commits into from
May 28, 2024
Merged

Add Enabled method to Logger #4020

merged 14 commits into from
May 28, 2024

Conversation

MrAlias
Copy link
Contributor

@MrAlias MrAlias commented Apr 29, 2024

Fixes #3917

Knowing if a LogRecord will be dropped prior to performing computationally expensive operations helps developers using the Logs Bridge API avoid wasted and expensive work. This adds and Enabled API to the Logger to provide this functionality.

This is related to #3877. In that PR Loggers may become entirely disabled. The Enabled method included here will help users determine this state.

Prototypes

@MrAlias MrAlias added the spec:logs Related to the specification/logs directory label Apr 29, 2024
@MrAlias MrAlias marked this pull request as ready for review April 29, 2024 20:06
@MrAlias MrAlias requested review from a team as code owners April 29, 2024 20:06
jack-berg
jack-berg reviewed Apr 29, 2024
View reviewed changes
Copy link
Member

@jack-berg jack-berg left a comment

Choose a reason for hiding this comment

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

Nice! Was coincidentally just working on a local branch for this. I think we ought to have symmetry across metrics and traces, but fine pursuing that in a separate PR.

specification/logs/bridge-api.md Outdated Show resolved Hide resolved
specification/logs/bridge-api.md Show resolved Hide resolved
reyang
reyang approved these changes Apr 29, 2024
View reviewed changes
Copy link
Member

@reyang reyang left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks @MrAlias!

@reyang reyang added the area:api Cross language API specification issue label Apr 29, 2024
@lalitb lalitb mentioned this pull request May 1, 2024
Open
jack-berg
jack-berg approved these changes May 13, 2024
View reviewed changes
specification/logs/bridge-api.md Outdated Show resolved Hide resolved
@marcalff marcalff mentioned this pull request May 14, 2024
Open
@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented May 17, 2024 •
edited

CLA Signed

The committers listed above are authorized under a signed CLA.

@MrAlias
Redefine the return value
aa6b297 
Clarify the true/false expectation and add optional stale value return.
pellared
pellared approved these changes May 22, 2024
View reviewed changes
Copy link
Member

@pellared pellared left a comment •
edited

Choose a reason for hiding this comment

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

LGTM.

PS. I created #4055

@pellared pellared mentioned this pull request May 22, 2024
Merged
marcalff
marcalff suggested changes May 23, 2024
View reviewed changes
specification/logs/bridge-api.md Outdated Show resolved Hide resolved
carlosalberto pushed a commit that referenced this pull request May 23, 2024
@pellared @reyang
Do not use SHALL and SHALL NOT (#4055)
ce9cf49 
Per
#4020 (comment)

Some people confuse SHALL with SHOULD.

---------

Co-authored-by: Reiley Yang <[email protected]>
MrAlias and others added 2 commits May 23, 2024 08:22
@MrAlias
Remove spec for implementation return value
d757b54 
Leave the return value implementation for implementations specification.
@MrAlias
Merge branch 'main' into logger-enabled
8c29b8d
@cijothomas
Copy link
Member

Re-requested review from @jack-berg and @reyang as the contents have changed since their approvals.

@reyang reyang merged commit f3aeadb into open-telemetry:main May 28, 2024
6 checks passed
@MrAlias MrAlias deleted the logger-enabled branch May 28, 2024 16:26
@jack-berg jack-berg mentioned this pull request May 28, 2024
Merged
@lalitb lalitb mentioned this pull request May 30, 2024
Closed
4 tasks
jack-berg added a commit that referenced this pull request Jun 3, 2024
@jack-berg @pellared
@trask @reyang
Add Tracer#Enabled, Instrument#Enabled and corresponding SDK behavior (…
d0bfe08 
…#4063)

Builds off #4020 to extend the `Enabled` API to `Tracer` and metrics
`Instrument`.

Adds language to Log SDK, Metrics SDK, and Trace SDK for how scope
config is used to resolve the `Enabled` operation.

This was discussed in #3867 but punted on in #3877 as [discussed
here](#3877 (comment)).

---------

Co-authored-by: Robert Pająk <[email protected]>
Co-authored-by: Trask Stalnaker <[email protected]>
Co-authored-by: Reiley Yang <[email protected]>
@jack-berg jack-berg mentioned this pull request Jun 4, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dmathieu dmathieu dmathieu left review comments

@trask trask trask left review comments

@lmolkova lmolkova lmolkova left review comments

@yurishkuro yurishkuro yurishkuro left review comments

@pellared pellared pellared approved these changes

@cijothomas cijothomas cijothomas approved these changes

@reyang reyang reyang approved these changes

@tsloughter tsloughter tsloughter approved these changes

@carlosalberto carlosalberto carlosalberto approved these changes

@dashpole dashpole dashpole approved these changes

@jmacd jmacd jmacd approved these changes

@tigrannajaryan tigrannajaryan tigrannajaryan approved these changes

@marcalff marcalff marcalff approved these changes

@jack-berg jack-berg jack-berg approved these changes

Assignees

@tigrannajaryan tigrannajaryan

Labels
area:api Cross language API specification issue spec:logs Related to the specification/logs directory
Projects
Go: Logs (GA)
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add an Enabled method to the Logger