feat: Add helper for old api to guide users to startTransaction

packages/apm/src/hubextensions.ts

@@ -20,20 +20,27 @@ function traceHeaders(this: Hub): { [key: string]: string } {
 }
 
 /**
- * This functions starts a span. If there is already a `Span` on the Scope,
- * the created Span with the SpanContext will have a reference to it and become it's child.
- * Otherwise it'll crete a new `Span`.
- *
- * @param context Properties with which the span should be created
+ * {@see Hub.startSpan}
  */
 function startSpan(this: Hub, context: SpanContext | TransactionContext): Transaction | Span {
+  /**
+   * @deprecated
+   * We have this here as a fallback to not break users upgrading to the new API
+   */
+  if ((context as any).transaction !== undefined) {
+    logger.warn(`Use \`Sentry.startTransaction({name: ${(context as any).transaction}})\` to start a Transaction.`);
+    (context as TransactionContext).name = (context as any).transaction as string;
+    (context as TransactionContext)._isTransaction = true;
+  }
+
   // This is our safeguard so people always get a Transaction in return.
   // We set `_isTransaction: true` in {@link Sentry.startTransaction} to have a runtime check
   // if the user really wanted to create a Transaction.
   if ((context as TransactionContext)._isTransaction && !(context as TransactionContext).name) {
     logger.warn('You are trying to start a Transaction but forgot to provide a `name` property.');
-    logger.warn('Will fall back to <unlabeled transaction>, use `transaction.setName()` to change it.');
-    (context as TransactionContext).name = '<unlabeled transaction>';
+    const name = '<unlabeled transaction>';
+    logger.warn(`Will fall back to \`${name}\``);
+    (context as TransactionContext).name = name;
   }
 
   if ((context as TransactionContext).name) {

packages/types/src/hub.ts

@@ -174,8 +174,8 @@ export interface Hub {
   traceHeaders(): { [key: string]: string };
 
   /**
-   * This functions starts either a Span or a Transaction (depending on the argument passed).
-   * If there is a Span on the Scope we use the `trace_id` for all other created Transactions / Spans as a reference.
+   * This functions starts either a Span or a Transaction (depending on the context).
+   * If there is a Span on the Scope, the created Span will be a child.
    *
    * @param context Properties with which the Transaction/Span should be created
    */