54 lines
2.1 KiB
JavaScript
54 lines
2.1 KiB
JavaScript
/*
|
|
* 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 { ValueType, diag, } from '@opentelemetry/api';
|
|
import { equalsCaseInsensitive } from './utils';
|
|
export function createInstrumentDescriptor(name, type, options) {
|
|
if (!isValidName(name)) {
|
|
diag.warn(`Invalid metric name: "${name}". The metric name should be a ASCII string with a length no greater than 255 characters.`);
|
|
}
|
|
return {
|
|
name,
|
|
type,
|
|
description: options?.description ?? '',
|
|
unit: options?.unit ?? '',
|
|
valueType: options?.valueType ?? ValueType.DOUBLE,
|
|
advice: options?.advice ?? {},
|
|
};
|
|
}
|
|
export function createInstrumentDescriptorWithView(view, instrument) {
|
|
return {
|
|
name: view.name ?? instrument.name,
|
|
description: view.description ?? instrument.description,
|
|
type: instrument.type,
|
|
unit: instrument.unit,
|
|
valueType: instrument.valueType,
|
|
advice: instrument.advice,
|
|
};
|
|
}
|
|
export function isDescriptorCompatibleWith(descriptor, otherDescriptor) {
|
|
// Names are case-insensitive strings.
|
|
return (equalsCaseInsensitive(descriptor.name, otherDescriptor.name) &&
|
|
descriptor.unit === otherDescriptor.unit &&
|
|
descriptor.type === otherDescriptor.type &&
|
|
descriptor.valueType === otherDescriptor.valueType);
|
|
}
|
|
// ASCII string with a length no greater than 255 characters.
|
|
// NB: the first character counted separately from the rest.
|
|
const NAME_REGEXP = /^[a-z][a-z0-9_.\-/]{0,254}$/i;
|
|
export function isValidName(name) {
|
|
return name.match(NAME_REGEXP) != null;
|
|
}
|
|
//# sourceMappingURL=InstrumentDescriptor.js.map
|