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

Update the RegisterCallback documentation of the SDK meter #3604

Merged
merged 4 commits into from
Jan 24, 2023
Merged

Update the RegisterCallback documentation of the SDK meter #3604

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ca8f077
Update the RegisterCallback of the SDK meter
MrAlias Jan 19, 2023
10b4cff
Merge branch 'main' into update-meter-regcback-doc
MrAlias Jan 19, 2023
26c5f2f
Merge branch 'main' into update-meter-regcback-doc
MrAlias Jan 20, 2023
2e2153e
Merge branch 'main' into update-meter-regcback-doc
MrAlias Jan 24, 2023
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
12 changes: 10 additions & 2 deletions sdk/metric/meter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,8 +205,16 @@ func (m *meter) Float64ObservableGauge(name string, options ...instrument.Float6
return inst, nil
}

// RegisterCallback registers the function f to be called when any of the
// insts Collect method is called.
// RegisterCallback registers f to be called each collection cycle so it will
// make observations for insts during those cycles.
//
// The only instruments f can make observations for are insts. All other
// observations will be dropped and an error will be logged.
//
// Only instruments from this meter can be registered with f, an error is
// returned if other instrument are provided.
//
// The returned Registration can be used to unregister f.
func (m *meter) RegisterCallback(f metric.Callback, insts ...instrument.Asynchronous) (metric.Registration, error) {
if len(insts) == 0 {
// Don't allocate a observer if not needed.
Expand Down