From fd9c7ab86bbfdea50301b41383c4cb208f52c620 Mon Sep 17 00:00:00 2001 From: Mayur Kale Date: Wed, 4 Mar 2020 10:43:11 -0800 Subject: [PATCH] rename DistributedContext to CorrelationContext (#834) --- .../CorrelationContext.ts} | 8 ++++---- .../EntryValue.ts | 2 +- packages/opentelemetry-api/src/index.ts | 4 ++-- .../opentelemetry-api/src/metrics/BoundInstrument.ts | 9 +++++---- packages/opentelemetry-api/src/metrics/Metric.ts | 6 +++--- packages/opentelemetry-api/src/metrics/NoopMeter.ts | 12 ++++++------ packages/opentelemetry-api/src/trace/span_context.ts | 2 +- .../opentelemetry-metrics/src/BoundInstrument.ts | 2 +- 8 files changed, 23 insertions(+), 22 deletions(-) rename packages/opentelemetry-api/src/{distributed_context/DistributedContext.ts => correlation_context/CorrelationContext.ts} (79%) rename packages/opentelemetry-api/src/{distributed_context => correlation_context}/EntryValue.ts (98%) diff --git a/packages/opentelemetry-api/src/distributed_context/DistributedContext.ts b/packages/opentelemetry-api/src/correlation_context/CorrelationContext.ts similarity index 79% rename from packages/opentelemetry-api/src/distributed_context/DistributedContext.ts rename to packages/opentelemetry-api/src/correlation_context/CorrelationContext.ts index b06dcb8059e..e0de5eca1ac 100644 --- a/packages/opentelemetry-api/src/distributed_context/DistributedContext.ts +++ b/packages/opentelemetry-api/src/correlation_context/CorrelationContext.ts @@ -17,13 +17,13 @@ import { EntryValue } from './EntryValue'; /** - * DistributedContext represents collection of entries. Each key of - * DistributedContext is associated with exactly one value. DistributedContext + * CorrelationContext represents collection of entries. Each key of + * CorrelationContext is associated with exactly one value. CorrelationContext * is serializable, to facilitate propagating it not only inside the process - * but also across process boundaries. DistributedContext is used to annotate + * but also across process boundaries. CorrelationContext is used to annotate * telemetry with the name:value pair Entry. Those values can be used to add * dimension to the metric or additional contest properties to logs and traces. */ -export interface DistributedContext { +export interface CorrelationContext { [entryKey: string]: EntryValue; } diff --git a/packages/opentelemetry-api/src/distributed_context/EntryValue.ts b/packages/opentelemetry-api/src/correlation_context/EntryValue.ts similarity index 98% rename from packages/opentelemetry-api/src/distributed_context/EntryValue.ts rename to packages/opentelemetry-api/src/correlation_context/EntryValue.ts index cb0c58557e4..f89575ded70 100644 --- a/packages/opentelemetry-api/src/distributed_context/EntryValue.ts +++ b/packages/opentelemetry-api/src/correlation_context/EntryValue.ts @@ -16,7 +16,7 @@ /** * {@link EntryValue} contains properties associated with a {@link - * DistributedContext}. + * CorrelationContext}. */ export interface EntryValue { /** `String` value of the `EntryValue`. */ diff --git a/packages/opentelemetry-api/src/index.ts b/packages/opentelemetry-api/src/index.ts index 581fec31be2..04b0876e0a8 100644 --- a/packages/opentelemetry-api/src/index.ts +++ b/packages/opentelemetry-api/src/index.ts @@ -18,8 +18,8 @@ export * from './common/Logger'; export * from './common/Time'; export * from './context/propagation/carrier'; export * from './context/propagation/HttpTextFormat'; -export * from './distributed_context/DistributedContext'; -export * from './distributed_context/EntryValue'; +export * from './correlation_context/CorrelationContext'; +export * from './correlation_context/EntryValue'; export * from './metrics/BoundInstrument'; export * from './metrics/Meter'; export * from './metrics/MeterProvider'; diff --git a/packages/opentelemetry-api/src/metrics/BoundInstrument.ts b/packages/opentelemetry-api/src/metrics/BoundInstrument.ts index c6dd26cf9e0..07302bd22fb 100644 --- a/packages/opentelemetry-api/src/metrics/BoundInstrument.ts +++ b/packages/opentelemetry-api/src/metrics/BoundInstrument.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { DistributedContext } from '../distributed_context/DistributedContext'; +import { CorrelationContext } from '../correlation_context/CorrelationContext'; import { SpanContext } from '../trace/span_context'; /** An Instrument for Counter Metric. */ @@ -31,15 +31,16 @@ export interface BoundMeasure { /** * Records the given value to this measure. * @param value the measurement to record. - * @param distContext the distContext associated with the measurements. + * @param correlationContext the correlationContext associated with the + * measurements. * @param spanContext the {@link SpanContext} that identifies the {@link Span} * for which the measurements are associated with. */ record(value: number): void; - record(value: number, distContext: DistributedContext): void; + record(value: number, correlationContext: CorrelationContext): void; record( value: number, - distContext: DistributedContext, + correlationContext: CorrelationContext, spanContext: SpanContext ): void; } diff --git a/packages/opentelemetry-api/src/metrics/Metric.ts b/packages/opentelemetry-api/src/metrics/Metric.ts index fb8f11e8ff3..e6e711353f1 100644 --- a/packages/opentelemetry-api/src/metrics/Metric.ts +++ b/packages/opentelemetry-api/src/metrics/Metric.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { DistributedContext } from '../distributed_context/DistributedContext'; +import { CorrelationContext } from '../correlation_context/CorrelationContext'; import { SpanContext } from '../trace/span_context'; /** @@ -118,13 +118,13 @@ export interface MetricUtils { record( value: number, labelSet: LabelSet, - distContext: DistributedContext + correlationContext: CorrelationContext ): void; record( value: number, labelSet: LabelSet, - distContext: DistributedContext, + correlationContext: CorrelationContext, spanContext: SpanContext ): void; } diff --git a/packages/opentelemetry-api/src/metrics/NoopMeter.ts b/packages/opentelemetry-api/src/metrics/NoopMeter.ts index 2b055c336de..b3ab7498319 100644 --- a/packages/opentelemetry-api/src/metrics/NoopMeter.ts +++ b/packages/opentelemetry-api/src/metrics/NoopMeter.ts @@ -17,7 +17,7 @@ import { Meter } from './Meter'; import { MetricOptions, Metric, Labels, LabelSet, MetricUtils } from './Metric'; import { BoundMeasure, BoundCounter } from './BoundInstrument'; -import { DistributedContext } from '../distributed_context/DistributedContext'; +import { CorrelationContext } from '../correlation_context/CorrelationContext'; import { SpanContext } from '../trace/span_context'; /** @@ -107,15 +107,15 @@ export class NoopMeasureMetric extends NoopMetric record( value: number, labelSet: LabelSet, - distContext?: DistributedContext, + correlationContext?: CorrelationContext, spanContext?: SpanContext ) { - if (typeof distContext === 'undefined') { + if (typeof correlationContext === 'undefined') { this.bind(labelSet).record(value); } else if (typeof spanContext === 'undefined') { - this.bind(labelSet).record(value, distContext); + this.bind(labelSet).record(value, correlationContext); } else { - this.bind(labelSet).record(value, distContext, spanContext); + this.bind(labelSet).record(value, correlationContext, spanContext); } } } @@ -129,7 +129,7 @@ export class NoopBoundCounter implements BoundCounter { export class NoopBoundMeasure implements BoundMeasure { record( value: number, - distContext?: DistributedContext, + correlationContext?: CorrelationContext, spanContext?: SpanContext ): void { return; diff --git a/packages/opentelemetry-api/src/trace/span_context.ts b/packages/opentelemetry-api/src/trace/span_context.ts index b901cf52eb8..f776ea4c368 100644 --- a/packages/opentelemetry-api/src/trace/span_context.ts +++ b/packages/opentelemetry-api/src/trace/span_context.ts @@ -19,7 +19,7 @@ import { TraceState } from './trace_state'; /** * A SpanContext represents the portion of a {@link Span} which must be - * serialized and propagated along side of a {@link DistributedContext}. + * serialized and propagated along side of a {@link CorrelationContext}. */ export interface SpanContext { /** diff --git a/packages/opentelemetry-metrics/src/BoundInstrument.ts b/packages/opentelemetry-metrics/src/BoundInstrument.ts index 9b5bb928ec9..5d441910f57 100644 --- a/packages/opentelemetry-metrics/src/BoundInstrument.ts +++ b/packages/opentelemetry-metrics/src/BoundInstrument.ts @@ -116,7 +116,7 @@ export class BoundMeasure extends BaseBoundInstrument record( value: number, - distContext?: types.DistributedContext, + correlationContext?: types.CorrelationContext, spanContext?: types.SpanContext ): void { if (this._absolute && value < 0) {