This repository has been archived by the owner on Oct 3, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 96
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for derived cumulative metrics
- Loading branch information
1 parent
d4c3b19
commit 525cfa4
Showing
6 changed files
with
529 additions
and
86 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
170 changes: 170 additions & 0 deletions
170
packages/opencensus-core/src/metrics/cumulative/derived-cumulative.ts
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,170 @@ | ||
| /** | ||
| * Copyright 2019, OpenCensus 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 | ||
| * | ||
| * http://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 {getTimestampWithProcessHRTime} from '../../common/time-util'; | ||
| import {validateArrayElementsNotNull, validateNotNull} from '../../common/validations'; | ||
| import {LabelKey, LabelValue, Metric, MetricDescriptor, MetricDescriptorType, TimeSeries, Timestamp} from '../export/types'; | ||
| import {Meter} from '../types'; | ||
| import {AccessorInterface} from '../types'; | ||
| import * as util from '../utils'; | ||
|
|
||
| type ValueExtractor = () => number; | ||
|
|
||
| interface CumulativeEntry { | ||
| readonly labelValues: LabelValue[]; | ||
| readonly extractor: ValueExtractor; | ||
| prevValue: number; | ||
| } | ||
|
|
||
| /** | ||
| * DerivedCumulative metric is used to record aggregated metrics that | ||
| * represents a single numerical value accumulated over a time interval. | ||
| */ | ||
| export class DerivedCumulative implements Meter { | ||
| private metricDescriptor: MetricDescriptor; | ||
| private labelKeysLength: number; | ||
| private registeredPoints: Map<string, CumulativeEntry> = new Map(); | ||
| private extractor?: ValueExtractor; | ||
| private readonly constantLabelValues: LabelValue[]; | ||
| private startTime: Timestamp; | ||
|
|
||
| /** | ||
| * Constructs a new DerivedCumulative instance. | ||
| * | ||
| * @param {string} name The name of the metric. | ||
| * @param {string} description The description of the metric. | ||
| * @param {string} unit The unit of the metric. | ||
| * @param {MetricDescriptorType} type The type of metric. | ||
| * @param {LabelKey[]} labelKeys The list of the label keys. | ||
| * @param {Map<LabelKey, LabelValue>} constantLabels The map of constant | ||
| * labels for the Metric. | ||
| * @param {Timestamp} startTime The time when the cumulative metric start | ||
| * measuring the value. | ||
| */ | ||
| constructor( | ||
| name: string, description: string, unit: string, | ||
| type: MetricDescriptorType, labelKeys: LabelKey[], | ||
| readonly constantLabels: Map<LabelKey, LabelValue>, | ||
| startTime: Timestamp) { | ||
| this.labelKeysLength = labelKeys.length; | ||
| const keysAndConstantKeys = [...labelKeys, ...constantLabels.keys()]; | ||
| this.constantLabelValues = [...constantLabels.values()]; | ||
|
|
||
| this.metricDescriptor = | ||
| {name, description, unit, type, labelKeys: keysAndConstantKeys}; | ||
| this.startTime = startTime; | ||
| } | ||
|
|
||
| /** | ||
| * Creates a TimeSeries. The value of a single point in the TimeSeries is | ||
| * observed from a obj. The ValueExtractor is invoked whenever | ||
| * metrics are collected, meaning the reported value is up-to-date. | ||
| * | ||
| * @param {LabelValue[]} labelValues The list of the label values. | ||
| * @param objOrFn obj The obj to get the size or length or value from. If | ||
| * multiple options are available, the value (ToValueInterface) takes | ||
| * precedence first, followed by length and size. e.g value -> length -> | ||
| * size. | ||
| * fn is the function that will be called to get the current value | ||
| * of the cumulative. | ||
| */ | ||
| createTimeSeries(labelValues: LabelValue[], objOrFn: AccessorInterface): | ||
| void { | ||
| validateArrayElementsNotNull( | ||
| validateNotNull(labelValues, 'labelValues'), 'labelValue'); | ||
| validateNotNull(objOrFn, 'obj'); | ||
|
|
||
| const hash = util.hashLabelValues(labelValues); | ||
| if (this.registeredPoints.has(hash)) { | ||
| throw new Error( | ||
| 'A different time series with the same labels already exists.'); | ||
| } | ||
| if (this.labelKeysLength !== labelValues.length) { | ||
| throw new Error('Label Keys and Label Values don\'t have same size'); | ||
| } | ||
|
|
||
| if (objOrFn instanceof Function) { | ||
| this.extractor = objOrFn; | ||
| } else if (util.isToValueInterface(objOrFn)) { | ||
| this.extractor = () => objOrFn.getValue(); | ||
| } else if (util.isLengthAttributeInterface(objOrFn)) { | ||
| this.extractor = () => objOrFn.length; | ||
| } else if (util.isLengthMethodInterface(objOrFn)) { | ||
| this.extractor = () => objOrFn.length(); | ||
| } else if (util.isSizeAttributeInterface(objOrFn)) { | ||
| this.extractor = () => objOrFn.size; | ||
| } else if (util.isSizeMethodInterface(objOrFn)) { | ||
| this.extractor = () => objOrFn.size(); | ||
| } else { | ||
| throw new Error('Unknown interface/object type'); | ||
| } | ||
|
|
||
| this.registeredPoints.set( | ||
| hash, {labelValues, extractor: this.extractor, prevValue: 0}); | ||
| } | ||
|
|
||
| /** | ||
| * Removes the TimeSeries from the cumulative metric, if it is present. i.e. | ||
| * references to previous Point objects are invalid (not part of the | ||
| * metric). | ||
| * | ||
| * @param {LabelValue[]} labelValues The list of label values. | ||
| */ | ||
| removeTimeSeries(labelValues: LabelValue[]): void { | ||
| validateNotNull(labelValues, 'labelValues'); | ||
| this.registeredPoints.delete(util.hashLabelValues(labelValues)); | ||
| } | ||
|
|
||
| /** | ||
| * Removes all TimeSeries from the cumulative metric. i.e. references to all | ||
| * previous Point objects are invalid (not part of the metric). | ||
| */ | ||
| clear(): void { | ||
| this.registeredPoints.clear(); | ||
| } | ||
|
|
||
| /** | ||
| * Provides a Metric with one or more TimeSeries. | ||
| * | ||
| * @returns {Metric} The Metric, or null if TimeSeries is not present in | ||
| * Metric. | ||
| */ | ||
| getMetric(): Metric|null { | ||
| if (this.registeredPoints.size === 0) { | ||
| return null; | ||
| } | ||
| const timestamp: Timestamp = getTimestampWithProcessHRTime(); | ||
| return { | ||
| descriptor: this.metricDescriptor, | ||
| timeseries: Array.from( | ||
| this.registeredPoints, | ||
| ([_, cumulativeEntry]) => { | ||
| const newValue = cumulativeEntry.extractor(); | ||
| const value = newValue > cumulativeEntry.prevValue ? | ||
| newValue : | ||
| cumulativeEntry.prevValue; | ||
| cumulativeEntry.prevValue = value; | ||
|
|
||
| return { | ||
| labelValues: | ||
| [...cumulativeEntry.labelValues, ...this.constantLabelValues], | ||
| points: [{value, timestamp}], | ||
| startTimestamp: this.startTime | ||
| } as TimeSeries; | ||
| }) | ||
| }; | ||
| } | ||
| } |
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
Oops, something went wrong.