Skip to content

export Close() method for subscopes #271

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

Open
emmanuel-chukwu wants to merge 2 commits into
base: master
Choose a base branch
from
Open

export Close() method for subscopes #271

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a7d867
feat: export Close() method for subscopes
emmanuel-chukwu May 21, 2025
e964651
Add ClosableScope interface to expose Close() on subscopes in a backw…
emmanuel-chukwu May 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,12 @@ type Scope interface {

// Capabilities returns a description of metrics reporting capabilities.
Capabilities() Capabilities

// Close closes the scope and releases any resources.
// For root scopes, this will also close the reporter.
// For subscopes, this will clear all metrics and remove the scope from the registry.
// Returns an error if the scope is already closed.
Close() error
Copy link
Collaborator

@prateek prateek May 21, 2025

Choose a reason for hiding this comment

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

can't do this - it's a breaking change to add a method to a go interface in semver terms

Copy link
Author

@emmanuel-chukwu emmanuel-chukwu May 26, 2025

Choose a reason for hiding this comment

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

I've introduced a new ClosableScope interface to embed Scope with a Close() method

}

// Counter is the interface for emitting counter type metrics.
Expand Down