/* * 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. */ var __values = (this && this.__values) || function(o) { var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0; if (m) return m.call(o); if (o && typeof o.length === "number") return { next: function () { if (o && i >= o.length) o = void 0; return { value: o && o[i++], done: !o }; } }; throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined."); }; var __read = (this && this.__read) || function (o, n) { var m = typeof Symbol === "function" && o[Symbol.iterator]; if (!m) return o; var i = m.call(o), r, ar = [], e; try { while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value); } catch (error) { e = { error: error }; } finally { try { if (r && !r.done && (m = i["return"])) m.call(i); } finally { if (e) throw e.error; } } return ar; }; import * as api from '@opentelemetry/api'; import { hrTimeDuration, isAttributeValue, isTimeInput, otperformance, sanitizeAttributes, timeInputToHrTime } from '@opentelemetry/core'; import { SemanticAttributes } from '@opentelemetry/semantic-conventions'; import { ExceptionEventName } from './enums'; /** * This class represents a span. */ var Span = /** @class */ (function () { /** * Constructs a new Span instance. * * @deprecated calling Span constructor directly is not supported. Please use tracer.startSpan. * */ function Span(parentTracer, context, spanName, spanContext, kind, parentSpanId, links, startTime, clock) { if (links === void 0) { links = []; } if (clock === void 0) { clock = otperformance; } this.attributes = {}; this.links = []; this.events = []; this.status = { code: api.SpanStatusCode.UNSET, }; this.endTime = [0, 0]; this._ended = false; this._duration = [-1, -1]; this._clock = clock; this.name = spanName; this._spanContext = spanContext; this.parentSpanId = parentSpanId; this.kind = kind; this.links = links; this.startTime = timeInputToHrTime(startTime !== null && startTime !== void 0 ? startTime : clock.now()); this.resource = parentTracer.resource; this.instrumentationLibrary = parentTracer.instrumentationLibrary; this._spanLimits = parentTracer.getSpanLimits(); this._spanProcessor = parentTracer.getActiveSpanProcessor(); this._spanProcessor.onStart(this, context); this._attributeValueLengthLimit = this._spanLimits.attributeValueLengthLimit || 0; } Span.prototype.spanContext = function () { return this._spanContext; }; Span.prototype.setAttribute = function (key, value) { if (value == null || this._isSpanEnded()) return this; if (key.length === 0) { api.diag.warn("Invalid attribute key: " + key); return this; } if (!isAttributeValue(value)) { api.diag.warn("Invalid attribute value set for key: " + key); return this; } if (Object.keys(this.attributes).length >= this._spanLimits.attributeCountLimit && !Object.prototype.hasOwnProperty.call(this.attributes, key)) { return this; } this.attributes[key] = this._truncateToSize(value); return this; }; Span.prototype.setAttributes = function (attributes) { var e_1, _a; try { for (var _b = __values(Object.entries(attributes)), _c = _b.next(); !_c.done; _c = _b.next()) { var _d = __read(_c.value, 2), k = _d[0], v = _d[1]; this.setAttribute(k, v); } } catch (e_1_1) { e_1 = { error: e_1_1 }; } finally { try { if (_c && !_c.done && (_a = _b.return)) _a.call(_b); } finally { if (e_1) throw e_1.error; } } return this; }; /** * * @param name Span Name * @param [attributesOrStartTime] Span attributes or start time * if type is {@type TimeInput} and 3rd param is undefined * @param [startTime] Specified start time for the event */ Span.prototype.addEvent = function (name, attributesOrStartTime, startTime) { if (this._isSpanEnded()) return this; if (this._spanLimits.eventCountLimit === 0) { api.diag.warn('No events allowed.'); return this; } if (this.events.length >= this._spanLimits.eventCountLimit) { api.diag.warn('Dropping extra events.'); this.events.shift(); } if (isTimeInput(attributesOrStartTime)) { if (typeof startTime === 'undefined') { startTime = attributesOrStartTime; } attributesOrStartTime = undefined; } if (typeof startTime === 'undefined') { startTime = this._clock.now(); } var attributes = sanitizeAttributes(attributesOrStartTime); this.events.push({ name: name, attributes: attributes, time: timeInputToHrTime(startTime), }); return this; }; Span.prototype.setStatus = function (status) { if (this._isSpanEnded()) return this; this.status = status; return this; }; Span.prototype.updateName = function (name) { if (this._isSpanEnded()) return this; this.name = name; return this; }; Span.prototype.end = function (endTime) { if (this._isSpanEnded()) { api.diag.error('You can only call end() on a span once.'); return; } this._ended = true; this.endTime = timeInputToHrTime(endTime !== null && endTime !== void 0 ? endTime : this._clock.now()); this._duration = hrTimeDuration(this.startTime, this.endTime); if (this._duration[0] < 0) { api.diag.warn('Inconsistent start and end time, startTime > endTime. Setting span duration to 0ms.', this.startTime, this.endTime); this.endTime = this.startTime.slice(); this._duration = [0, 0]; } this._spanProcessor.onEnd(this); }; Span.prototype.isRecording = function () { return this._ended === false; }; Span.prototype.recordException = function (exception, time) { if (time === void 0) { time = this._clock.now(); } var attributes = {}; if (typeof exception === 'string') { attributes[SemanticAttributes.EXCEPTION_MESSAGE] = exception; } else if (exception) { if (exception.code) { attributes[SemanticAttributes.EXCEPTION_TYPE] = exception.code.toString(); } else if (exception.name) { attributes[SemanticAttributes.EXCEPTION_TYPE] = exception.name; } if (exception.message) { attributes[SemanticAttributes.EXCEPTION_MESSAGE] = exception.message; } if (exception.stack) { attributes[SemanticAttributes.EXCEPTION_STACKTRACE] = exception.stack; } } // these are minimum requirements from spec if (attributes[SemanticAttributes.EXCEPTION_TYPE] || attributes[SemanticAttributes.EXCEPTION_MESSAGE]) { this.addEvent(ExceptionEventName, attributes, time); } else { api.diag.warn("Failed to record an exception " + exception); } }; Object.defineProperty(Span.prototype, "duration", { get: function () { return this._duration; }, enumerable: false, configurable: true }); Object.defineProperty(Span.prototype, "ended", { get: function () { return this._ended; }, enumerable: false, configurable: true }); Span.prototype._isSpanEnded = function () { if (this._ended) { api.diag.warn("Can not execute the operation on ended Span {traceId: " + this._spanContext.traceId + ", spanId: " + this._spanContext.spanId + "}"); } return this._ended; }; // Utility function to truncate given value within size // for value type of string, will truncate to given limit // for type of non-string, will return same value Span.prototype._truncateToLimitUtil = function (value, limit) { if (value.length <= limit) { return value; } return value.substr(0, limit); }; /** * If the given attribute value is of type string and has more characters than given {@code attributeValueLengthLimit} then * return string with trucated to {@code attributeValueLengthLimit} characters * * If the given attribute value is array of strings then * return new array of strings with each element truncated to {@code attributeValueLengthLimit} characters * * Otherwise return same Attribute {@code value} * * @param value Attribute value * @returns truncated attribute value if required, otherwise same value */ Span.prototype._truncateToSize = function (value) { var _this = this; var limit = this._attributeValueLengthLimit; // Check limit if (limit <= 0) { // Negative values are invalid, so do not truncate api.diag.warn("Attribute value limit must be positive, got " + limit); return value; } // String if (typeof value === 'string') { return this._truncateToLimitUtil(value, limit); } // Array of strings if (Array.isArray(value)) { return value.map(function (val) { return typeof val === 'string' ? _this._truncateToLimitUtil(val, limit) : val; }); } // Other types, no need to apply value length limit return value; }; return Span; }()); export { Span }; //# sourceMappingURL=Span.js.map