This repository has been archived by the owner on Oct 3, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 96
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(tracer): separate cls from tracer (#484)
* feat(tracer): separate cls from tracer BREAKING CHANGE: startChildSpan only accepts option object * refactor(tracer): keep CLS CoreTracer the default and introduce CoreTraceBase * refactor(tracer): address PR comments * refactor(tracer): address PR comments * test(tracer): separate CoreTracerBasic and CoreTracer tests * refactor(opencensus-core): tracer base code improvement * refactor(opencensus-core): tracer base code improvement
- Loading branch information
Showing
26 changed files
with
772 additions
and
582 deletions.
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
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
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
232 changes: 232 additions & 0 deletions
232
packages/opencensus-core/src/trace/model/tracer-base.ts
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 |
|---|---|---|
| @@ -0,0 +1,232 @@ | ||
| /** | ||
| * Copyright 2018, OpenCensus 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 | ||
| * | ||
| * http://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 uuid from 'uuid'; | ||
| import * as logger from '../../common/console-logger'; | ||
| import * as loggerTypes from '../../common/types'; | ||
| import * as configTypes from '../config/types'; | ||
| import {TraceParams} from '../config/types'; | ||
| import {noopPropagation} from '../propagation/noop-propagation'; | ||
| import {Propagation} from '../propagation/types'; | ||
| import {DEFAULT_SAMPLING_RATE, SamplerBuilder, TraceParamsBuilder} from '../sampler/sampler'; | ||
| import * as samplerTypes from '../sampler/types'; | ||
| import {NoRecordRootSpan} from './no-record/no-record-root-span'; | ||
| import {NoRecordSpan} from './no-record/no-record-span'; | ||
| import {RootSpan} from './root-span'; | ||
| import * as types from './types'; | ||
|
|
||
| /** | ||
| * This class represents a tracer. | ||
| */ | ||
| export class CoreTracerBase implements types.TracerBase { | ||
| /** Indicates if the tracer is active */ | ||
| private activeLocal: boolean; | ||
| /** A configuration for starting the tracer */ | ||
| private config!: configTypes.TracerConfig; | ||
| /** A list of end span event listeners */ | ||
| private eventListenersLocal: types.SpanEventListener[] = []; | ||
| /** Bit to represent whether trace is sampled or not. */ | ||
| private readonly IS_SAMPLED = 0x1; | ||
| /** A sampler used to make sample decisions */ | ||
| sampler!: samplerTypes.Sampler; | ||
| /** An object to log information */ | ||
| logger: loggerTypes.Logger = logger.logger(); | ||
| /** A configuration object for trace parameters */ | ||
| activeTraceParams: TraceParams; | ||
|
|
||
| /** Constructs a new TraceImpl instance. */ | ||
| constructor() { | ||
| this.activeLocal = false; | ||
| this.activeTraceParams = {}; | ||
| } | ||
|
|
||
| /** A propagation instance */ | ||
| get propagation(): Propagation { | ||
| if (this.config && this.config.propagation) { | ||
| return this.config.propagation; | ||
| } | ||
| return noopPropagation; | ||
| } | ||
|
|
||
| /** | ||
| * Starts a tracer. | ||
| * @param config A tracer configuration object to start a tracer. | ||
| */ | ||
| start(config: configTypes.TracerConfig): this { | ||
| this.activeLocal = true; | ||
| this.config = config; | ||
| this.logger = this.config.logger || logger.logger(); | ||
| this.sampler = | ||
| SamplerBuilder.getSampler(config.samplingRate || DEFAULT_SAMPLING_RATE); | ||
| if (config.traceParams) { | ||
| this.activeTraceParams.numberOfAnnontationEventsPerSpan = | ||
| TraceParamsBuilder.getNumberOfAnnotationEventsPerSpan( | ||
| config.traceParams); | ||
| this.activeTraceParams.numberOfAttributesPerSpan = | ||
| TraceParamsBuilder.getNumberOfAttributesPerSpan(config.traceParams); | ||
| this.activeTraceParams.numberOfMessageEventsPerSpan = | ||
| TraceParamsBuilder.getNumberOfMessageEventsPerSpan( | ||
| config.traceParams); | ||
| this.activeTraceParams.numberOfLinksPerSpan = | ||
| TraceParamsBuilder.getNumberOfLinksPerSpan(config.traceParams); | ||
| } | ||
| return this; | ||
| } | ||
|
|
||
| /** Stops the tracer. */ | ||
| stop(): this { | ||
| this.activeLocal = false; | ||
| return this; | ||
| } | ||
|
|
||
| /** Gets the list of event listeners. */ | ||
| get eventListeners(): types.SpanEventListener[] { | ||
| return this.eventListenersLocal; | ||
| } | ||
|
|
||
| /** Indicates if the tracer is active or not. */ | ||
| get active(): boolean { | ||
| return this.activeLocal; | ||
| } | ||
|
|
||
| /** | ||
| * Starts a root span. | ||
| * @param options A TraceOptions object to start a root span. | ||
| * @param fn A callback function to run after starting a root span. | ||
| */ | ||
| startRootSpan<T>(options: types.TraceOptions, fn: (root: types.Span) => T): | ||
| T { | ||
| const spanContext: types.SpanContext = options.spanContext || | ||
| {spanId: '', traceId: uuid.v4().split('-').join('')}; | ||
| const parentSpanId = spanContext.spanId; | ||
| const traceId = spanContext.traceId; | ||
| const name = options.name || 'span'; | ||
| const kind = options.kind || types.SpanKind.UNSPECIFIED; | ||
| const traceState = spanContext.traceState; | ||
|
|
||
| // Tracer is active | ||
| if (this.active) { | ||
| const sampleDecision = this.makeSamplingDecision(options, traceId); | ||
| // Sampling is on | ||
| if (sampleDecision) { | ||
| const rootSpan = | ||
| new RootSpan(this, name, kind, traceId, parentSpanId, traceState); | ||
| rootSpan.start(); | ||
| return fn(rootSpan); | ||
| } | ||
|
|
||
| // Sampling is off | ||
| this.logger.debug('Sampling is off, starting new no record root span'); | ||
| const noRecordRootSpan = new NoRecordRootSpan( | ||
| this, name, kind, traceId, parentSpanId, traceState); | ||
| return fn(noRecordRootSpan); | ||
| } | ||
|
|
||
| // Tracer is inactive | ||
| this.logger.debug('Tracer is inactive, starting new no record root span'); | ||
| const noRecordRootSpan = new NoRecordRootSpan( | ||
| this, name, kind, traceId, parentSpanId, traceState); | ||
| return fn(noRecordRootSpan); | ||
| } | ||
|
|
||
| /** Notifies listeners of the span start. */ | ||
| onStartSpan(root: types.Span): void { | ||
| if (!this.active) return; | ||
| if (!root) { | ||
| return this.logger.debug('cannot start trace - no active trace found'); | ||
| } | ||
| this.notifyStartSpan(root); | ||
| } | ||
|
|
||
| /** Notifies listeners of the span end. */ | ||
| onEndSpan(root: types.Span): void { | ||
| if (!this.active) return; | ||
| if (!root) { | ||
| this.logger.debug('cannot end trace - no active trace found'); | ||
| return; | ||
| } | ||
| this.notifyEndSpan(root); | ||
| } | ||
|
|
||
| /** | ||
| * Registers an end span event listener. | ||
| * @param listener The listener to register. | ||
| */ | ||
| registerSpanEventListener(listener: types.SpanEventListener) { | ||
| this.eventListenersLocal.push(listener); | ||
| } | ||
|
|
||
| /** | ||
| * Unregisters an end span event listener. | ||
| * @param listener The listener to unregister. | ||
| */ | ||
| unregisterSpanEventListener(listener: types.SpanEventListener) { | ||
| const index = this.eventListenersLocal.indexOf(listener, 0); | ||
| if (index > -1) { | ||
| this.eventListeners.splice(index, 1); | ||
| } | ||
| } | ||
|
|
||
| private notifyStartSpan(root: types.Span) { | ||
| this.logger.debug('starting to notify listeners the start of rootspans'); | ||
| if (this.eventListenersLocal && this.eventListenersLocal.length > 0) { | ||
| for (const listener of this.eventListenersLocal) { | ||
| listener.onStartSpan(root); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private notifyEndSpan(root: types.Span) { | ||
| this.logger.debug('starting to notify listeners the end of rootspans'); | ||
| if (this.eventListenersLocal && this.eventListenersLocal.length > 0) { | ||
| for (const listener of this.eventListenersLocal) { | ||
| listener.onEndSpan(root); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Starts a span. | ||
| * @param [options] A SpanOptions object to start a child span. | ||
| */ | ||
| startChildSpan(options?: types.SpanOptions): types.Span { | ||
| if (!options || !options.childOf) { | ||
| this.logger.debug( | ||
| 'no current trace found - must start a new root span first'); | ||
| return new NoRecordSpan(); | ||
| } | ||
| return options.childOf.startChildSpan(options.name, options.kind); | ||
| } | ||
|
|
||
| /** Determine whether to sample request or not. */ | ||
| private makeSamplingDecision(options: types.TraceOptions, traceId: string): | ||
| boolean { | ||
| // If users set a specific sampler in the TraceOptions, use it. | ||
| if (options && options.samplingRate !== undefined && | ||
| options.samplingRate !== null) { | ||
| return SamplerBuilder.getSampler(options.samplingRate) | ||
| .shouldSample(traceId); | ||
| } | ||
| let propagatedSample = null; | ||
| // if there is a context propagation, keep the decision | ||
| if (options && options.spanContext && options.spanContext.options) { | ||
| propagatedSample = (options.spanContext.options & this.IS_SAMPLED) !== 0; | ||
| } | ||
|
|
||
| // Propagated sample or use the default global sampler | ||
| return !!propagatedSample || this.sampler.shouldSample(traceId); | ||
| } | ||
| } |
Oops, something went wrong.