open-telemetry
/
opentelemetry-js
mirror of https://github.com/open-telemetry/opentelemetry-js.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

refactor: normalize namespace import name for @opentelemetry/api (#1016)

This commit is contained in:
legendecas 2020-05-06 01:38:12 +08:00 committed by GitHub
parent 16ae2a7513
commit b1ea4543e7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
23 changed files with 184 additions and 188 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
packages/opentelemetry-core/src/common/time.ts
View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
import { otperformance as performance } from '../platform';
import { TimeOriginLegacy } from './types';
@ -25,7 +25,7 @@ const SECOND_TO_NANOSECONDS = Math.pow(10, NANOSECOND_DIGITS);
* Converts a number to HrTime
* @param epochMillis
*/
function numberToHrtime(epochMillis: number): types.HrTime {
function numberToHrtime(epochMillis: number): api.HrTime {
const epochSeconds = epochMillis / 1000;
// Decimals only.
const seconds = Math.trunc(epochSeconds);
@ -49,7 +49,7 @@ function getTimeOrigin(): number {
* Returns an hrtime calculated via performance component.
* @param performanceNow
*/
export function hrTime(performanceNow?: number): types.HrTime {
export function hrTime(performanceNow?: number): api.HrTime {
const timeOrigin = numberToHrtime(getTimeOrigin());
const now = numberToHrtime(
typeof performanceNow === 'number' ? performanceNow : performance.now()
@ -72,10 +72,10 @@ export function hrTime(performanceNow?: number): types.HrTime {
* Converts a TimeInput to an HrTime, defaults to _hrtime().
* @param time
*/
export function timeInputToHrTime(time: types.TimeInput): types.HrTime {
export function timeInputToHrTime(time: api.TimeInput): api.HrTime {
// process.hrtime
if (isTimeInputHrTime(time)) {
return time as types.HrTime;
return time as api.HrTime;
} else if (typeof time === 'number') {
// Must be a performance.now() if it's smaller than process start time.
if (time < getTimeOrigin()) {
@ -97,9 +97,9 @@ export function timeInputToHrTime(time: types.TimeInput): types.HrTime {
* @param endTime
*/
export function hrTimeDuration(
startTime: types.HrTime,
endTime: types.HrTime
): types.HrTime {
startTime: api.HrTime,
endTime: api.HrTime
): api.HrTime {
let seconds = endTime[0] - startTime[0];
let nanos = endTime[1] - startTime[1];
@ -117,7 +117,7 @@ export function hrTimeDuration(
* Convert hrTime to timestamp, for example "2019-05-14T17:00:00.000123456Z"
* @param hrTime
*/
export function hrTimeToTimeStamp(hrTime: types.HrTime): string {
export function hrTimeToTimeStamp(hrTime: api.HrTime): string {
const precision = NANOSECOND_DIGITS;
const tmp = `${'0'.repeat(precision)}${hrTime[1]}Z`;
const nanoString = tmp.substr(tmp.length - precision - 1);
@ -129,7 +129,7 @@ export function hrTimeToTimeStamp(hrTime: types.HrTime): string {
* Convert hrTime to nanoseconds.
* @param hrTime
*/
export function hrTimeToNanoseconds(hrTime: types.HrTime): number {
export function hrTimeToNanoseconds(hrTime: api.HrTime): number {
return hrTime[0] * SECOND_TO_NANOSECONDS + hrTime[1];
}
@ -137,7 +137,7 @@ export function hrTimeToNanoseconds(hrTime: types.HrTime): number {
* Convert hrTime to milliseconds.
* @param hrTime
*/
export function hrTimeToMilliseconds(hrTime: types.HrTime): number {
export function hrTimeToMilliseconds(hrTime: api.HrTime): number {
return Math.round(hrTime[0] * 1e3 + hrTime[1] / 1e6);
}
@ -145,7 +145,7 @@ export function hrTimeToMilliseconds(hrTime: types.HrTime): number {
* Convert hrTime to microseconds.
* @param hrTime
*/
export function hrTimeToMicroseconds(hrTime: types.HrTime): number {
export function hrTimeToMicroseconds(hrTime: api.HrTime): number {
return Math.round(hrTime[0] * 1e6 + hrTime[1] / 1e3);
}

4
packages/opentelemetry-core/src/trace/TraceState.ts
View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
import { validateKey, validateValue } from '../internal/validators';
const MAX_TRACE_STATE_ITEMS = 32;
@ -31,7 +31,7 @@ const LIST_MEMBER_KEY_VALUE_SPLITTER = '=';
* - The value of any key can be updated. Modified keys MUST be moved to the
* beginning of the list.
*/
export class TraceState implements types.TraceState {
export class TraceState implements api.TraceState {
private _internalState: Map<string, string> = new Map();
constructor(rawTraceState?: string) {

12
packages/opentelemetry-core/test/common/time.test.ts
View File

@ -17,7 +17,7 @@
import * as assert from 'assert';
import { otperformance as performance } from '../../src/platform';
import * as sinon from 'sinon';
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
import {
hrTime,
timeInputToHrTime,
@ -141,16 +141,16 @@ describe('time', () => {
describe('#hrTimeDuration', () => {
it('should return duration', () => {
const startTime: types.HrTime = [22, 400000000];
const endTime: types.HrTime = [32, 800000000];
const startTime: api.HrTime = [22, 400000000];
const endTime: api.HrTime = [32, 800000000];
const output = hrTimeDuration(startTime, endTime);
assert.deepStrictEqual(output, [10, 400000000]);
});
it('should handle nanosecond overflow', () => {
const startTime: types.HrTime = [22, 400000000];
const endTime: types.HrTime = [32, 200000000];
const startTime: api.HrTime = [22, 400000000];
const endTime: api.HrTime = [32, 200000000];
const output = hrTimeDuration(startTime, endTime);
assert.deepStrictEqual(output, [9, 800000000]);
@ -159,7 +159,7 @@ describe('time', () => {
describe('#hrTimeToTimeStamp', () => {
it('should return timestamp', () => {
const time: types.HrTime = [1573513121, 123456];
const time: api.HrTime = [1573513121, 123456];
const output = hrTimeToTimeStamp(time);
assert.deepStrictEqual(output, '2019-11-11T22:58:41.000123456Z');

4
packages/opentelemetry-exporter-jaeger/src/types.ts
View File

@ -14,13 +14,13 @@
* limitations under the License.
*/
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
/**
* Options for Jaeger configuration
*/
export interface ExporterConfig {
logger?: types.Logger;
logger?: api.Logger;
serviceName: string;
tags?: Tag[];
host?: string; // default: 'localhost'

6
packages/opentelemetry-exporter-jaeger/test/jaeger.test.ts
View File

@ -17,7 +17,7 @@
import * as assert from 'assert';
import { JaegerExporter } from '../src';
import { ExportResult, NoopLogger } from '@opentelemetry/core';
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
import { ThriftProcess } from '../src/types';
import { ReadableSpan } from '@opentelemetry/tracing';
import { TraceFlags } from '@opentelemetry/api';
@ -130,13 +130,13 @@ describe('JaegerExporter', () => {
};
const readableSpan: ReadableSpan = {
name: 'my-span1',
kind: types.SpanKind.CLIENT,
kind: api.SpanKind.CLIENT,
spanContext,
startTime: [1566156729, 709],
endTime: [1566156731, 709],
ended: true,
status: {
code: types.CanonicalCode.DATA_LOSS,
code: api.CanonicalCode.DATA_LOSS,
},
attributes: {},
links: [],

18
packages/opentelemetry-exporter-jaeger/test/transform.test.ts
View File

@ -18,7 +18,7 @@ import * as assert from 'assert';
import { spanToThrift } from '../src/transform';
import { ReadableSpan } from '@opentelemetry/tracing';
import { Resource } from '@opentelemetry/resources';
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
import { ThriftUtils, Utils, ThriftReferenceType } from '../src/types';
import { hrTimeToMicroseconds } from '@opentelemetry/core';
import { TraceFlags } from '@opentelemetry/api';
@ -34,13 +34,13 @@ describe('transform', () => {
it('should convert an OpenTelemetry span to a Thrift', () => {
const readableSpan: ReadableSpan = {
name: 'my-span',
kind: types.SpanKind.INTERNAL,
kind: api.SpanKind.INTERNAL,
spanContext,
startTime: [1566156729, 709],
endTime: [1566156731, 709],
ended: true,
status: {
code: types.CanonicalCode.OK,
code: api.CanonicalCode.OK,
},
attributes: {
testBool: true,
@ -155,13 +155,13 @@ describe('transform', () => {
it('should convert an OpenTelemetry span to a Thrift when links, events and attributes are empty', () => {
const readableSpan: ReadableSpan = {
name: 'my-span1',
kind: types.SpanKind.CLIENT,
kind: api.SpanKind.CLIENT,
spanContext,
startTime: [1566156729, 709],
endTime: [1566156731, 709],
ended: true,
status: {
code: types.CanonicalCode.DATA_LOSS,
code: api.CanonicalCode.DATA_LOSS,
message: 'data loss',
},
attributes: {},
@ -213,13 +213,13 @@ describe('transform', () => {
it('should convert an OpenTelemetry span to a Thrift with ThriftReference', () => {
const readableSpan: ReadableSpan = {
name: 'my-span',
kind: types.SpanKind.INTERNAL,
kind: api.SpanKind.INTERNAL,
spanContext,
startTime: [1566156729, 709],
endTime: [1566156731, 709],
ended: true,
status: {
code: types.CanonicalCode.OK,
code: api.CanonicalCode.OK,
},
attributes: {},
parentSpanId: '3e0c63257de34c92',
@ -255,7 +255,7 @@ describe('transform', () => {
it('should left pad trace ids', () => {
const readableSpan: ReadableSpan = {
name: 'my-span1',
kind: types.SpanKind.CLIENT,
kind: api.SpanKind.CLIENT,
spanContext: {
traceId: '92b449d5929fda1b',
spanId: '6e0c63257de34c92',
@ -265,7 +265,7 @@ describe('transform', () => {
endTime: [1566156731, 709],
ended: true,
status: {
code: types.CanonicalCode.DATA_LOSS,
code: api.CanonicalCode.DATA_LOSS,
message: 'data loss',
},
attributes: {},

4
packages/opentelemetry-exporter-prometheus/src/export/types.ts
View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
/**
* Configuration interface for prometheus exporter
@ -49,5 +49,5 @@ export interface ExporterConfig {
startServer?: boolean;
/** Standard logging interface */
logger?: types.Logger;
logger?: api.Logger;
}

6
packages/opentelemetry-exporter-prometheus/src/prometheus.ts
View File

@ -29,7 +29,7 @@ import {
ObserverAggregator,
Sum,
} from '@opentelemetry/metrics';
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
import { createServer, IncomingMessage, Server, ServerResponse } from 'http';
import { Counter, Gauge, labelValues, Metric, Registry } from 'prom-client';
import * as url from 'url';
@ -44,7 +44,7 @@ export class PrometheusExporter implements MetricExporter {
};
private readonly _registry = new Registry();
private readonly _logger: types.Logger;
private readonly _logger: api.Logger;
private readonly _port: number;
private readonly _endpoint: string;
private readonly _server: Server;
@ -159,7 +159,7 @@ export class PrometheusExporter implements MetricExporter {
// TODO: only counter and gauge are implemented in metrics so far
}
private _getLabelValues(keys: string[], labels: types.Labels) {
private _getLabelValues(keys: string[], labels: api.Labels) {
const labelValues: labelValues = {};
for (let i = 0; i < keys.length; i++) {
if (labels[keys[i]] !== null) {

20
packages/opentelemetry-exporter-zipkin/src/transform.ts
View File

@ -14,19 +14,19 @@
* limitations under the License.
*/
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
import { ReadableSpan } from '@opentelemetry/tracing';
import { hrTimeToMicroseconds } from '@opentelemetry/core';
import * as zipkinTypes from './types';
import { Resource } from '@opentelemetry/resources';
const ZIPKIN_SPAN_KIND_MAPPING = {
[types.SpanKind.CLIENT]: zipkinTypes.SpanKind.CLIENT,
[types.SpanKind.SERVER]: zipkinTypes.SpanKind.SERVER,
[types.SpanKind.CONSUMER]: zipkinTypes.SpanKind.CONSUMER,
[types.SpanKind.PRODUCER]: zipkinTypes.SpanKind.PRODUCER,
[api.SpanKind.CLIENT]: zipkinTypes.SpanKind.CLIENT,
[api.SpanKind.SERVER]: zipkinTypes.SpanKind.SERVER,
[api.SpanKind.CONSUMER]: zipkinTypes.SpanKind.CONSUMER,
[api.SpanKind.PRODUCER]: zipkinTypes.SpanKind.PRODUCER,
// When absent, the span is local.
[types.SpanKind.INTERNAL]: undefined,
[api.SpanKind.INTERNAL]: undefined,
};
export const statusCodeTagName = 'ot.status_code';
@ -68,8 +68,8 @@ export function toZipkinSpan(
/** Converts OpenTelemetry Attributes and Status to Zipkin Tags format. */
export function _toZipkinTags(
attributes: types.Attributes,
status: types.Status,
attributes: api.Attributes,
status: api.Status,
statusCodeTagName: string,
statusDescriptionTagName: string,
resource: Resource
@ -78,7 +78,7 @@ export function _toZipkinTags(
for (const key of Object.keys(attributes)) {
tags[key] = String(attributes[key]);
}
tags[statusCodeTagName] = String(types.CanonicalCode[status.code]);
tags[statusCodeTagName] = String(api.CanonicalCode[status.code]);
if (status.message) {
tags[statusDescriptionTagName] = status.message;
}
@ -94,7 +94,7 @@ export function _toZipkinTags(
* Converts OpenTelemetry Events to Zipkin Annotations format.
*/
export function _toZipkinAnnotations(
events: types.TimedEvent[]
events: api.TimedEvent[]
): zipkinTypes.Annotation[] {
return events.map(event => ({
timestamp: hrTimeToMicroseconds(event.time),

4
packages/opentelemetry-exporter-zipkin/src/types.ts
View File

@ -14,13 +14,13 @@
* limitations under the License.
*/
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
/**
* Exporter config
*/
export interface ExporterConfig {
logger?: types.Logger;
logger?: api.Logger;
serviceName: string;
url?: string;
// Optional mapping overrides for OpenTelemetry status code and description.

4
packages/opentelemetry-exporter-zipkin/src/zipkin.ts
View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
import * as http from 'http';
import * as https from 'https';
import * as url from 'url';
@ -32,7 +32,7 @@ import { OT_REQUEST_HEADER } from './utils';
*/
export class ZipkinExporter implements SpanExporter {
static readonly DEFAULT_URL = 'http://localhost:9411/api/v2/spans';
private readonly _logger: types.Logger;
private readonly _logger: api.Logger;
private readonly _serviceName: string;
private readonly _statusCodeTagName: string;
private readonly _statusDescriptionTagName: string;

38
packages/opentelemetry-exporter-zipkin/test/transform.test.ts
View File

@ -15,7 +15,7 @@
*/
import * as assert from 'assert';
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
import { Span, BasicTracerProvider } from '@opentelemetry/tracing';
import {
NoopLogger,
@ -38,10 +38,10 @@ const tracer = new BasicTracerProvider({
logger,
}).getTracer('default');
const parentId = '5c1c63257de34c67';
const spanContext: types.SpanContext = {
const spanContext: api.SpanContext = {
traceId: 'd4cda95b652f4a1592b449d5929fda1b',
spanId: '6e0c63257de34c92',
traceFlags: types.TraceFlags.SAMPLED,
traceFlags: api.TraceFlags.SAMPLED,
};
const DUMMY_RESOUCE = new Resource({
@ -57,7 +57,7 @@ describe('transform', () => {
tracer,
'my-span',
spanContext,
types.SpanKind.SERVER,
api.SpanKind.SERVER,
parentId
);
span.setAttributes({
@ -107,7 +107,7 @@ describe('transform', () => {
tracer,
'my-span',
spanContext,
types.SpanKind.SERVER
api.SpanKind.SERVER
);
span.end();
@ -141,14 +141,14 @@ describe('transform', () => {
});
// SpanKind mapping tests
[
{ ot: types.SpanKind.CLIENT, zipkin: 'CLIENT' },
{ ot: types.SpanKind.SERVER, zipkin: 'SERVER' },
{ ot: types.SpanKind.CONSUMER, zipkin: 'CONSUMER' },
{ ot: types.SpanKind.PRODUCER, zipkin: 'PRODUCER' },
{ ot: types.SpanKind.INTERNAL, zipkin: undefined },
{ ot: api.SpanKind.CLIENT, zipkin: 'CLIENT' },
{ ot: api.SpanKind.SERVER, zipkin: 'SERVER' },
{ ot: api.SpanKind.CONSUMER, zipkin: 'CONSUMER' },
{ ot: api.SpanKind.PRODUCER, zipkin: 'PRODUCER' },
{ ot: api.SpanKind.INTERNAL, zipkin: undefined },
].forEach(item =>
it(`should map OpenTelemetry SpanKind ${
types.SpanKind[item.ot]
api.SpanKind[item.ot]
} to Zipkin ${item.zipkin}`, () => {
const span = new Span(tracer, 'my-span', spanContext, item.ot);
span.end();
@ -190,7 +190,7 @@ describe('transform', () => {
tracer,
'my-span',
spanContext,
types.SpanKind.SERVER,
api.SpanKind.SERVER,
parentId
);
span.setAttributes({
@ -219,11 +219,11 @@ describe('transform', () => {
tracer,
'my-span',
spanContext,
types.SpanKind.SERVER,
api.SpanKind.SERVER,
parentId
);
const status: types.Status = {
code: types.CanonicalCode.ABORTED,
const status: api.Status = {
code: api.CanonicalCode.ABORTED,
};
span.setStatus(status);
span.setAttributes({
@ -249,11 +249,11 @@ describe('transform', () => {
tracer,
'my-span',
spanContext,
types.SpanKind.SERVER,
api.SpanKind.SERVER,
parentId
);
const status: types.Status = {
code: types.CanonicalCode.ABORTED,
const status: api.Status = {
code: api.CanonicalCode.ABORTED,
message: 'my-message',
};
span.setStatus(status);
@ -284,7 +284,7 @@ describe('transform', () => {
tracer,
'my-span',
spanContext,
types.SpanKind.SERVER,
api.SpanKind.SERVER,
parentId
);
span.addEvent('my-event1');

14
packages/opentelemetry-exporter-zipkin/test/zipkin.test.ts
View File

@ -22,7 +22,7 @@ import {
NoopLogger,
hrTimeToMicroseconds,
} from '@opentelemetry/core';
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
import { Resource } from '@opentelemetry/resources';
import { ZipkinExporter } from '../src';
import * as zipkinTypes from '../src/types';
@ -36,7 +36,7 @@ function getReadableSpan() {
const duration = 2000;
const readableSpan: ReadableSpan = {
name: 'my-span',
kind: types.SpanKind.INTERNAL,
kind: api.SpanKind.INTERNAL,
spanContext: {
traceId: 'd4cda95b652f4a1592b449d5929fda1b',
spanId: '6e0c63257de34c92',
@ -47,7 +47,7 @@ function getReadableSpan() {
ended: true,
duration: [duration, 0],
status: {
code: types.CanonicalCode.OK,
code: api.CanonicalCode.OK,
},
attributes: {},
links: [],
@ -133,7 +133,7 @@ describe('ZipkinExporter', () => {
const span1: ReadableSpan = {
name: 'my-span',
kind: types.SpanKind.INTERNAL,
kind: api.SpanKind.INTERNAL,
parentSpanId,
spanContext: {
traceId: 'd4cda95b652f4a1592b449d5929fda1b',
@ -145,7 +145,7 @@ describe('ZipkinExporter', () => {
ended: true,
duration: [duration, 0],
status: {
code: types.CanonicalCode.OK,
code: api.CanonicalCode.OK,
},
attributes: {
key1: 'value1',
@ -163,7 +163,7 @@ describe('ZipkinExporter', () => {
};
const span2: ReadableSpan = {
name: 'my-span',
kind: types.SpanKind.SERVER,
kind: api.SpanKind.SERVER,
spanContext: {
traceId: 'd4cda95b652f4a1592b449d5929fda1b',
spanId: '6e0c63257de34c92',
@ -174,7 +174,7 @@ describe('ZipkinExporter', () => {
ended: true,
duration: [duration, 0],
status: {
code: types.CanonicalCode.OK,
code: api.CanonicalCode.OK,
},
attributes: {},
links: [],

46
packages/opentelemetry-metrics/src/BoundInstrument.ts
View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
import { Aggregator } from './export/types';
import { ObserverResult } from './ObserverResult';
@ -23,16 +23,16 @@ import { ObserverResult } from './ObserverResult';
* the TimeSeries.
*/
export class BaseBoundInstrument {
protected _labels: types.Labels;
protected _logger: types.Logger;
protected _labels: api.Labels;
protected _logger: api.Logger;
protected _monotonic: boolean;
constructor(
labels: types.Labels,
logger: types.Logger,
labels: api.Labels,
logger: api.Logger,
monotonic: boolean,
private readonly _disabled: boolean,
private readonly _valueType: types.ValueType,
private readonly _valueType: api.ValueType,
private readonly _aggregator: Aggregator
) {
this._labels = labels;
@ -43,7 +43,7 @@ export class BaseBoundInstrument {
update(value: number): void {
if (this._disabled) return;
if (this._valueType === types.ValueType.INT && !Number.isInteger(value)) {
if (this._valueType === api.ValueType.INT && !Number.isInteger(value)) {
this._logger.warn(
`INT value type cannot accept a floating-point value for ${Object.values(
this._labels
@ -55,7 +55,7 @@ export class BaseBoundInstrument {
this._aggregator.update(value);
}
getLabels(): types.Labels {
getLabels(): api.Labels {
return this._labels;
}
@ -69,13 +69,13 @@ export class BaseBoundInstrument {
* value of single instrument in the `Counter` associated with specified Labels.
*/
export class BoundCounter extends BaseBoundInstrument
implements types.BoundCounter {
implements api.BoundCounter {
constructor(
labels: types.Labels,
labels: api.Labels,
disabled: boolean,
monotonic: boolean,
valueType: types.ValueType,
logger: types.Logger,
valueType: api.ValueType,
logger: api.Logger,
aggregator: Aggregator
) {
super(labels, logger, monotonic, disabled, valueType, aggregator);
@ -97,16 +97,16 @@ export class BoundCounter extends BaseBoundInstrument
* BoundMeasure is an implementation of the {@link BoundMeasure} interface.
*/
export class BoundMeasure extends BaseBoundInstrument
implements types.BoundMeasure {
implements api.BoundMeasure {
private readonly _absolute: boolean;
constructor(
labels: types.Labels,
labels: api.Labels,
disabled: boolean,
monotonic: boolean,
absolute: boolean,
valueType: types.ValueType,
logger: types.Logger,
valueType: api.ValueType,
logger: api.Logger,
aggregator: Aggregator
) {
super(labels, logger, monotonic, disabled, valueType, aggregator);
@ -115,8 +115,8 @@ export class BoundMeasure extends BaseBoundInstrument
record(
value: number,
correlationContext?: types.CorrelationContext,
spanContext?: types.SpanContext
correlationContext?: api.CorrelationContext,
spanContext?: api.SpanContext
): void {
if (this._absolute && value < 0) {
this._logger.error(
@ -135,19 +135,19 @@ export class BoundMeasure extends BaseBoundInstrument
* BoundObserver is an implementation of the {@link BoundObserver} interface.
*/
export class BoundObserver extends BaseBoundInstrument
implements types.BoundObserver {
implements api.BoundObserver {
constructor(
labels: types.Labels,
labels: api.Labels,
disabled: boolean,
monotonic: boolean,
valueType: types.ValueType,
logger: types.Logger,
valueType: api.ValueType,
logger: api.Logger,
aggregator: Aggregator
) {
super(labels, logger, monotonic, disabled, valueType, aggregator);
}
setCallback(callback: (observerResult: types.ObserverResult) => void): void {
setCallback(callback: (observerResult: api.ObserverResult) => void): void {
const observerResult = new ObserverResult();
callback(observerResult);
}

24
packages/opentelemetry-metrics/src/Meter.ts
View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
import { ConsoleLogger } from '@opentelemetry/core';
import { Resource } from '@opentelemetry/resources';
import { BaseBoundInstrument } from './BoundInstrument';
@ -32,8 +32,8 @@ import { NoopExporter } from './export/NoopExporter';
/**
* Meter is an implementation of the {@link Meter} interface.
*/
export class Meter implements types.Meter {
private readonly _logger: types.Logger;
export class Meter implements api.Meter {
private readonly _logger: api.Logger;
private readonly _metrics = new Map<string, Metric<BaseBoundInstrument>>();
private readonly _batcher: Batcher;
private readonly _resource: Resource;
@ -58,13 +58,13 @@ export class Meter implements types.Meter {
*/
createMeasure(
name: string,
options?: types.MetricOptions
): types.Metric<types.BoundMeasure> {
options?: api.MetricOptions
): api.Metric<api.BoundMeasure> {
if (!this._isValidName(name)) {
this._logger.warn(
`Invalid metric name ${name}. Defaulting to noop metric implementation.`
);
return types.NOOP_MEASURE_METRIC;
return api.NOOP_MEASURE_METRIC;
}
const opt: MetricOptions = {
absolute: true, // Measures are defined as absolute by default
@ -88,13 +88,13 @@ export class Meter implements types.Meter {
*/
createCounter(
name: string,
options?: types.MetricOptions
): types.Metric<types.BoundCounter> {
options?: api.MetricOptions
): api.Metric<api.BoundCounter> {
if (!this._isValidName(name)) {
this._logger.warn(
`Invalid metric name ${name}. Defaulting to noop metric implementation.`
);
return types.NOOP_COUNTER_METRIC;
return api.NOOP_COUNTER_METRIC;
}
const opt: MetricOptions = {
monotonic: true, // Counters are defined as monotonic by default
@ -115,13 +115,13 @@ export class Meter implements types.Meter {
*/
createObserver(
name: string,
options?: types.MetricOptions
): types.Metric<types.BoundObserver> {
options?: api.MetricOptions
): api.Metric<api.BoundObserver> {
if (!this._isValidName(name)) {
this._logger.warn(
`Invalid metric name ${name}. Defaulting to noop metric implementation.`
);
return types.NOOP_OBSERVER_METRIC;
return api.NOOP_OBSERVER_METRIC;
}
const opt: MetricOptions = {
monotonic: false, // Observers are defined as non-monotonic by default

6
packages/opentelemetry-metrics/src/MeterProvider.ts
View File

@ -15,7 +15,7 @@
*/
import { ConsoleLogger } from '@opentelemetry/core';
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
import { Resource } from '@opentelemetry/resources';
import { Meter } from '.';
import { DEFAULT_CONFIG, MeterConfig } from './types';
@ -23,10 +23,10 @@ import { DEFAULT_CONFIG, MeterConfig } from './types';
/**
* This class represents a meter provider which platform libraries can extend
*/
export class MeterProvider implements types.MeterProvider {
export class MeterProvider implements api.MeterProvider {
private readonly _meters: Map<string, Meter> = new Map();
readonly resource: Resource = Resource.createTelemetrySDKResource();
readonly logger: types.Logger;
readonly logger: api.Logger;
constructor(private _config: MeterConfig = DEFAULT_CONFIG) {
this.logger = _config.logger || new ConsoleLogger(_config.logLevel);

8
packages/opentelemetry-metrics/test/Batcher.test.ts
View File

@ -15,16 +15,16 @@
*/
import * as assert from 'assert';
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
import { NoopLogger } from '@opentelemetry/core';
import { Meter, MeterProvider } from '../src';
describe('Batcher', () => {
describe('Ungrouped', () => {
let meter: Meter;
let fooCounter: types.BoundCounter;
let barCounter: types.BoundCounter;
let counter: types.Metric<types.BoundCounter>;
let fooCounter: api.BoundCounter;
let barCounter: api.BoundCounter;
let counter: api.Metric<api.BoundCounter>;
beforeEach(() => {
meter = new MeterProvider({
logger: new NoopLogger(),

26
packages/opentelemetry-metrics/test/Meter.test.ts
View File

@ -30,7 +30,7 @@ import {
MetricObservable,
MetricDescriptor,
} from '../src';
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
import { NoopLogger, hrTime, hrTimeToNanoseconds } from '@opentelemetry/core';
import {
CounterSumAggregator,
@ -45,7 +45,7 @@ describe('Meter', () => {
let meter: Meter;
const keya = 'keya';
const keyb = 'keyb';
const labels: types.Labels = { [keyb]: 'value2', [keya]: 'value1' };
const labels: api.Labels = { [keyb]: 'value2', [keya]: 'value1' };
beforeEach(() => {
meter = new MeterProvider({
@ -200,7 +200,7 @@ describe('Meter', () => {
// should skip below metric
const counter2 = meter.createCounter('name1', {
valueType: types.ValueType.INT,
valueType: api.ValueType.INT,
}) as CounterMetric;
counter2.bind(labels).add(500);
@ -233,19 +233,19 @@ describe('Meter', () => {
it('should return no op metric if name is an empty string', () => {
const counter = meter.createCounter('');
assert.ok(counter instanceof types.NoopMetric);
assert.ok(counter instanceof api.NoopMetric);
});
it('should return no op metric if name does not start with a letter', () => {
const counter1 = meter.createCounter('1name');
const counter_ = meter.createCounter('_name');
assert.ok(counter1 instanceof types.NoopMetric);
assert.ok(counter_ instanceof types.NoopMetric);
assert.ok(counter1 instanceof api.NoopMetric);
assert.ok(counter_ instanceof api.NoopMetric);
});
it('should return no op metric if name is an empty string contain only letters, numbers, ".", "_", and "-"', () => {
const counter = meter.createCounter('name with invalid characters^&*(');
assert.ok(counter instanceof types.NoopMetric);
assert.ok(counter instanceof api.NoopMetric);
});
});
});
@ -292,19 +292,19 @@ describe('Meter', () => {
describe('names', () => {
it('should return no op metric if name is an empty string', () => {
const measure = meter.createMeasure('');
assert.ok(measure instanceof types.NoopMetric);
assert.ok(measure instanceof api.NoopMetric);
});
it('should return no op metric if name does not start with a letter', () => {
const measure1 = meter.createMeasure('1name');
const measure_ = meter.createMeasure('_name');
assert.ok(measure1 instanceof types.NoopMetric);
assert.ok(measure_ instanceof types.NoopMetric);
assert.ok(measure1 instanceof api.NoopMetric);
assert.ok(measure_ instanceof api.NoopMetric);
});
it('should return no op metric if name is an empty string contain only letters, numbers, ".", "_", and "-"', () => {
const measure = meter.createMeasure('name with invalid characters^&*(');
assert.ok(measure instanceof types.NoopMetric);
assert.ok(measure instanceof api.NoopMetric);
});
});
@ -455,7 +455,7 @@ describe('Meter', () => {
const metricObservable = new MetricObservable();
measure.setCallback((observerResult: types.ObserverResult) => {
measure.setCallback((observerResult: api.ObserverResult) => {
observerResult.observe(getCpuUsage, { pid: '123', core: '1' });
observerResult.observe(getCpuUsage, { pid: '123', core: '2' });
observerResult.observe(getCpuUsage, { pid: '123', core: '3' });
@ -527,7 +527,7 @@ describe('Meter', () => {
const counter = meter.createCounter('counter', {
description: 'test',
labelKeys: [key],
valueType: types.ValueType.INT,
valueType: api.ValueType.INT,
});
const labels = { [key]: 'counter-value' };
const boundCounter = counter.bind(labels);

4
packages/opentelemetry-plugin-https/test/functionals/https-disable.test.ts
View File

@ -25,7 +25,7 @@ import * as sinon from 'sinon';
import { plugin } from '../../src/https';
import { httpsRequest } from '../utils/httpsRequest';
import { NodeTracerProvider } from '@opentelemetry/node';
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
describe('HttpsPlugin', () => {
let server: https.Server;
@ -37,7 +37,7 @@ describe('HttpsPlugin', () => {
logger,
});
// const tracer = provider.getTracer('test-https')
let tracer: types.Tracer;
let tracer: api.Tracer;
before(() => {
nock.cleanAll();
nock.enableNetConnect();

6
packages/opentelemetry-plugin-xml-http-request/src/types.ts
View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
/**
* method "open" from XMLHttpRequest
@ -51,11 +51,11 @@ export interface XhrMem {
status?: number;
statusText?: string;
// span assigned to xhr
span: types.Span;
span: api.Span;
// span url - not available on types.Span
spanUrl?: string;
// startTime of send function - used to filter cors preflight requests
sendStartTime?: types.HrTime;
sendStartTime?: api.HrTime;
// resources created between send and end plus some additional timeout
createdResources?: {
observer: PerformanceObserver;

26
packages/opentelemetry-plugin-xml-http-request/test/xhr.test.ts
View File

@ -13,7 +13,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
import {
B3Propagator,
LogLevel,
@ -101,23 +101,23 @@ describe('xhr', () => {
beforeEach(() => {
contextManager = new ZoneContextManager().enable();
types.context.setGlobalContextManager(contextManager);
api.context.setGlobalContextManager(contextManager);
});
afterEach(() => {
types.context.disable();
api.context.disable();
});
before(() => {
types.propagation.setGlobalPropagator(new B3Propagator());
api.propagation.setGlobalPropagator(new B3Propagator());
});
describe('when request is successful', () => {
let webTracerWithZone: types.Tracer;
let webTracerWithZone: api.Tracer;
let webTracerProviderWithZone: WebTracerProvider;
let dummySpanExporter: DummySpanExporter;
let exportSpy: any;
let rootSpan: types.Span;
let rootSpan: api.Span;
let spyEntries: any;
const url = `${window.location.origin}/xml-http-request.js`;
let fakeNow = 0;
@ -212,11 +212,7 @@ describe('xhr', () => {
it('span should have correct kind', () => {
const span: tracing.ReadableSpan = exportSpy.args[0][0][0];
assert.strictEqual(
span.kind,
types.SpanKind.CLIENT,
'span has wrong kind'
);
assert.strictEqual(span.kind, api.SpanKind.CLIENT, 'span has wrong kind');
});
it('span should have correct attributes', () => {
@ -335,7 +331,7 @@ describe('xhr', () => {
describe('AND origin match with window.location', () => {
it('should set trace headers', () => {
const span: types.Span = exportSpy.args[0][0][0];
const span: api.Span = exportSpy.args[0][0][0];
assert.strictEqual(
requests[0].requestHeaders[X_B3_TRACE_ID],
span.context().traceId,
@ -367,7 +363,7 @@ describe('xhr', () => {
);
});
it('should set trace headers', () => {
const span: types.Span = exportSpy.args[0][0][0];
const span: api.Span = exportSpy.args[0][0][0];
assert.strictEqual(
requests[0].requestHeaders[X_B3_TRACE_ID],
span.context().traceId,
@ -420,10 +416,10 @@ describe('xhr', () => {
describe('when request is NOT successful', () => {
let webTracerWithZoneProvider: WebTracerProvider;
let webTracerWithZone: types.Tracer;
let webTracerWithZone: api.Tracer;
let dummySpanExporter: DummySpanExporter;
let exportSpy: any;
let rootSpan: types.Span;
let rootSpan: api.Span;
let spyEntries: any;
const url =
'https://raw.githubusercontent.com/open-telemetry/opentelemetry-js/master/package.json';

52
packages/opentelemetry-tracing/src/Span.ts
View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
import {
hrTime,
hrTimeDuration,
@ -30,25 +30,25 @@ import { TraceParams } from './types';
/**
* This class represents a span.
*/
export class Span implements types.Span, ReadableSpan {
export class Span implements api.Span, ReadableSpan {
// Below properties are included to implement ReadableSpan for export
// purposes but are not intended to be written-to directly.
readonly spanContext: types.SpanContext;
readonly kind: types.SpanKind;
readonly spanContext: api.SpanContext;
readonly kind: api.SpanKind;
readonly parentSpanId?: string;
readonly attributes: types.Attributes = {};
readonly links: types.Link[] = [];
readonly events: types.TimedEvent[] = [];
readonly startTime: types.HrTime;
readonly attributes: api.Attributes = {};
readonly links: api.Link[] = [];
readonly events: api.TimedEvent[] = [];
readonly startTime: api.HrTime;
readonly resource: Resource;
name: string;
status: types.Status = {
code: types.CanonicalCode.OK,
status: api.Status = {
code: api.CanonicalCode.OK,
};
endTime: types.HrTime = [0, 0];
endTime: api.HrTime = [0, 0];
private _ended = false;
private _duration: types.HrTime = [-1, -1];
private readonly _logger: types.Logger;
private _duration: api.HrTime = [-1, -1];
private readonly _logger: api.Logger;
private readonly _spanProcessor: SpanProcessor;
private readonly _traceParams: TraceParams;
@ -56,11 +56,11 @@ export class Span implements types.Span, ReadableSpan {
constructor(
parentTracer: Tracer,
spanName: string,
spanContext: types.SpanContext,
kind: types.SpanKind,
spanContext: api.SpanContext,
kind: api.SpanKind,
parentSpanId?: string,
links: types.Link[] = [],
startTime: types.TimeInput = hrTime()
links: api.Link[] = [],
startTime: api.TimeInput = hrTime()
) {
this.name = spanName;
this.spanContext = spanContext;
@ -75,7 +75,7 @@ export class Span implements types.Span, ReadableSpan {
this._spanProcessor.onStart(this);
}
context(): types.SpanContext {
context(): api.SpanContext {
return this.spanContext;
}
@ -98,7 +98,7 @@ export class Span implements types.Span, ReadableSpan {
return this;
}
setAttributes(attributes: types.Attributes): this {
setAttributes(attributes: api.Attributes): this {
Object.keys(attributes).forEach(key => {
this.setAttribute(key, attributes[key]);
});
@ -114,8 +114,8 @@ export class Span implements types.Span, ReadableSpan {
*/
addEvent(
name: string,
attributesOrStartTime?: types.Attributes | types.TimeInput,
startTime?: types.TimeInput
attributesOrStartTime?: api.Attributes | api.TimeInput,
startTime?: api.TimeInput
): this {
if (this._isSpanEnded()) return this;
if (this.events.length >= this._traceParams.numberOfEventsPerSpan!) {
@ -124,7 +124,7 @@ export class Span implements types.Span, ReadableSpan {
}
if (isTimeInput(attributesOrStartTime)) {
if (typeof startTime === 'undefined') {
startTime = attributesOrStartTime as types.TimeInput;
startTime = attributesOrStartTime as api.TimeInput;
}
attributesOrStartTime = undefined;
}
@ -133,13 +133,13 @@ export class Span implements types.Span, ReadableSpan {
}
this.events.push({
name,
attributes: attributesOrStartTime as types.Attributes,
attributes: attributesOrStartTime as api.Attributes,
time: timeInputToHrTime(startTime),
});
return this;
}
setStatus(status: types.Status): this {
setStatus(status: api.Status): this {
if (this._isSpanEnded()) return this;
this.status = status;
return this;
@ -151,7 +151,7 @@ export class Span implements types.Span, ReadableSpan {
return this;
}
end(endTime: types.TimeInput = hrTime()): void {
end(endTime: api.TimeInput = hrTime()): void {
if (this._isSpanEnded()) {
this._logger.error('You can only call end() on a span once.');
return;
@ -179,7 +179,7 @@ export class Span implements types.Span, ReadableSpan {
return this;
}
get duration(): types.HrTime {
get duration(): api.HrTime {
return this._duration;
}

16
packages/opentelemetry-web/src/utils.ts
View File

@ -16,7 +16,7 @@
import { PerformanceEntries, PerformanceResourceTimingInfo } from './types';
import { PerformanceTimingNames as PTN } from './enums/PerformanceTimingNames';
import * as types from '@opentelemetry/api';
import * as api from '@opentelemetry/api';
import { hrTimeToNanoseconds, timeInputToHrTime } from '@opentelemetry/core';
/**
@ -35,10 +35,10 @@ export function hasKey<O>(obj: O, key: keyof any): key is keyof O {
* @param entries
*/
export function addSpanNetworkEvent(
span: types.Span,
span: api.Span,
performanceName: string,
entries: PerformanceEntries
): types.Span | undefined {
): api.Span | undefined {
if (
hasKey(entries, performanceName) &&
typeof entries[performanceName] === 'number'
@ -82,8 +82,8 @@ export function sortResources(filteredResources: PerformanceResourceTiming[]) {
*/
export function getResource(
spanUrl: string,
startTimeHR: types.HrTime,
endTimeHR: types.HrTime,
startTimeHR: api.HrTime,
endTimeHR: api.HrTime,
resources: PerformanceResourceTiming[],
ignoredResources: WeakSet<PerformanceResourceTiming> = new WeakSet<
PerformanceResourceTiming
@ -147,7 +147,7 @@ export function getResource(
function findMainRequest(
resources: PerformanceResourceTiming[],
corsPreFlightRequestEndTime: number,
spanEndTimeHR: types.HrTime
spanEndTimeHR: api.HrTime
): PerformanceResourceTiming {
const spanEndTime = hrTimeToNanoseconds(spanEndTimeHR);
const minTime = hrTimeToNanoseconds(
@ -189,8 +189,8 @@ function findMainRequest(
*/
function filterResourcesForSpan(
spanUrl: string,
startTimeHR: types.HrTime,
endTimeHR: types.HrTime,
startTimeHR: api.HrTime,
endTimeHR: api.HrTime,
resources: PerformanceResourceTiming[],
ignoredResources: WeakSet<PerformanceResourceTiming>
) {