@sentry/apm - npm Package Compare versions

Comparing version 5.10.0-rc.0 to 5.10.0

dist/hubextensions.js

 Object.defineProperty(exports, "__esModule", { value: true });
 var hub_1 = require("@sentry/hub");
+var utils_1 = require("@sentry/utils");
 var span_1 = require("./span");
@@ -9,3 +10,3 @@ /**
 function isSpanInstance(span) {
-    return span instanceof span_1.Span;
+    return utils_1.isInstanceOf(span, span_1.Span);
 }
@@ -12,0 +13,0 @@ /** Returns all trace headers that are currently on the top scope. */

dist/integrations/tracing.d.ts

 import { EventProcessor, Hub, Integration, Span, SpanContext, SpanStatus } from '@sentry/types';
-/** JSDoc */
+/**
+ * Options for Tracing integration
+ */
 interface TracingOptions {
+    /**
+     * List of strings / regex where the integration should create Spans out of. Additionally this will be used
+     * to define which outgoing requests the `sentry-trace` header will be attached to.
+     *
+     * Default: ['localhost', /^\//]
+     */
     tracingOrigins: Array<string | RegExp>;
+    /**
+     * Flag to disable patching all together for fetch requests.
+     *
+     * Default: true
+     */
     traceFetch: boolean;
+    /**
+     * Flag to disable patching all together for xhr requests.
+     *
+     * Default: true
+     */
     traceXHR: boolean;
@@ -14,4 +32,24 @@ /**
     shouldCreateSpanForRequest(url: string): boolean;
+    /**
+     * The time to wait in ms until the transaction will be finished. The transaction will use the end timestamp of
+     * the last finished span as the endtime for the transaction.
+     *
+     * Default: 500
+     */
     idleTimeout: number;
+    /**
+     * Flag to enable/disable creation of `navigation` transaction on history changes. Useful for react applications with
+     * a router.
+     *
+     * Default: true
+     */
     startTransactionOnLocationChange: boolean;
+    /**
+     * Sample to determine if the Integration should instrument anything. The decision will be taken once per load
+     * on initalization.
+     * 0 = 0% chance of instrumenting
+     * 1 = 100% change of instrumenting
+     *
+     * Default: 1
+     */
     tracesSampleRate: number;
@@ -18,0 +56,0 @@ }

dist/span.js

@@ -72,3 +72,3 @@ // tslint:disable:max-classes-per-file
         this.data = {};
