s/sampleContext/samplingContext

Author: lobsterkatie

packages/gatsby/README.md

@@ -56,7 +56,7 @@ To enable tracing, supply either `tracesSampleRate` or `tracesSampler` to the op
         tracesSampleRate: 1,
 
         // Alternatively:
-        tracesSampler: sampleContext => {
+        tracesSampler: samplingContext => {
           // Examine provided context data (along with anything in the global namespace) to decide the sample rate
           // for this transaction.
           // Can return 0 to drop the transaction entirely.

packages/hub/src/hub.ts

@@ -3,7 +3,7 @@ import {
   Breadcrumb,
   BreadcrumbHint,
   Client,
-  CustomSampleContext,
+  CustomSamplingContext,
   Event,
   EventHint,
   Extra,
@@ -370,8 +370,8 @@ export class Hub implements HubInterface {
   /**
    * @inheritDoc
    */
-  public startTransaction(context: TransactionContext, customSampleContext?: CustomSampleContext): Transaction {
-    return this._callExtensionMethod('startTransaction', context, customSampleContext);
+  public startTransaction(context: TransactionContext, customSamplingContext?: CustomSamplingContext): Transaction {
+    return this._callExtensionMethod('startTransaction', context, customSamplingContext);
   }
 
   /**

packages/minimal/src/index.ts

@@ -2,7 +2,7 @@ import { getCurrentHub, Hub, Scope } from '@sentry/hub';
 import {
   Breadcrumb,
   CaptureContext,
-  CustomSampleContext,
+  CustomSamplingContext,
   Event,
   Extra,
   Extras,
@@ -202,11 +202,14 @@ export function _callOnClient(method: string, ...args: any[]): void {
  * finished child spans will be sent to Sentry.
  *
  * @param context Properties of the new `Transaction`.
- * @param customSampleContext Information given to the transaction sampling function (along with context-dependent
+ * @param customSamplingContext Information given to the transaction sampling function (along with context-dependent
  * default values). See {@link Options.tracesSampler}.
  *
  * @returns The transaction which was just started
  */
-export function startTransaction(context: TransactionContext, customSampleContext?: CustomSampleContext): Transaction {
-  return callOnHub('startTransaction', { ...context }, customSampleContext);
+export function startTransaction(
+  context: TransactionContext,
+  customSamplingContext?: CustomSamplingContext,
+): Transaction {
+  return callOnHub('startTransaction', { ...context }, customSamplingContext);
 }

packages/tracing/src/hubextensions.ts

@@ -1,5 +1,5 @@
 import { getActiveDomain, getMainCarrier, Hub } from '@sentry/hub';
-import { CustomSampleContext, SampleContext, TransactionContext } from '@sentry/types';
+import { CustomSamplingContext, SamplingContext, TransactionContext } from '@sentry/types';
 import {
   dynamicRequire,
   extractNodeRequestData,
@@ -48,11 +48,11 @@ function _inheritOrUseGivenRate(parentSampled: boolean | undefined, givenRate: u
  *
  * @param hub: The hub off of which to read config options
  * @param transaction: The transaction needing a sampling decision
- * @param sampleContext: Default and user-provided data which may be used to help make the decision
+ * @param samplingContext: Default and user-provided data which may be used to help make the decision
  *
  * @returns The given transaction with its `sampled` value set
  */
-function sample<T extends Transaction>(hub: Hub, transaction: T, sampleContext: SampleContext = {}): T {
+function sample<T extends Transaction>(hub: Hub, transaction: T, samplingContext: SamplingContext = {}): T {
   const client = hub.getClient();
   const options = (client && client.getOptions()) || {};
 
@@ -66,8 +66,8 @@ function sample<T extends Transaction>(hub: Hub, transaction: T, sampleContext:
   // work; prefer the hook if so
   const sampleRate =
     typeof options.tracesSampler === 'function'
-      ? options.tracesSampler(sampleContext)
-      : _inheritOrUseGivenRate(sampleContext.parentSampled, options.tracesSampleRate);
+      ? options.tracesSampler(samplingContext)
+      : _inheritOrUseGivenRate(samplingContext.parentSampled, options.tracesSampleRate);
 
   // Since this is coming from the user (or from a function provided by the user), who knows what we might get. (The
   // only valid values are booleans or numbers between 0 and 1.)
@@ -116,12 +116,12 @@ function sample<T extends Transaction>(hub: Hub, transaction: T, sampleContext:
  *
  * @returns The default sample context
  */
-function getDefaultSampleContext<T extends Transaction>(transaction: T): SampleContext {
-  const defaultSampleContext: SampleContext = {};
+function getDefaultSamplingContext<T extends Transaction>(transaction: T): SamplingContext {
+  const defaultSamplingContext: SamplingContext = {};
 
   // include parent's sampling decision, if there is one
   if (transaction.parentSpanId && transaction.sampled !== undefined) {
-    defaultSampleContext.parentSampled = transaction.sampled;
+    defaultSamplingContext.parentSampled = transaction.sampled;
   }
 
   if (isNodeEnv()) {
@@ -142,7 +142,7 @@ function getDefaultSampleContext<T extends Transaction>(transaction: T): SampleC
       const request = domain.members.find((member: any) => isInstanceOf(member, requestType));
 
       if (request) {
-        defaultSampleContext.request = extractNodeRequestData(request);
+        defaultSamplingContext.request = extractNodeRequestData(request);
       }
     }
   }
@@ -154,11 +154,11 @@ function getDefaultSampleContext<T extends Transaction>(transaction: T): SampleC
 
     if ('location' in globalObject) {
       // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
-      defaultSampleContext.location = { ...(globalObject as any).location };
+      defaultSamplingContext.location = { ...(globalObject as any).location };
     }
   }
 
-  return defaultSampleContext;
+  return defaultSamplingContext;
 }
 
 /**
@@ -197,10 +197,10 @@ function isValidSampleRate(rate: unknown): boolean {
 function _startTransaction(
   this: Hub,
   context: TransactionContext,
-  customSampleContext?: CustomSampleContext,
+  customSamplingContext?: CustomSamplingContext,
 ): Transaction {
   const transaction = new Transaction(context, this);
-  return sample(this, transaction, { ...getDefaultSampleContext(transaction), ...customSampleContext });
+  return sample(this, transaction, { ...getDefaultSamplingContext(transaction), ...customSamplingContext });
 }
 
 /**
@@ -213,7 +213,7 @@ export function startIdleTransaction(
   onScope?: boolean,
 ): IdleTransaction {
   const transaction = new IdleTransaction(context, hub, idleTimeout, onScope);
-  return sample(hub, transaction, getDefaultSampleContext(transaction));
+  return sample(hub, transaction, getDefaultSamplingContext(transaction));
 }
 
 /**

packages/types/src/hub.ts

@@ -6,7 +6,7 @@ import { Integration, IntegrationClass } from './integration';
 import { Scope } from './scope';
 import { Severity } from './severity';
 import { Span, SpanContext } from './span';
-import { CustomSampleContext, Transaction, TransactionContext } from './transaction';
+import { CustomSamplingContext, Transaction, TransactionContext } from './transaction';
 import { User } from './user';
 
 /**
@@ -194,10 +194,10 @@ export interface Hub {
    * finished child spans will be sent to Sentry.
    *
    * @param context Properties of the new `Transaction`.
-   * @param customSampleContext Information given to the transaction sampling function (along with context-dependent
+   * @param customSamplingContext Information given to the transaction sampling function (along with context-dependent
    * default values). See {@link Options.tracesSampler}.
    *
    * @returns The transaction which was just started
    */
-  startTransaction(context: TransactionContext, customSampleContext?: CustomSampleContext): Transaction;
+  startTransaction(context: TransactionContext, customSamplingContext?: CustomSamplingContext): Transaction;
 }

packages/types/src/index.ts

@@ -23,7 +23,7 @@ export { Span, SpanContext } from './span';
 export { StackFrame } from './stackframe';
 export { Stacktrace } from './stacktrace';
 export { Status } from './status';
-export { CustomSampleContext, SampleContext, Transaction, TransactionContext } from './transaction';
+export { CustomSamplingContext, SamplingContext, Transaction, TransactionContext } from './transaction';
 export { Thread } from './thread';
 export { Transport, TransportOptions, TransportClass } from './transport';
 export { User } from './user';

packages/types/src/options.ts

@@ -2,7 +2,7 @@ import { Breadcrumb, BreadcrumbHint } from './breadcrumb';
 import { Event, EventHint } from './event';
 import { Integration } from './integration';
 import { LogLevel } from './loglevel';
-import { SampleContext } from './transaction';
+import { SamplingContext } from './transaction';
 import { Transport, TransportClass, TransportOptions } from './transport';
 
 /** Base configuration options for every SDK. */
@@ -130,12 +130,12 @@ export interface Options {
    * ignored.
    *
    * Will automatically be passed a context object of default and optional custom data. See
-   * {@link Transaction.sampleContext} and {@link Hub.startTransaction}.
+   * {@link Transaction.samplingContext} and {@link Hub.startTransaction}.
    *
    * @returns A sample rate between 0 and 1 (0 drops the trace, 1 guarantees it will be sent). Returning `true` is
    * equivalent to returning 1 and returning `false` is equivalent to returning 0.
    */
-  tracesSampler?(sampleContext: SampleContext): number | boolean;
+  tracesSampler?(samplingContext: SamplingContext): number | boolean;
 
   /**
    * A callback invoked during event submission, allowing to optionally modify

packages/types/src/transaction.ts

@@ -53,7 +53,7 @@ export interface Transaction extends TransactionContext, Span {
 /**
  * Context data passed by the user when starting a transaction, to be used by the tracesSampler method.
  */
-export interface CustomSampleContext {
+export interface CustomSamplingContext {
   [key: string]: any;
 }
 
@@ -62,7 +62,7 @@ export interface CustomSampleContext {
  *
  * Adds default data to data provided by the user. See {@link Hub.startTransaction}
  */
-export interface SampleContext extends CustomSampleContext {
+export interface SamplingContext extends CustomSamplingContext {
   /**
    * Object representing the URL of the current page or worker script. Passed by default in a browser or service worker
    * context.