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.
Adds 0 count for underflow/first bucket to [StackdriverStatsExporter] (…
…#181) * Drops 0 bound, moves [BucketBoundaries] logic to separate class * Fixes boundaries for [prometeus] * Removes redundant [BucketBondaries] tests from [opencensus-exporter-zpages] * Adds 0 count for underflow/first bucket to [StackdriverStatsExporter]
- Loading branch information
1 parent
18e8981
commit 2df1bc4
Showing
14 changed files
with
204 additions
and
170 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| /** | ||
| * Copyright 2018, 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 * as defaultLogger from '../common/console-logger'; | ||
| import * as loggerTypes from '../common/types'; | ||
| import {Bucket} from './types'; | ||
|
|
||
| export class BucketBoundaries { | ||
| readonly buckets: Bucket[]; | ||
| readonly bucketCounts: number[]; | ||
| /** An object to log information to */ | ||
| private logger: loggerTypes.Logger; | ||
|
|
||
| constructor(boundaries: number[], logger = defaultLogger) { | ||
| this.logger = logger.logger(); | ||
| this.buckets = this.dropNegativeBucketBounds(boundaries); | ||
| this.bucketCounts = this.getBucketCounts(this.buckets); | ||
| } | ||
|
|
||
| /** | ||
| * Gets bucket boundaries | ||
| */ | ||
| getBoundaries(): Bucket[] { | ||
| return this.buckets; | ||
| } | ||
|
|
||
| /** | ||
| * Gets initial bucket counts | ||
| */ | ||
| getCounts(): number[] { | ||
| return this.bucketCounts; | ||
| } | ||
|
|
||
| /** | ||
| * Drops negative (BucketBounds) are currently not supported by | ||
| * any of the backends that OC supports | ||
| * @param bucketBoundaries a list with the bucket boundaries | ||
| */ | ||
| private dropNegativeBucketBounds(bucketBoundaries: number[]): Bucket[] { | ||
| let negative = 0; | ||
| if (!bucketBoundaries) return []; | ||
| const result = bucketBoundaries.reduce((accumulator, boundary, index) => { | ||
| if (boundary > 0) { | ||
| const nextBoundary = bucketBoundaries[index + 1]; | ||
| this.validateBoundary(boundary, nextBoundary); | ||
| accumulator.push(boundary); | ||
| } else { | ||
| negative++; | ||
| } | ||
| return accumulator; | ||
| }, []); | ||
| if (negative) { | ||
| this.logger.warn(`Dropping ${ | ||
| negative} negative bucket boundaries, the values must be strictly > 0.`); | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
| /** | ||
| * Gets initial list of bucket counters | ||
| * @param buckets Bucket boundaries | ||
| */ | ||
| private getBucketCounts(buckets: Bucket[]): number[] { | ||
| if (!buckets) return []; | ||
| const bucketsCount = new Array(buckets.length + 1); | ||
| bucketsCount.fill(0); | ||
| return bucketsCount; | ||
| } | ||
|
|
||
| /** | ||
| * Checks boundaries order and duplicates | ||
| * @param current Boundary | ||
| * @param next Next boundary | ||
| */ | ||
| private validateBoundary(current: number, next: number) { | ||
| if (next) { | ||
| if (current > next) { | ||
| this.logger.error('Bucket boundaries not sorted.'); | ||
| } | ||
| if (current === next) { | ||
| this.logger.error('Bucket boundaries not unique.'); | ||
| } | ||
| } | ||
| } | ||
| } |
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,40 @@ | ||
| /** | ||
| * Copyright 2018, 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 * as assert from 'assert'; | ||
| import {BucketBoundaries} from '../src'; | ||
|
|
||
| describe('BucketBoundaries', () => { | ||
| it('should return boundaries', () => { | ||
| const buckets = new BucketBoundaries([1, 2, 3]); | ||
| assert.deepStrictEqual(buckets.getBoundaries(), [1, 2, 3]); | ||
| }); | ||
|
|
||
| it('should has bucket counts', () => { | ||
| const buckets = new BucketBoundaries([1, 2, 3]); | ||
| assert.deepStrictEqual(buckets.getCounts(), [0, 0, 0, 0]); | ||
| }); | ||
|
|
||
| describe('Drop negative and 0 boundaries', () => { | ||
| const buckets = new BucketBoundaries([-Infinity, -3, -2, -1, 0, 1, 2, 3]); | ||
| it('should drop negative and 0 boundaries', () => { | ||
| assert.deepStrictEqual(buckets.getBoundaries(), [1, 2, 3]); | ||
| }); | ||
| it('should has bucket counts', () => { | ||
| assert.deepStrictEqual(buckets.getCounts(), [0, 0, 0, 0]); | ||
| }); | ||
| }); | ||
| }); |
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
Oops, something went wrong.