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

fix(sdk-metrics-base): only record non-negative histogram values. #3002

Merged
merged 5 commits into from
May 30, 2022
Merged

fix(sdk-metrics-base): only record non-negative histogram values. #3002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5687fb1
fix(sdk-metrics-base): only record non-negative histogram values.
pichlermarc May 30, 2022
b67b462
fix(sdk-metrics-base): adapt tests to use non-negative values.
pichlermarc May 30, 2022
ed38610
fix(sdk-metrics-base): add test that negative histogram values are dr…
pichlermarc May 30, 2022
f04f8cd
fix(changelog): add changelog entry.
pichlermarc May 30, 2022
eb1f0a9
Merge branch 'main' into fix-non-negative-histogram-values
pichlermarc May 30, 2022
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
2 changes: 2 additions & 0 deletions experimental/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ All notable changes to experimental packages in this project will be documented

### :bug: (Bug Fix)

* fix(sdk-metrics-base): only record non-negative histogram values #3002 @pichlermarc

### :books: (Refine Doc)

### :house: (Internal)
Expand Down
4 changes: 4 additions & 0 deletions experimental/packages/opentelemetry-sdk-metrics-base/src/Instruments.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,10 @@ export class HistogramInstrument extends SyncInstrument implements metrics.Histo
* Records a measurement. Value of the measurement must not be negative.
*/
record(value: number, attributes?: metrics.MetricAttributes, ctx?: api.Context): void {
if (value < 0) {
api.diag.warn(`negative value provided to histogram ${this._descriptor.name}: ${value}`);
return;
}
this._record(value, attributes, ctx);
}
}
Expand Down
62 changes: 51 additions & 11 deletions experimental/packages/opentelemetry-sdk-metrics-base/test/Instruments.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,24 @@ import * as assert from 'assert';
import * as sinon from 'sinon';
import { InstrumentationScope } from '@opentelemetry/core';
import { Resource } from '@opentelemetry/resources';
import { AggregationTemporality, InstrumentDescriptor, InstrumentType, MeterProvider, MetricReader, DataPoint, DataPointType } from '../src';
import {
AggregationTemporality,
InstrumentDescriptor,
InstrumentType,
MeterProvider,
MetricReader,
DataPoint,
DataPointType
} from '../src';
import { TestMetricReader } from './export/TestMetricReader';
import { assertMetricData, assertDataPoint, commonValues, commonAttributes, defaultResource, defaultInstrumentationScope } from './util';
import {
assertMetricData,
assertDataPoint,
commonValues,
commonAttributes,
defaultResource,
defaultInstrumentationScope
} from './util';
import { Histogram } from '../src/aggregator/types';
import { ObservableResult, ValueType } from '@opentelemetry/api-metrics';

Expand Down Expand Up @@ -257,10 +272,10 @@ describe('Instruments', () => {
});

histogram.record(10);
// -0.1 should be trunc-ed to -0
histogram.record(-0.1);
// 0.1 should be trunc-ed to 0
histogram.record(0.1);
histogram.record(100, { foo: 'bar' });
histogram.record(-0.1, { foo: 'bar' });
histogram.record(0.1, { foo: 'bar' });
await validateExport(deltaReader, {
descriptor: {
name: 'test',
Expand Down Expand Up @@ -297,6 +312,18 @@ describe('Instruments', () => {
});
});

it('should not record negative INT values', async () => {
const { meter, deltaReader } = setup();
const histogram = meter.createHistogram('test', {
valueType: ValueType.DOUBLE,
});

histogram.record(-1, { foo: 'bar' });
await validateExport(deltaReader, {
dataPointType: DataPointType.HISTOGRAM,
dataPoints: [],
});
});

it('should record DOUBLE values', async () => {
const { meter, deltaReader } = setup();
Expand All @@ -305,9 +332,9 @@ describe('Instruments', () => {
});

histogram.record(10);
histogram.record(-0.1);
histogram.record(0.1);
histogram.record(100, { foo: 'bar' });
histogram.record(-0.1, { foo: 'bar' });
histogram.record(0.1, { foo: 'bar' });
await validateExport(deltaReader, {
dataPointType: DataPointType.HISTOGRAM,
dataPoints: [
Expand All @@ -316,26 +343,39 @@ describe('Instruments', () => {
value: {
buckets: {
boundaries: [0, 5, 10, 25, 50, 75, 100, 250, 500, 1000],
counts: [1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0],
counts: [0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 0],
},
count: 2,
sum: 9.9,
sum: 10.1,
},
},
{
attributes: { foo: 'bar' },
value: {
buckets: {
boundaries: [0, 5, 10, 25, 50, 75, 100, 250, 500, 1000],
counts: [1, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0],
counts: [0, 1, 0, 0, 0, 0, 0, 1, 0, 0, 0],
},
count: 2,
sum: 99.9,
sum: 100.1,
},
},
],
});
});

it('should not record negative DOUBLE values', async () => {
const { meter, deltaReader } = setup();
const histogram = meter.createHistogram('test', {
valueType: ValueType.DOUBLE,
});

histogram.record(-0.5, { foo: 'bar' });
await validateExport(deltaReader, {
dataPointType: DataPointType.HISTOGRAM,
dataPoints: [],
});
});
});

describe('ObservableCounter', () => {
Expand Down