-        if (hub instanceof hub_1.Hub) {
+        if (utils_1.isInstanceOf(hub, hub_1.Hub)) {
             this._hub = hub;
@@ -216,3 +216,2 @@ }
         return this._hub.captureEvent({
-            contexts: { trace: this.getTraceContext() },
             spans: finishedSpans,
@@ -240,3 +239,3 @@ start_timestamp: this.startTimestamp,
     Span.prototype.getTraceContext = function () {
-        var context = {
+        return {
             data: this.data,
@@ -247,10 +246,7 @@ description: this.description,
             span_id: this._spanId,
+            // Undefined status will be dropped by `JSON.stringify` anyway so it's safe to read it directly like that
+            status: this.tags.status,
             tags: this.tags,
             trace_id: this._traceId,
         };
-        if (this.tags.status) {
-            // TODO: Fixme, just use better typings
-            context.status = this.tags.status;
-        }
-        return context;
     };
@@ -257,0 +253,0 @@ /**

esm/hubextensions.js

 import { getMainCarrier } from '@sentry/hub';
+import { isInstanceOf } from '@sentry/utils';
 import { Span } from './span';
@@ -8,3 +9,3 @@ /**
 function isSpanInstance(span) {
-    return span instanceof Span;
+    return isInstanceOf(span, Span);
 }
@@ -11,0 +12,0 @@ /** Returns all trace headers that are currently on the top scope. */

esm/integrations/tracing.d.ts

 import { EventProcessor, Hub, Integration, Span, SpanContext, SpanStatus } from '@sentry/types';
-/** JSDoc */
+/**
+ * Options for Tracing integration
+ */
 interface TracingOptions {
+    /**
+     * List of strings / regex where the integration should create Spans out of. Additionally this will be used
+     * to define which outgoing requests the `sentry-trace` header will be attached to.
+     *
+     * Default: ['localhost', /^\//]
+     */
     tracingOrigins: Array<string | RegExp>;
+    /**
+     * Flag to disable patching all together for fetch requests.
+     *
+     * Default: true
+     */
     traceFetch: boolean;
+    /**
+     * Flag to disable patching all together for xhr requests.
+     *
+     * Default: true
+     */
     traceXHR: boolean;
@@ -14,4 +32,24 @@ /**
     shouldCreateSpanForRequest(url: string): boolean;
+    /**
+     * The time to wait in ms until the transaction will be finished. The transaction will use the end timestamp of
+     * the last finished span as the endtime for the transaction.
+     *
+     * Default: 500
+     */
     idleTimeout: number;
+    /**
+     * Flag to enable/disable creation of `navigation` transaction on history changes. Useful for react applications with
+     * a router.
+     *
+     * Default: true
+     */
     startTransactionOnLocationChange: boolean;
+    /**
+     * Sample to determine if the Integration should instrument anything. The decision will be taken once per load
+     * on initalization.
+     * 0 = 0% chance of instrumenting
+     * 1 = 100% change of instrumenting
+     *
+     * Default: 1
+     */
     tracesSampleRate: number;
@@ -18,0 +56,0 @@ }

esm/span.js

@@ -5,3 +5,3 @@ // tslint:disable:max-classes-per-file
 import { SpanStatus } from '@sentry/types';
-import { logger, timestampWithMs, uuid4 } from '@sentry/utils';
+import { isInstanceOf, logger, timestampWithMs, uuid4 } from '@sentry/utils';
 // TODO: Should this be exported?
@@ -72,3 +72,3 @@ export var TRACEPARENT_REGEXP = new RegExp('^[ \\t]*' + // whitespace
         this.data = {};
-        if (hub instanceof Hub) {
+        if (isInstanceOf(hub, Hub)) {
             this._hub = hub;
@@ -216,3 +216,2 @@ }
         return this._hub.captureEvent({
-            contexts: { trace: this.getTraceContext() },
             spans: finishedSpans,
@@ -240,3 +239,3 @@ start_timestamp: this.startTimestamp,
     Span.prototype.getTraceContext = function () {
-        var context = {
+        return {
             data: this.data,
@@ -247,10 +246,7 @@ description: this.description,
             span_id: this._spanId,
+            // Undefined status will be dropped by `JSON.stringify` anyway so it's safe to read it directly like that
+            status: this.tags.status,
             tags: this.tags,
             trace_id: this._traceId,
         };
-        if (this.tags.status) {
-            // TODO: Fixme, just use better typings
-            context.status = this.tags.status;
-        }
-        return context;
     };
@@ -257,0 +253,0 @@ /**

package.json

 {
   "name": "@sentry/apm",
-  "version": "5.10.0-rc.0",
+  "version": "5.10.0",
   "description": "Extensions for APM",
@@ -19,6 +19,6 @@ "repository": "git://github.com/getsentry/sentry-javascript.git",
   "dependencies": {
-    "@sentry/hub": "5.10.0-rc.0",
-    "@sentry/minimal": "5.10.0-rc.0",
-    "@sentry/types": "5.10.0-rc.0",
-    "@sentry/utils": "5.10.0-rc.0",
+    "@sentry/hub": "5.10.0",
+    "@sentry/minimal": "5.10.0",
+    "@sentry/types": "5.10.0",
+    "@sentry/utils": "5.10.0",
     "tslib": "^1.9.3"
@@ -25,0 +25,0 @@ },

New alerts

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

199604

2.35%

Lines of code

2399

3.01%

Number of low quality alerts

0

-100%

Worsened metrics

Number of medium maintenance alerts

1

Infinity%

Number of medium supply chain risk alerts

1

Infinity%

Dependency changes

• + Added

  @sentry/hub@5.10.0
  (transitive)

• + Added

  @sentry/minimal@5.10.0
  (transitive)

• + Added

  @sentry/types@5.10.0
  (transitive)

• + Added

  @sentry/utils@5.10.0
  (transitive)

• - Removed

  @sentry/hub@5.10.0-rc.0
  (transitive)

• - Removed

  @sentry/minimal@5.10.0-rc.0
  (transitive)

• - Removed

  @sentry/types@5.10.0-rc.0
  (transitive)

• - Removed

  @sentry/utils@5.10.0-rc.0
  (transitive)

• Updated

  @sentry/hub@5.10.0

• Updated

  @sentry/minimal@5.10.0

• Updated

  @sentry/types@5.10.0

• Updated

  @sentry/utils@5.10.0