feat: APM updates

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- [hub] feat: Add more span functions (#2161)
+- [integrations] feat: Change `Tracing` integration (#2161)
 - [browser] feat: Refactor breadcrumbs integration to allow for custom handlers
 
 ## 5.9.1

package.json

@@ -5,7 +5,7 @@
     "build:es5": "lerna run --stream --concurrency 1 --sort build:es5",
     "build:esm": "lerna run --stream --concurrency 1 --sort build:esm",
     "build:watch": "lerna run build:watch --stream --no-sort --concurrency 9999",
-    "clean": "lerna run --stream clean",
+    "clean": "lerna run --stream clean && lerna clean --yes",
     "fix": "lerna run --stream --concurrency 1 fix",
     "link:yarn": "lerna run --stream --concurrency 1 link:yarn",
     "lint": "lerna run --stream --concurrency 1 lint",

packages/browser/package.json

@@ -43,6 +43,7 @@
     "rollup": "^1.10.1",
     "rollup-plugin-commonjs": "^9.3.4",
     "rollup-plugin-license": "^0.8.1",
+    "rollup-plugin-modify": "^3.0.0",
     "rollup-plugin-node-resolve": "^4.2.3",
     "rollup-plugin-terser": "^4.0.4",
     "rollup-plugin-typescript2": "^0.21.0",

packages/browser/src/index.ts

@@ -30,6 +30,7 @@ export {
   setTag,
   setTags,
   setUser,
+  startSpan,
   Span,
   withScope,
 } from '@sentry/core';

packages/core/src/api.ts

@@ -1,5 +1,5 @@
 import { DsnLike } from '@sentry/types';
-import { urlEncode } from '@sentry/utils';
+import { timestampWithMs, urlEncode } from '@sentry/utils';
 
 import { Dsn } from './dsn';
 
@@ -28,7 +28,7 @@ export class API {
   public getStoreEndpointWithUrlEncodedAuth(): string {
     const dsn = this._dsnObject;
     const auth = {
-      sentry_key: dsn.user,
+      sentry_key: dsn.user, // sentry_key is currently used in tracing integration to identify internal sentry requests
       sentry_version: SENTRY_API_VERSION,
     };
     // Auth is intentionally sent as part of query string (NOT as custom HTTP header)
@@ -54,7 +54,7 @@ export class API {
   public getRequestHeaders(clientName: string, clientVersion: string): { [key: string]: string } {
     const dsn = this._dsnObject;
     const header = [`Sentry sentry_version=${SENTRY_API_VERSION}`];
-    header.push(`sentry_timestamp=${new Date().getTime()}`);
+    header.push(`sentry_timestamp=${timestampWithMs()}`); // TODO: This can be removed
     header.push(`sentry_client=${clientName}/${clientVersion}`);
     header.push(`sentry_key=${dsn.user}`);
     if (dsn.pass) {

packages/core/src/index.ts

@@ -10,6 +10,7 @@ export {
   setTag,
   setTags,
   setUser,
+  startSpan,
   withScope,
 } from '@sentry/minimal';
 export { addGlobalEventProcessor, getCurrentHub, getHubFromCarrier, Hub, Scope, Span } from '@sentry/hub';

packages/core/test/lib/api.test.ts

@@ -16,14 +16,14 @@ describe('API', () => {
     expect(new API(dsnPublic).getRequestHeaders('a', '1.0')).toMatchObject({
       'Content-Type': 'application/json',
       'X-Sentry-Auth': expect.stringMatching(
-        /^Sentry sentry_version=\d, sentry_timestamp=\d+, sentry_client=a\/1\.0, sentry_key=abc$/,
+        /^Sentry sentry_version=\d, sentry_timestamp=\d+\.\d+, sentry_client=a\/1\.0, sentry_key=abc$/,
       ),
     });
 
     expect(new API(legacyDsn).getRequestHeaders('a', '1.0')).toMatchObject({
       'Content-Type': 'application/json',
       'X-Sentry-Auth': expect.stringMatching(
-        /^Sentry sentry_version=\d, sentry_timestamp=\d+, sentry_client=a\/1\.0, sentry_key=abc, sentry_secret=123$/,
+        /^Sentry sentry_version=\d, sentry_timestamp=\d+\.\d+, sentry_client=a\/1\.0, sentry_key=abc, sentry_secret=123$/,
       ),
     });
   });

packages/hub/src/hub.ts

@@ -8,12 +8,22 @@ import {
   Integration,
   IntegrationClass,
   Severity,
+  SpanContext,
   User,
 } from '@sentry/types';
-import { consoleSandbox, dynamicRequire, getGlobalObject, isNodeEnv, logger, uuid4 } from '@sentry/utils';
+import {
+  consoleSandbox,
+  dynamicRequire,
+  getGlobalObject,
+  isNodeEnv,
+  logger,
+  timestampWithMs,
+  uuid4,
+} from '@sentry/utils';
 
 import { Carrier, Layer } from './interfaces';
 import { Scope } from './scope';
+import { Span } from './span';
 
 declare module 'domain' {
   export let active: Domain;
@@ -25,6 +35,14 @@ declare module 'domain' {
   }
 }
 
+/**
+ * Checks whether given value is instance of Span
+ * @param span value to check
+ */
+function isSpanInstance(span: unknown): span is Span {
+  return span instanceof Span;
+}
+
 /**
  * API compatibility version of this hub.
  *
@@ -251,7 +269,7 @@ export class Hub implements HubInterface {
       return;
     }
 
-    const timestamp = new Date().getTime() / 1000;
+    const timestamp = timestampWithMs();
     const mergedBreadcrumb = { timestamp, ...breadcrumb };
     const finalBreadcrumb = beforeBreadcrumb
       ? (consoleSandbox(() => beforeBreadcrumb(mergedBreadcrumb, hint)) as Breadcrumb | null)
@@ -372,9 +390,9 @@ export class Hub implements HubInterface {
    * @inheritDoc
    */
   public traceHeaders(): { [key: string]: string } {
-    const top = this.getStackTop();
-    if (top.scope && top.client) {
-      const span = top.scope.getSpan();
+    const scope = this.getScope();
+    if (scope) {
+      const span = scope.getSpan();
       if (span) {
         return {
           'sentry-trace': span.toTraceparent(),
@@ -383,6 +401,40 @@ export class Hub implements HubInterface {
     }
     return {};
   }
+
+  /**
+   * @inheritDoc
+   */
+  public startSpan(spanOrSpanContext?: Span | SpanContext, forceNoChild: boolean = false): Span {
+    const scope = this.getScope();
+    const client = this.getClient();
+    let span;
+
+    if (!isSpanInstance(spanOrSpanContext) && !forceNoChild) {
+      if (scope) {
+        const parentSpan = scope.getSpan();
+        if (parentSpan) {
+          span = parentSpan.child(spanOrSpanContext);
+        }
+      }
+    }
+
+    if (!isSpanInstance(span)) {
+      span = new Span(spanOrSpanContext, this);
+    }
+
+    if (span.sampled === undefined && span.transaction !== undefined) {
+      const sampleRate = (client && client.getOptions().tracesSampleRate) || 0;
+      span.sampled = Math.random() < sampleRate;
+    }
+
+    if (span.sampled) {
+      const experimentsOptions = (client && client.getOptions()._experiments) || {};
+      span.initFinishedSpans(experimentsOptions.maxSpans);
+    }
+
+    return span;
+  }
 }
 
 /** Returns the global shim registry. */

packages/hub/src/scope.ts

@@ -1,5 +1,5 @@
 import { Breadcrumb, Event, EventHint, EventProcessor, Scope as ScopeInterface, Severity, User } from '@sentry/types';
-import { getGlobalObject, isThenable, normalize, SyncPromise } from '@sentry/utils';
+import { getGlobalObject, isThenable, normalize, SyncPromise, timestampWithMs } from '@sentry/utils';
 
 import { Span } from './span';
 
@@ -200,16 +200,6 @@ export class Scope implements ScopeInterface {
     return this;
   }
 
-  /**
-   * @inheritDoc
-   */
-  public startSpan(parentSpan?: Span): Span {
-    const span = new Span();
-    span.setParent(parentSpan);
-    this.setSpan(span);
-    return span;
-  }
-
   /**
    * Internal getter for Span, used in Hub.
    * @hidden
@@ -260,7 +250,7 @@ export class Scope implements ScopeInterface {
    * @inheritDoc
    */
   public addBreadcrumb(breadcrumb: Breadcrumb, maxBreadcrumbs?: number): this {
-    const timestamp = new Date().getTime() / 1000;
+    const timestamp = timestampWithMs();
     const mergedBreadcrumb = { timestamp, ...breadcrumb };
 
     this._breadcrumbs =