File tree Expand file tree Collapse file tree 1 file changed +15
-4
lines changed Expand file tree Collapse file tree 1 file changed +15
-4
lines changed Original file line number Diff line number Diff line change @@ -169,10 +169,21 @@ export function _callOnClient(method: string, ...args: any[]): void {
169
169
}
170
170
171
171
/**
172
- * This starts a Transaction and is considered the entry point to do manual tracing. You can add child spans
173
- * to a transactions. After that more children can be added to created spans to buld a tree structure.
174
- * This function returns a Transaction and you need to keep track of the instance yourself. When you call `.finsh()` on
175
- * a transaction it will be sent to Sentry.
172
+ * Starts a new transaction and returns it. This is the entry point to manual
173
+ * tracing instrumentation.
174
+ *
175
+ * A tree structure can be built by adding child spans to the transaction, and
176
+ * child spans to other spans. To start a new child span within the transaction
177
+ * or any span, call the respective `.startChild()` method.
178
+ *
179
+ * Every child span must be finished before the transaction is finished,
180
+ * otherwise the unfinished spans are discarded.
181
+ *
182
+ * The transaction must be finished with a call to its `.finish()` method, at
183
+ * which point the transaction with all its finished child spans will be sent to
184
+ * Sentry.
185
+ *
186
+ * @param context Properties with which the Transaction should be created.
176
187
*/
177
188
export function startTransaction ( transactionContext : TransactionContext ) : Transaction {
178
189
return callOnHub < Transaction > ( 'startSpan' , {
You can’t perform that action at this time.
0 commit comments