@sentry/opentelemetry - npm Package Compare versions

Comparing version 8.0.0-alpha.5 to 8.0.0-alpha.7

package.json

 {
   "name": "@sentry/opentelemetry",
-  "version": "8.0.0-alpha.5",
+  "version": "8.0.0-alpha.7",
   "description": "Official Sentry utilities for OpenTelemetry",
@@ -45,5 +45,5 @@ "repository": "git://github.com/getsentry/sentry-javascript.git",
   "dependencies": {
-    "@sentry/core": "8.0.0-alpha.5",
-    "@sentry/types": "8.0.0-alpha.5",
-    "@sentry/utils": "8.0.0-alpha.5"
+    "@sentry/core": "8.0.0-alpha.7",
+    "@sentry/types": "8.0.0-alpha.7",
+    "@sentry/utils": "8.0.0-alpha.7"
   },
@@ -50,0 +50,0 @@ "peerDependencies": {

types-ts3.8/propagator.d.ts

@@ -11,2 +11,4 @@ import { Context, SpanContext, TextMapGetter, TextMapSetter } from '@opentelemetry/api';
 export declare class SentryPropagator extends W3CBaggagePropagator {
+    /** A map of URLs that have already been checked for if they match tracePropagationTargets. */
+    private _urlMatchesTargetsMap;
     constructor();
@@ -25,2 +27,4 @@ /**
     fields(): string[];
+    /** If we want to inject trace data for a given URL. */
+    private _shouldInjectTraceData;
 }
@@ -27,0 +31,0 @@ /** Exported for tests. */

types-ts3.8/spanExporter.d.ts

@@ -1,17 +0,23 @@
-import { ExportResult } from '@opentelemetry/core';
-import { ReadableSpan, SpanExporter } from '@opentelemetry/sdk-trace-base';
+import { ReadableSpan } from '@opentelemetry/sdk-trace-base';
 /**
  * A Sentry-specific exporter that converts OpenTelemetry Spans to Sentry Spans & Transactions.
  */
-export declare class SentrySpanExporter implements SpanExporter {
+export declare class SentrySpanExporter {
+    private _flushTimeout;
     private _finishedSpans;
-    private _stopped;
     constructor();
-    /** @inheritDoc */
-    export(spans: ReadableSpan[], resultCallback: (result: ExportResult) => void): void;
-    /** @inheritDoc */
-    shutdown(): Promise<void>;
-    /** @inheritDoc */
-    forceFlush(): Promise<void>;
+    /** Export a single span. */
+    export(span: ReadableSpan): void;
+    /** Try to flush any pending spans immediately. */
+    flush(): void;
+    /** Clear the exporter. */
+    clear(): void;
+    /** Clear the flush timeout. */
+    private _clearTimeout;
+    /**
+     * Remove any span that is older than 5min.
+     * We do this to avoid leaking memory.
+     */
+    private _cleanupOldSpans;
 }
 //# sourceMappingURL=spanExporter.d.ts.map

types-ts3.8/spanProcessor.d.ts

 import { Context } from '@opentelemetry/api';
-import { Span, SpanProcessor as SpanProcessorInterface } from '@opentelemetry/sdk-trace-base';
-import { BatchSpanProcessor } from '@opentelemetry/sdk-trace-base';
+import { ReadableSpan, Span, SpanProcessor as SpanProcessorInterface } from '@opentelemetry/sdk-trace-base';
 /**
@@ -8,3 +7,4 @@ * Converts OpenTelemetry Spans to Sentry Spans and sends them to Sentry via
  */
-export declare class SentrySpanProcessor extends BatchSpanProcessor implements SpanProcessorInterface {
+export declare class SentrySpanProcessor implements SpanProcessorInterface {
+    private _exporter;
     constructor();
@@ -14,11 +14,14 @@ /**
      */
+    forceFlush(): Promise<void>;
+    /**
+     * @inheritDoc
+     */
+    shutdown(): Promise<void>;
+    /**
+     * @inheritDoc
+     */
     onStart(span: Span, parentContext: Context): void;
     /** @inheritDoc */
-    onEnd(span: Span): void;
-    /**
-     * You can overwrite this in a sub class to implement custom behavior for dropping spans.
-     * If you return `false` here, the span will not be passed to the exporter and thus not be sent.
-     */
-    protected _shouldSendSpanToSentry(_span: Span): boolean;
+    onEnd(span: ReadableSpan): void;
 }
 //# sourceMappingURL=spanProcessor.d.ts.map

types-ts3.8/trace.d.ts

@@ -8,7 +8,8 @@ import { Span } from '@opentelemetry/api';
  * The created span is the active span and will be used as parent by other spans created inside the function
- * and can be accessed via `Sentry.getSpan()`, as long as the function is executed while the scope is active.
+ * and can be accessed via `Sentry.getActiveSpan()`, as long as the function is executed while the scope is active.
  *
  * If you want to create a span that is not set as active, use {@link startInactiveSpan}.
  *
- * Note that you'll always get a span passed to the callback, it may just be a NonRecordingSpan if the span is not sampled.
+ * You'll always get a span passed to the callback,
+ * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
  */
@@ -23,3 +24,4 @@ export declare function startSpan<T>(options: OpenTelemetrySpanContext, callback: (span: Span) => T): T;
  *
- * Note that you'll always get a span passed to the callback, it may just be a NonRecordingSpan if the span is not sampled.
+ * You'll always get a span passed to the callback,
+ * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
  */
@@ -33,9 +35,8 @@ export declare function startSpanManual<T>(options: OpenTelemetrySpanContext, callback: (span: Span, finish: () => void) => T): T;
  * Creates a span. This span is not set as active, so will not get automatic instrumentation spans
- * as children or be able to be accessed via `Sentry.getSpan()`.
+ * as children or be able to be accessed via `Sentry.getActiveSpan()`.
  *
  * If you want to create a span that is set as active, use {@link startSpan}.
  *
- * Note that if you have not enabled tracing extensions via `addTracingExtensions`
- * or you didn't set `tracesSampleRate` or `tracesSampler`, this function will not generate spans
- * and the `span` returned from the callback will be undefined.
+ * This function will always return a span,
+ * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
  */
@@ -48,3 +49,3 @@ export declare function startInactiveSpan(options: OpenTelemetrySpanContext): Span;
  * @param span Spans started in the context of the provided callback will be children of this span. If `null` is passed,
- * spans started within the callback will not be attached to a parent span.
+ * spans started within the callback will be root spans.
  * @param callback Execution context in which the provided span will be active. Is passed the newly forked scope.
@@ -51,0 +52,0 @@ * @returns the value returned from the provided callback function.

types-ts3.8/utils/groupSpansWithParents.d.ts

@@ -13,2 +13,6 @@ import { ReadableSpan } from '@opentelemetry/sdk-trace-base';
 export declare function groupSpansWithParents(spans: ReadableSpan[]): SpanNode[];
+/**
+ * This returns the _local_ parent ID - `parentId` on the span may point to a remote span.
+ */
+export declare function getLocalParentId(span: ReadableSpan): string | undefined;
 //# sourceMappingURL=groupSpansWithParents.d.ts.map

types/propagator.d.ts

@@ -11,2 +11,4 @@ import type { Context, SpanContext, TextMapGetter, TextMapSetter } from '@opentelemetry/api';
 export declare class SentryPropagator extends W3CBaggagePropagator {
+    /** A map of URLs that have already been checked for if they match tracePropagationTargets. */
+    private _urlMatchesTargetsMap;
     constructor();
@@ -25,2 +27,4 @@ /**
     fields(): string[];
+    /** If we want to inject trace data for a given URL. */
+    private _shouldInjectTraceData;
 }
@@ -27,0 +31,0 @@ /** Exported for tests. */

types/spanExporter.d.ts

@@ -1,17 +0,23 @@
-import type { ExportResult } from '@opentelemetry/core';
-import type { ReadableSpan, SpanExporter } from '@opentelemetry/sdk-trace-base';
+import type { ReadableSpan } from '@opentelemetry/sdk-trace-base';
 /**
  * A Sentry-specific exporter that converts OpenTelemetry Spans to Sentry Spans & Transactions.
  */
-export declare class SentrySpanExporter implements SpanExporter {
+export declare class SentrySpanExporter {
+    private _flushTimeout;
     private _finishedSpans;
-    private _stopped;
     constructor();
-    /** @inheritDoc */
-    export(spans: ReadableSpan[], resultCallback: (result: ExportResult) => void): void;
-    /** @inheritDoc */
-    shutdown(): Promise<void>;
-    /** @inheritDoc */
-    forceFlush(): Promise<void>;
+    /** Export a single span. */
+    export(span: ReadableSpan): void;
+    /** Try to flush any pending spans immediately. */
+    flush(): void;
+    /** Clear the exporter. */
+    clear(): void;
+    /** Clear the flush timeout. */
+    private _clearTimeout;
+    /**
+     * Remove any span that is older than 5min.
+     * We do this to avoid leaking memory.
+     */
+    private _cleanupOldSpans;
 }
 //# sourceMappingURL=spanExporter.d.ts.map

types/spanProcessor.d.ts

 import type { Context } from '@opentelemetry/api';
-import type { Span, SpanProcessor as SpanProcessorInterface } from '@opentelemetry/sdk-trace-base';
-import { BatchSpanProcessor } from '@opentelemetry/sdk-trace-base';
+import type { ReadableSpan, Span, SpanProcessor as SpanProcessorInterface } from '@opentelemetry/sdk-trace-base';
 /**
@@ -8,3 +7,4 @@ * Converts OpenTelemetry Spans to Sentry Spans and sends them to Sentry via
  */
-export declare class SentrySpanProcessor extends BatchSpanProcessor implements SpanProcessorInterface {
+export declare class SentrySpanProcessor implements SpanProcessorInterface {
+    private _exporter;
     constructor();
@@ -14,11 +14,14 @@ /**
      */
+    forceFlush(): Promise<void>;
+    /**
+     * @inheritDoc
+     */
+    shutdown(): Promise<void>;
+    /**
+     * @inheritDoc
+     */
     onStart(span: Span, parentContext: Context): void;
     /** @inheritDoc */
-    onEnd(span: Span): void;
-    /**
-     * You can overwrite this in a sub class to implement custom behavior for dropping spans.
-     * If you return `false` here, the span will not be passed to the exporter and thus not be sent.
-     */
-    protected _shouldSendSpanToSentry(_span: Span): boolean;
+    onEnd(span: ReadableSpan): void;
 }
 //# sourceMappingURL=spanProcessor.d.ts.map

types/trace.d.ts

@@ -8,7 +8,8 @@ import type { Span } from '@opentelemetry/api';
  * The created span is the active span and will be used as parent by other spans created inside the function
- * and can be accessed via `Sentry.getSpan()`, as long as the function is executed while the scope is active.
+ * and can be accessed via `Sentry.getActiveSpan()`, as long as the function is executed while the scope is active.
  *
  * If you want to create a span that is not set as active, use {@link startInactiveSpan}.
  *
- * Note that you'll always get a span passed to the callback, it may just be a NonRecordingSpan if the span is not sampled.
+ * You'll always get a span passed to the callback,
+ * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
  */
@@ -23,3 +24,4 @@ export declare function startSpan<T>(options: OpenTelemetrySpanContext, callback: (span: Span) => T): T;
  *
- * Note that you'll always get a span passed to the callback, it may just be a NonRecordingSpan if the span is not sampled.
+ * You'll always get a span passed to the callback,
+ * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
  */
@@ -33,9 +35,8 @@ export declare function startSpanManual<T>(options: OpenTelemetrySpanContext, callback: (span: Span, finish: () => void) => T): T;
  * Creates a span. This span is not set as active, so will not get automatic instrumentation spans
- * as children or be able to be accessed via `Sentry.getSpan()`.
+ * as children or be able to be accessed via `Sentry.getActiveSpan()`.
  *
  * If you want to create a span that is set as active, use {@link startSpan}.
  *
- * Note that if you have not enabled tracing extensions via `addTracingExtensions`
- * or you didn't set `tracesSampleRate` or `tracesSampler`, this function will not generate spans
- * and the `span` returned from the callback will be undefined.
+ * This function will always return a span,
+ * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
  */
@@ -48,3 +49,3 @@ export declare function startInactiveSpan(options: OpenTelemetrySpanContext): Span;
  * @param span Spans started in the context of the provided callback will be children of this span. If `null` is passed,
- * spans started within the callback will not be attached to a parent span.
+ * spans started within the callback will be root spans.
  * @param callback Execution context in which the provided span will be active. Is passed the newly forked scope.
@@ -51,0 +52,0 @@ * @returns the value returned from the provided callback function.

types/utils/groupSpansWithParents.d.ts

@@ -13,2 +13,6 @@ import type { ReadableSpan } from '@opentelemetry/sdk-trace-base';
 export declare function groupSpansWithParents(spans: ReadableSpan[]): SpanNode[];
+/**
+ * This returns the _local_ parent ID - `parentId` on the span may point to a remote span.
+ */
+export declare function getLocalParentId(span: ReadableSpan): string | undefined;
 //# sourceMappingURL=groupSpansWithParents.d.ts.map

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

880595

increased by3.61%

Lines of code

4506

increased by3.73%

Dependency changes

• + Added@sentry/core@8.0.0-alpha.7(transitive)

• + Added@sentry/types@8.0.0-alpha.7(transitive)

• + Added@sentry/utils@8.0.0-alpha.7(transitive)

• - Removed@sentry/core@8.0.0-alpha.5(transitive)

• - Removed@sentry/types@8.0.0-alpha.5(transitive)

• - Removed@sentry/utils@8.0.0-alpha.5(transitive)

• Updated@sentry/core@8.0.0-alpha.7

• Updated@sentry/types@8.0.0-alpha.7

• Updated@sentry/utils@8.0.0-alpha.7