otel4s-sdk-trace
0.6.0
API
Generated with
otel4s-sdk-trace/org.typelevel.otel4s.sdk.trace/org.typelevel.otel4s.sdk.trace.processor/BatchSpanProcessor

BatchSpanProcessor

org.typelevel.otel4s.sdk.trace.processor.BatchSpanProcessor
See theBatchSpanProcessor companion object
final class BatchSpanProcessor[F[_]] extends SpanProcessor[F]

Implementation of the SpanProcessor that batches spans exported by the SDK then pushes them to the exporter pipeline.

All spans reported by the SDK implementation are first added to a queue. If the queue is full (with a config.maxQueueSize maximum size), the incoming spans are dropped.

Spans are exported either when there are config.maxExportBatchSize pending spans or config.scheduleDelay has passed since the last export attempt.

Type parameters

F

the higher-kinded type of a polymorphic effect

Attributes

See also
Companion
object
Source
BatchSpanProcessor.scala
Graph
Supertypes
trait SpanProcessor[F]
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def forceFlush: F[Unit]

Processes all pending spans (if any).

Processes all pending spans (if any).

Attributes

Source
BatchSpanProcessor.scala
def onEnd(span: SpanData): F[Unit]

Called when a span is ended, if the span.isRecording returns true.

Called when a span is ended, if the span.isRecording returns true.

This method is called synchronously on the execution thread, should not throw or block the execution thread.

Value parameters

span

the ended span

Attributes

Source
BatchSpanProcessor.scala
def onStart(parentContext: Option[SpanContext], span: SpanRef[F]): F[Unit]

Called when a span is started, if the span.isRecording returns true.

Called when a span is started, if the span.isRecording returns true.

This method is called synchronously on the execution thread, should not throw or block the execution thread.

Value parameters

parentContext

the optional parent SpanContext

span

the started span

Attributes

Source
BatchSpanProcessor.scala

Inherited methods

override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
SpanProcessor -> Any
Inherited from:
SpanProcessor
Source
SpanProcessor.scala

Concrete fields

val isEndRequired: Boolean

Whether the SpanProcessor requires end events.

Whether the SpanProcessor requires end events.

If true, the onEnd will be called upon the end of a span.

Attributes

Source
BatchSpanProcessor.scala
val isStartRequired: Boolean

Whether the SpanProcessor requires start events.

Whether the SpanProcessor requires start events.

If true, the onStart will be called upon the start of a span.

Attributes

Source
BatchSpanProcessor.scala
val name: String

The name of the processor.

The name of the processor.

It will be used in an exception to distinguish individual failures in the multi-error scenario.

Attributes

See also
Source
BatchSpanProcessor.scala
Generated with