Skip to content

Commit

Permalink
docs(api-metrics): add notes on ObservableResult.observe (#2712)
Browse files Browse the repository at this point in the history
Co-authored-by: Valentin Marchaud <[email protected]>
Co-authored-by: Daniel Dyla <[email protected]>
  • Loading branch information
3 people committed Jan 19, 2022
1 parent 1577f35 commit 8bda25c
Showing 1 changed file with 8 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,13 @@ import { Attributes } from './Metric';
* Interface that is being used in callback function for Observable Metric
*/
export interface ObservableResult {
/**
* Observe a measurement of the value associated with the given attributes.
*
* @param value The value to be observed.
* @param attributes The attributes associated with the value. If more than
* one values associated with the same attributes values, SDK may pick the
* last one or simply drop the entire observable result.
*/
observe(value: number, attributes?: Attributes): void;
}

0 comments on commit 8bda25c

Please sign in to comment.