-
Notifications
You must be signed in to change notification settings - Fork 793
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.
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): metric names should be case-insensitive #4059
Merged
haddasbronfman
merged 4 commits into
open-telemetry:main
from
legendecas:metrics/metric-name
Sep 7, 2023
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,10 +25,12 @@ import { | |
ObservableUpDownCounter, | ||
BatchObservableCallback, | ||
Observable, | ||
diag, | ||
} from '@opentelemetry/api'; | ||
import { | ||
createInstrumentDescriptor, | ||
InstrumentType, | ||
isValidName, | ||
} from './InstrumentDescriptor'; | ||
import { | ||
CounterInstrument, | ||
|
@@ -50,6 +52,7 @@ export class Meter implements IMeter { | |
* Create a {@link Histogram} instrument. | ||
*/ | ||
createHistogram(name: string, options?: MetricOptions): Histogram { | ||
this._warnIfInvalidName(name); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is it possible to add the warning during the call to createInstrumentDescriptor? |
||
const descriptor = createInstrumentDescriptor( | ||
name, | ||
InstrumentType.HISTOGRAM, | ||
|
@@ -63,6 +66,7 @@ export class Meter implements IMeter { | |
* Create a {@link Counter} instrument. | ||
*/ | ||
createCounter(name: string, options?: MetricOptions): Counter { | ||
this._warnIfInvalidName(name); | ||
const descriptor = createInstrumentDescriptor( | ||
name, | ||
InstrumentType.COUNTER, | ||
|
@@ -76,6 +80,7 @@ export class Meter implements IMeter { | |
* Create a {@link UpDownCounter} instrument. | ||
*/ | ||
createUpDownCounter(name: string, options?: MetricOptions): UpDownCounter { | ||
this._warnIfInvalidName(name); | ||
const descriptor = createInstrumentDescriptor( | ||
name, | ||
InstrumentType.UP_DOWN_COUNTER, | ||
|
@@ -92,6 +97,7 @@ export class Meter implements IMeter { | |
name: string, | ||
options?: MetricOptions | ||
): ObservableGauge { | ||
this._warnIfInvalidName(name); | ||
const descriptor = createInstrumentDescriptor( | ||
name, | ||
InstrumentType.OBSERVABLE_GAUGE, | ||
|
@@ -113,6 +119,7 @@ export class Meter implements IMeter { | |
name: string, | ||
options?: MetricOptions | ||
): ObservableCounter { | ||
this._warnIfInvalidName(name); | ||
const descriptor = createInstrumentDescriptor( | ||
name, | ||
InstrumentType.OBSERVABLE_COUNTER, | ||
|
@@ -134,6 +141,7 @@ export class Meter implements IMeter { | |
name: string, | ||
options?: MetricOptions | ||
): ObservableUpDownCounter { | ||
this._warnIfInvalidName(name); | ||
const descriptor = createInstrumentDescriptor( | ||
name, | ||
InstrumentType.OBSERVABLE_UP_DOWN_COUNTER, | ||
|
@@ -173,4 +181,12 @@ export class Meter implements IMeter { | |
observables | ||
); | ||
} | ||
|
||
_warnIfInvalidName(name: string) { | ||
if (!isValidName(name)) { | ||
diag.warn( | ||
`Invalid metric name: "${name}". The metric name should be a ASCII string with a length no greater than 63 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is always good to include a comment with the description of the regex expression for easier reading
// ASCII string with a length no greater than 63 characters
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Names were increased to <=255 character length open-telemetry/opentelemetry-specification#3648