-
Notifications
You must be signed in to change notification settings - Fork 782
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: metrics API revision based on specs and rfcs
- Loading branch information
1 parent
50047b3
commit 134e986
Showing
7 changed files
with
152 additions
and
123 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
/** | ||
* Copyright 2019, OpenTelemetry Authors | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
import { Resource } from '../resources/Resource'; | ||
|
||
/** | ||
* Options needed for metric creation | ||
*/ | ||
export interface MetricOptions { | ||
/** The description of the Metric. */ | ||
description?: string; | ||
|
||
/** The unit of the Metric values. */ | ||
unit?: string; | ||
|
||
/** The list of label keys for the Metric. */ | ||
labelKeys?: string[]; | ||
|
||
/** The map of constant labels for the Metric. */ | ||
constantLabels?: Map<string, string>; | ||
|
||
/** The resource the Metric is associated with. */ | ||
resource?: Resource; | ||
|
||
/** The name of the component that reports the Metric. */ | ||
component?: string; | ||
} | ||
|
||
/** | ||
* Metric represents a base class for different types of metric | ||
* pre aggregations. | ||
*/ | ||
export interface Metric<T> { | ||
/** | ||
* Returns a Handle associated with specified label values. | ||
* It is recommended to keep a reference to the Handle instead of always | ||
* calling this method for every operations. | ||
* @param labelValues the list of label values. | ||
*/ | ||
getHandle(labelValues: string[]): T; | ||
|
||
/** | ||
* Returns a Handle for a metric with all labels not set. | ||
*/ | ||
getDefaultHandle(): T; | ||
|
||
/** | ||
* Removes the Handle from the metric, if it is present. | ||
* @param labelValues the list of label values. | ||
*/ | ||
removeHandle(labelValues: string[]): void; | ||
|
||
/** | ||
* Clears all timeseries from the Metric. | ||
*/ | ||
clear(): void; | ||
|
||
/** | ||
* what should the callback signature be? | ||
*/ | ||
setCallback(fn: () => void): void; | ||
} |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.