ActivityModule
PackageAxial.Telemetry
Summary
| Name | Signature | Synopsis |
|---|---|---|
| Operations | ||
| runtimeSource | Activity.runtimeSource | The activity source for Axial's own runtime spans (fiber lifecycle, defects, and metrics). |
| traceWithSource | Activity.traceWithSource activitySource renderError name sourceFlow | Wraps a flow in a new activity from the supplied application-owned source, exports the ambient telemetry context, and stamps the final exit onto the span. |
| traceOn | Activity.traceOn activitySource name sourceFlow | Wraps a flow in an application-owned activity source and renders typed errors with string. |
| withTracer | Activity.withTracer tracer (Flow operation) | Installs an application-owned as the ambient tracer for the scope of sourceFlow. |
| traceWith | Activity.traceWith renderError name sourceFlow | Wraps a flow in the ambient application tracer installed by withTracer, using the supplied typed-error renderer. |
| trace | Activity.trace name sourceFlow | Wraps a flow in the ambient application tracer installed by withTracer, and renders typed errors with string. |
Operations
kind:member
kind:member
Wraps a flow in a new activity from the supplied application-owned source, exports the ambient telemetry
context, and stamps the final exit onto the span.
Parameters
| Name | Type | Description |
|---|---|---|
| activitySource | ActivitySource | The application-owned activity source that emits the span. |
| renderError | 'error -> string | Renders typed errors for the axial.flow.error attribute. |
| name | string | The name of the activity. |
| sourceFlow | Flow<'env, 'error, 'value> | The flow to trace. |
Returns
Flow<'env, 'error, 'value>
kind:member
Wraps a flow in an application-owned activity source and renders typed errors with
string.Parameters
| Name | Type | Description |
|---|---|---|
| activitySource | ActivitySource | The application-owned activity source that emits the span. |
| name | string | The name of the activity. |
| sourceFlow | Flow<'env, 'error, 'value> | The flow to trace. |
Returns
Flow<'env, 'error, 'value>
kind:member
Installs an application-owned ActivityTracer as the ambient tracer for the
scope of
sourceFlow. trace and traceWith read this ambient tracer; child
fibers forked within the scope inherit it.
Parameters
| Name | Type | Description |
|---|---|---|
| tracer | ActivityTracer | The application-owned tracer to install. |
| Flow operation | Flow<'env, 'error, 'value> |
Returns
Flow<'env, 'error, 'value>
kind:member
Wraps a flow in the ambient application tracer installed by
withTracer, using the supplied typed-error
renderer. Throws if no ambient tracer is installed. Use traceWithSource to supply a source explicitly
instead of relying on the ambient one.
Parameters
| Name | Type | Description |
|---|---|---|
| renderError | 'error -> string | |
| name | string | |
| sourceFlow | Flow<'env, 'error, 'value> |
Returns
Flow<'env, 'error, 'value>
kind:member
Wraps a flow in the ambient application tracer installed by
withTracer, and renders typed errors with
string. Throws if no ambient tracer is installed. Use traceOn to supply a source explicitly
instead of relying on the ambient one.
Parameters
| Name | Type | Description |
|---|---|---|
| name | string | |
| sourceFlow | Flow<'env, 'error, 'value> |
Returns
Flow<'env, 'error, 'value>