Skip to content

sync async_capture_span docs with capture_span #1668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 26, 2022
Merged

sync async_capture_span docs with capture_span #1668

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions docs/api.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -469,13 +469,13 @@ def coffee_maker(strength):
fresh_pots()
----

* `name`: The name of the span
* `name`: The name of the span. Defaults to the function name if used as a decorator.
* `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`.
* `skip_frames`: (*optional*) The number of stack frames to skip when collecting stack traces. Defaults to `0`.
* `leaf`: (*optional*) if `True`, all spans nested bellow this span will be ignored. Defaults to `False`.
* `labels`: (*optional*) a dictionary of labels. Keys must be strings, values can be strings, booleans, or numerical (`int`, `float`, `decimal.Decimal`). Defaults to `None`.
* `span_subtype`: (*optional*) subtype of the span, e.g. name of the database. Defaults to `None`.
* `span_action`: (*optional*) action of the span, e.g. `query`. Defaults to `None`
* `span_action`: (*optional*) action of the span, e.g. `query`. Defaults to `None`.
* `links`: (*optional*) A list of `TraceParent` objects to which this span is causally linked.


Expand Down Expand Up @@ -508,13 +508,14 @@ async def coffee_maker(strength):
fresh_pots()
----

* `name`: The name of the span
* `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`.
* `skip_frames`: The number of stack frames to skip when collecting stack traces. Defaults to `0`.
* `leaf`: if `True`, all spans nested bellow this span will be ignored. Defaults to `False`.
* `labels`: a dictionary of labels. Keys must be strings, values can be strings, booleans, or numerical (`int`, `float`, `decimal.Decimal`). Defaults to `None`.
* `span_subtype`: subtype of the span, e.g. name of the database. Defaults to `None`.
* `span_action`: action of the span, e.g. `query`. Defaults to `None`
* `name`: The name of the span. Defaults to the function name if used as a decorator.
* `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`.
* `skip_frames`: (*optional*) The number of stack frames to skip when collecting stack traces. Defaults to `0`.
* `leaf`: (*optional*) if `True`, all spans nested bellow this span will be ignored. Defaults to `False`.
* `labels`: (*optional*) a dictionary of labels. Keys must be strings, values can be strings, booleans, or numerical (`int`, `float`, `decimal.Decimal`). Defaults to `None`.
* `span_subtype`: (*optional*) subtype of the span, e.g. name of the database. Defaults to `None`.
* `span_action`: (*optional*) action of the span, e.g. `query`. Defaults to `None`.
* `links`: (*optional*) A list of `TraceParent` objects to which this span is causally linked.

NOTE: `asyncio` is only supported for Python 3.7+.

Expand Down