You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api.asciidoc
+10-9Lines changed: 10 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -469,13 +469,13 @@ def coffee_maker(strength):
469
469
fresh_pots()
470
470
----
471
471
472
-
* `name`: The name of the span
472
+
* `name`: The name of the span. Defaults to the function name if used as a decorator.
473
473
* `span_type`: (*optional*) The type of the span, usually in a dot-separated hierarchy of `type`, `subtype`, and `action`, e.g. `db.mysql.query`. Alternatively, type, subtype and action can be provided as three separate arguments, see `span_subtype` and `span_action`.
474
474
* `skip_frames`: (*optional*) The number of stack frames to skip when collecting stack traces. Defaults to `0`.
475
475
* `leaf`: (*optional*) if `True`, all spans nested bellow this span will be ignored. Defaults to `False`.
476
476
* `labels`: (*optional*) a dictionary of labels. Keys must be strings, values can be strings, booleans, or numerical (`int`, `float`, `decimal.Decimal`). Defaults to `None`.
477
477
* `span_subtype`: (*optional*) subtype of the span, e.g. name of the database. Defaults to `None`.
478
-
* `span_action`: (*optional*) action of the span, e.g. `query`. Defaults to `None`
478
+
* `span_action`: (*optional*) action of the span, e.g. `query`. Defaults to `None`.
479
479
* `links`: (*optional*) A list of `TraceParent` objects to which this span is causally linked.
* `span_type`: The type of the span, usually in a dot-separated hierarchy of `type`, `subtype`, and `action`, e.g. `db.mysql.query`. Alternatively, type, subtype and action can be provided as three separate arguments, see `span_subtype` and `span_action`.
513
-
* `skip_frames`: The number of stack frames to skip when collecting stack traces. Defaults to `0`.
514
-
* `leaf`: if `True`, all spans nested bellow this span will be ignored. Defaults to `False`.
515
-
* `labels`: a dictionary of labels. Keys must be strings, values can be strings, booleans, or numerical (`int`, `float`, `decimal.Decimal`). Defaults to `None`.
516
-
* `span_subtype`: subtype of the span, e.g. name of the database. Defaults to `None`.
517
-
* `span_action`: action of the span, e.g. `query`. Defaults to `None`
511
+
* `name`: The name of the span. Defaults to the function name if used as a decorator.
512
+
* `span_type`: (*optional*) The type of the span, usually in a dot-separated hierarchy of `type`, `subtype`, and `action`, e.g. `db.mysql.query`. Alternatively, type, subtype and action can be provided as three separate arguments, see `span_subtype` and `span_action`.
513
+
* `skip_frames`: (*optional*) The number of stack frames to skip when collecting stack traces. Defaults to `0`.
514
+
* `leaf`: (*optional*) if `True`, all spans nested bellow this span will be ignored. Defaults to `False`.
515
+
* `labels`: (*optional*) a dictionary of labels. Keys must be strings, values can be strings, booleans, or numerical (`int`, `float`, `decimal.Decimal`). Defaults to `None`.
516
+
* `span_subtype`: (*optional*) subtype of the span, e.g. name of the database. Defaults to `None`.
517
+
* `span_action`: (*optional*) action of the span, e.g. `query`. Defaults to `None`.
518
+
* `links`: (*optional*) A list of `TraceParent` objects to which this span is causally linked.
518
519
519
520
NOTE: `asyncio` is only supported for Python 3.7+.
0 commit comments