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(metrics): updates unit option behavior to be spec-compliant #2983

Merged
merged 8 commits into from
May 27, 2022
Merged

fix(metrics): updates unit option behavior to be spec-compliant #2983

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
989b8d0
fix(metrics): updates unit option behavior to be spec-compliant
andyfleming May 18, 2022
de30301
adjusts expectation for defaults for unit
andyfleming May 25, 2022
d32ec21
Merge branch 'main' of github.com:open-telemetry/opentelemetry-js int…
andyfleming May 25, 2022
e90d93b
updates unit value for tests
andyfleming May 26, 2022
743dd52
Merge branch 'main' into fix-2910-spec
dyladan May 27, 2022
42a753a
Add changelog entry
dyladan May 27, 2022
b8c50e8
Remove coersion of blank string to '1'
dyladan May 27, 2022
4a3fd25
Lint
dyladan May 27, 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
1 change: 1 addition & 0 deletions experimental/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ All notable changes to experimental packages in this project will be documented
* fix(otlp-exporter-base): include esm and esnext in package files #2952 @dyladan
* fix(otlp-http-exporter): update endpoint to match spec #2895 @svetlanabrennan
* fix(otlp-transformer): include esm and esnext in package files and update README #2992 @pichlermarc
* fix(metrics): specification compliant default metric unit #2983 @andyfleming

### :books: (Refine Doc)

Expand Down
6 changes: 3 additions & 3 deletions experimental/packages/opentelemetry-exporter-metrics-otlp-grpc/test/metricsHelper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ export function ensureExportedCounterIsCorrect(
assert.deepStrictEqual(metric, {
name: 'int-counter',
description: 'sample counter description',
unit: '1',
unit: '',
data: 'sum',
sum: {
dataPoints: [
Expand Down Expand Up @@ -159,7 +159,7 @@ export function ensureExportedObservableGaugeIsCorrect(
assert.deepStrictEqual(metric, {
name: 'double-observable-gauge',
description: 'sample observable gauge description',
unit: '1',
unit: '',
data: 'gauge',
gauge: {
dataPoints: [
Expand Down Expand Up @@ -187,7 +187,7 @@ export function ensureExportedHistogramIsCorrect(
assert.deepStrictEqual(metric, {
name: 'int-histogram',
description: 'sample histogram description',
unit: '1',
unit: '',
data: 'histogram',
histogram: {
dataPoints: [
Expand Down
12 changes: 6 additions & 6 deletions experimental/packages/opentelemetry-exporter-metrics-otlp-http/test/metricsHelper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ export function ensureCounterIsCorrect(
assert.deepStrictEqual(metric, {
name: 'int-counter',
description: 'sample counter description',
unit: '1',
unit: '',
sum: {
dataPoints: [
{
Expand All @@ -261,7 +261,7 @@ export function ensureDoubleCounterIsCorrect(
assert.deepStrictEqual(metric, {
name: 'double-counter',
description: 'sample counter description',
unit: '1',
unit: '',
doubleSum: {
dataPoints: [
{
Expand All @@ -287,7 +287,7 @@ export function ensureObservableGaugeIsCorrect(
assert.deepStrictEqual(metric, {
name,
description: 'sample observable gauge description',
unit: '1',
unit: '',
gauge: {
dataPoints: [
{
Expand All @@ -311,7 +311,7 @@ export function ensureObservableCounterIsCorrect(
assert.deepStrictEqual(metric, {
name,
description: 'sample observable counter description',
unit: '1',
unit: '',
doubleSum: {
isMonotonic: true,
dataPoints: [
Expand All @@ -337,7 +337,7 @@ export function ensureObservableUpDownCounterIsCorrect(
assert.deepStrictEqual(metric, {
name,
description: 'sample observable up down counter description',
unit: '1',
unit: '',
doubleSum: {
isMonotonic: false,
dataPoints: [
Expand All @@ -363,7 +363,7 @@ export function ensureHistogramIsCorrect(
assert.deepStrictEqual(metric, {
name: 'int-histogram',
description: 'sample histogram description',
unit: '1',
unit: '',
histogram: {
dataPoints: [
{
Expand Down
6 changes: 3 additions & 3 deletions experimental/packages/opentelemetry-exporter-metrics-otlp-proto/test/metricsHelper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ export function ensureExportedCounterIsCorrect(
assert.deepStrictEqual(metric, {
name: 'int-counter',
description: 'sample counter description',
unit: '1',
unit: '',
sum: {
dataPoints: [
{
Expand All @@ -158,7 +158,7 @@ export function ensureExportedObservableGaugeIsCorrect(
assert.deepStrictEqual(metric, {
name: 'double-observable-gauge',
description: 'sample observable gauge description',
unit: '1',
unit: '',
gauge: {
dataPoints: [
{
Expand All @@ -181,7 +181,7 @@ export function ensureExportedHistogramIsCorrect(
assert.deepStrictEqual(metric, {
name: 'int-histogram',
description: 'sample histogram description',
unit: '1',
unit: '',
histogram: {
dataPoints: [
{
Expand Down
2 changes: 1 addition & 1 deletion experimental/packages/opentelemetry-sdk-metrics-base/src/InstrumentDescriptor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export function createInstrumentDescriptor(name: string, type: InstrumentType, o
name,
type,
description: options?.description ?? '',
unit: options?.unit ?? '1',
unit: options?.unit ?? '',
valueType: options?.valueType ?? ValueType.DOUBLE,
};
}
Expand Down
31 changes: 31 additions & 0 deletions experimental/packages/opentelemetry-sdk-metrics-base/test/InstrumentDescriptor.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
/*
* Copyright The 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 * as assert from 'assert';
import {createInstrumentDescriptor, InstrumentType} from '../src/InstrumentDescriptor';

describe('InstrumentDescriptor', () => {
describe('createInstrumentDescriptor', () => {
for (const val of [null, undefined]) {
it(`should interpret an empty unit value as a blank string (${val})`, () => {
const result = createInstrumentDescriptor('example', InstrumentType.COUNTER, {
unit: val as any,
});
assert.strictEqual(result.unit, '');
});
}
});
});
6 changes: 3 additions & 3 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 @@ -64,7 +64,7 @@ describe('Instruments', () => {
descriptor: {
name: 'test',
description: '',
unit: '1',
unit: '',
type: InstrumentType.COUNTER,
valueType: ValueType.INT,
},
Expand Down Expand Up @@ -180,7 +180,7 @@ describe('Instruments', () => {
descriptor: {
name: 'test',
description: '',
unit: '1',
unit: '',
type: InstrumentType.UP_DOWN_COUNTER,
valueType: ValueType.INT,
},
Expand Down Expand Up @@ -265,7 +265,7 @@ describe('Instruments', () => {
descriptor: {
name: 'test',
description: '',
unit: '1',
unit: '',
type: InstrumentType.HISTOGRAM,
valueType: ValueType.INT,
},
Expand Down