Flow PHP

trace_id()

Create a TraceId.

Parameters

$hex : null|string = null

Optional 32-character hexadecimal string

Tags

throws

InvalidArgumentException

if the hex string is invalid

span_id()

Create a SpanId.

Parameters

$hex : null|string = null

Optional 16-character hexadecimal string

Tags

throws

InvalidArgumentException

if the hex string is invalid

baggage()

Create a Baggage.

Parameters

$entries : array<string, string> = []

Initial key-value entries

context()

Create a Context.

Parameters

$traceId : null|TraceId = null

Optional TraceId to use

$baggage : null|Baggage = null

Optional Baggage to use

memory_context_storage()

Create a MemoryContextStorage.

Parameters

$context : null|Context = null

Optional initial context

resource()

Create a Resource.

Parameters

$attributes : array<string, array<string|int, mixed>|bool|DateTimeInterface|float|int|string|Throwable>|Attributes = []

Resource attributes

span_context()

Create a SpanContext.

Parameters

$traceId : TraceId

The trace ID

$spanId : SpanId

The span ID

$parentSpanId : null|SpanId = null

Optional parent span ID

span_event()

Create a SpanEvent (GenericEvent) with an explicit timestamp.

Parameters

$name : string

Event name

$timestamp : DateTimeImmutable

Event timestamp

$attributes : array<string, array<string|int, mixed>|bool|DateTimeInterface|float|int|string|Throwable>|Attributes = []

Event attributes

span_link()

Create a SpanLink.

Parameters

$context : SpanContext

The linked span context

$attributes : array<string, array<string|int, mixed>|bool|DateTimeInterface|float|int|string|Throwable>|Attributes = []

Link attributes

span_limits()

Create SpanLimits configuration.

Parameters

$attributeCountLimit : int = 128

Maximum number of attributes per span

$eventCountLimit : int = 128

Maximum number of events per span

$linkCountLimit : int = 128

Maximum number of links per span

$attributePerEventCountLimit : int = 128

Maximum number of attributes per event

$attributePerLinkCountLimit : int = 128

Maximum number of attributes per link

$attributeValueLengthLimit : null|int = null

Maximum length for string attribute values (null = unlimited)

log_record_limits()

Create LogRecordLimits configuration.

Parameters

$attributeCountLimit : int = 128

Maximum number of attributes per log record

$attributeValueLengthLimit : null|int = null

Maximum length for string attribute values (null = unlimited)

metric_limits()

Create MetricLimits configuration.

Parameters

$cardinalityLimit : int = 2000

Maximum number of unique attribute combinations per instrument

void_span_processor()

Create a VoidSpanProcessor.

void_metric_processor()

Create a VoidMetricProcessor.

void_log_processor()

Create a VoidLogProcessor.

void_exporter()

Create a VoidExporter.

memory_exporter()

Create a MemoryExporter.

memory_span_processor()

Create a MemorySpanProcessor.

Parameters

$exporter : Exporter

The exporter to send spans to

$errorHandler : ErrorHandler = new ErrorLogHandler()

Handler for Throwables raised by the exporter

memory_metric_processor()

Create a MemoryMetricProcessor.

Parameters

$exporter : Exporter

The exporter to send metrics to

$errorHandler : ErrorHandler = new ErrorLogHandler()

Handler for Throwables raised by the exporter

memory_log_processor()

Create a MemoryLogProcessor.

Parameters

$exporter : Exporter

The exporter to send logs to

$errorHandler : ErrorHandler = new ErrorLogHandler()

Handler for Throwables raised by the exporter

tracer_provider()

Create a TracerProvider.

Parameters

$processor : SpanProcessor

The processor for spans

$clock : ClockInterface

The clock for timestamps

$contextStorage : ContextStorage

Storage for context propagation

$sampler : Sampler = new AlwaysOnSampler()

Sampling strategy for spans

$limits : SpanLimits = new SpanLimits()

Limits for span attributes, events, and links

$errorHandler : ErrorHandler = new ErrorLogHandler()

Handler for runtime Throwables raised by the processor

logger_provider()

Create a LoggerProvider.

Parameters

$processor : LogProcessor

The processor for logs

$clock : ClockInterface

The clock for timestamps

$contextStorage : ContextStorage

Storage for span correlation

$limits : LogRecordLimits = new LogRecordLimits()

Limits for log record attributes

$errorHandler : ErrorHandler = new ErrorLogHandler()

Handler for runtime Throwables raised by the processor

meter_provider()

Create a MeterProvider.

Parameters

$processor : MetricProcessor

The processor for metrics

$clock : ClockInterface

The clock for timestamps

$temporality : AggregationTemporality = AggregationTemporality::CUMULATIVE

Aggregation temporality for metrics

$exemplarFilter : ExemplarFilter = new TraceBasedExemplarFilter()

Filter for exemplar sampling (default: TraceBasedExemplarFilter)

$limits : MetricLimits = new MetricLimits()

Cardinality limits for metric instruments

$errorHandler : ErrorHandler = new ErrorLogHandler()

Handler for runtime Throwables raised by the processor

telemetry()

Create a new Telemetry instance with the given providers.

Parameters

$resource : Resource

The resource describing the entity producing telemetry

$tracerProvider : null|TracerProvider = null

The tracer provider (null for void/disabled)

$meterProvider : null|MeterProvider = null

The meter provider (null for void/disabled)

$loggerProvider : null|LoggerProvider = null

The logger provider (null for void/disabled)

$errorHandler : ErrorHandler = new ErrorLogHandler()

Handler propagated to default void providers when explicit ones are not supplied

instrumentation_scope()

Create an InstrumentationScope.

Parameters

$name : string

The instrumentation scope name

$version : string = 'unknown'

The instrumentation scope version

$schemaUrl : null|string = null

Optional schema URL

$attributes : Attributes = new Attributes()

batching_span_processor()

Create a BatchingSpanProcessor.

Parameters

$exporter : Exporter

The exporter to send spans to

$batchSize : int = 512

Number of spans to collect before exporting (default 512)

$errorHandler : ErrorHandler = new ErrorLogHandler()

Handler for Throwables raised by the exporter

pass_through_span_processor()

Create a PassThroughSpanProcessor.

Parameters

$exporter : Exporter

The exporter to send spans to

$errorHandler : ErrorHandler = new ErrorLogHandler()

Handler for Throwables raised by the exporter

batching_metric_processor()

Create a BatchingMetricProcessor.

Parameters

$exporter : Exporter

The exporter to send metrics to

$batchSize : int = 512

Number of metrics to collect before exporting (default 512)

$errorHandler : ErrorHandler = new ErrorLogHandler()

Handler for Throwables raised by the exporter

pass_through_metric_processor()

Create a PassThroughMetricProcessor.

Parameters

$exporter : Exporter

The exporter to send metrics to

$errorHandler : ErrorHandler = new ErrorLogHandler()

Handler for Throwables raised by the exporter

batching_log_processor()

Create a BatchingLogProcessor.

Parameters

$exporter : Exporter

The exporter to send logs to

$batchSize : int = 512

Number of logs to collect before exporting (default 512)

$errorHandler : ErrorHandler = new ErrorLogHandler()

Handler for Throwables raised by the exporter

pass_through_log_processor()

Create a PassThroughLogProcessor.

Parameters

$exporter : Exporter

The exporter to send logs to

$errorHandler : ErrorHandler = new ErrorLogHandler()

Handler for Throwables raised by the exporter

pipeline_log_processor()

Create a PipelineLogProcessor: run each log entry through an ordered chain of middleware, then forward the survivors to a single sink.

Parameters

$middleware : array<int, LogMiddleware>

run in order; the first to drop an entry short-circuits the rest

$sink : LogSink

the terminal processor that exports surviving entries

enriching_log_middleware()

Create an EnrichingLogMiddleware that merges default attributes into every log entry. Attributes set at the call site win over these defaults.

Parameters

$attributes : array<string, array<string|int, mixed>|bool|DateTimeInterface|float|int|string|Throwable>|Attributes

attribute_filtering_log_middleware()

Create an AttributeFilteringLogMiddleware that drops log entries matching the filter.

Parameters

$filter : AttributeFilter

The attribute filter to apply

severity_filtering_log_middleware()

Create a SeverityFilteringLogMiddleware that drops log entries below a minimum severity.

Parameters

$minimumSeverity : Severity = Severity::INFO

Minimum severity level (default: INFO)

attribute_rule()

Create a single attribute-matching rule for an AttributeFilter.

Parameters

$path : array<string|int, string>|string

attribute path: a top-level key, or segments descending into nested array values

$mode : MatchMode

comparison applied between the value at the path and the expected value

$expected : bool|DateTimeInterface|float|int|string

expected value (must be a string for the pattern modes)

$caseSensitive : bool = true

applies to the substring modes only (STARTS_WITH, ENDS_WITH, CONTAINS)

all()

Combine matchers so that every one must match (logical AND).

Parameters

$matchers : Matcher

any()

Combine matchers so that at least one must match (logical OR).

Parameters

$matchers : Matcher

not()

Negate a matcher (logical NOT).

Parameters

$matcher : Matcher

attribute_filter()

Create an AttributeFilter from a matcher.

Parameters

$matcher : Matcher

the matcher to evaluate against a signal's attributes (compose with all(), any(), not())

$exclude : bool = true

when true (default) a match drops the signal; when false only matching signals are kept

$sources : array<int, AttributeSource> = [AttributeSource::SIGNAL]

which attribute sets to inspect (signal, resource and/or scope); the matcher is OR-combined across them, defaulting to the signal's own attributes

$cacheDir : null|string = null

directory for the generated matcher file (defaults to the system temp directory). It is required, so it MUST be trusted - not writable by untrusted users. Prefer an application-private directory over the shared system temp in multi-tenant environments.

$cacheDirPermissions : int = 0700

mode applied when the cache directory is created (octal, subject to umask; defaults to 0700 - owner only, since the directory holds required PHP)

attribute_filtering_metric_processor()

Create an AttributeFilteringMetricProcessor.

Parameters

$processor : MetricProcessor

The processor to wrap

$filter : AttributeFilter

The attribute filter to apply

attribute_filtering_span_processor()

Create an AttributeFilteringSpanProcessor.

Parameters

$processor : SpanProcessor

The processor to wrap

$filter : AttributeFilter

The attribute filter to apply

console_exporter()

Create a unified ConsoleExporter for logs, metrics, and spans.

Parameters

$colors : bool = true

Whether to use ANSI colors (default: true)

$maxLogBodyLength : null|int = 100

Maximum length for log body+attributes column (null = no limit)

$logOptions : ConsoleLogOptions = new ConsoleLogOptions()

Display options for log records

$metricOptions : ConsoleMetricOptions = new ConsoleMetricOptions()

Display options for metrics

$spanOptions : ConsoleSpanOptions = new ConsoleSpanOptions()

Display options for spans

console_span_options()

Create ConsoleSpanOptions with all display options enabled (default behavior).

console_span_options_minimal()

Create ConsoleSpanOptions with minimal display (legacy compact format).

console_log_options()

Create ConsoleLogOptions with all display options enabled (default behavior).

console_log_options_minimal()

Create ConsoleLogOptions with minimal display (legacy compact format).

console_metric_options()

Create ConsoleMetricOptions with all display options enabled (default behavior).

console_metric_options_minimal()

Create ConsoleMetricOptions with minimal display (legacy compact format).

always_on_exemplar_filter()

Create an AlwaysOnExemplarFilter.

always_off_exemplar_filter()

Create an AlwaysOffExemplarFilter.

trace_based_exemplar_filter()

Create a TraceBasedExemplarFilter.

always_on_sampler()

Create an AlwaysOnSampler. Records and samples every span.

always_off_sampler()

Create an AlwaysOffSampler. Drops every span.

trace_id_ratio_based_sampler()

Create a TraceIdRatioBasedSampler. Samples a deterministic fraction of traces.

Parameters

$ratio : float

Sampling probability between 0.0 and 1.0

parent_based_sampler()

Create a ParentBasedSampler. Honors the parent span's sampling decision, falling back to the root sampler for spans without a parent.

Parameters

$root : Sampler = new AlwaysOnSampler()

Sampler used for root spans (no parent)

attribute_matching_sampler()

Create an AttributeMatchingSampler. Drops spans whose start-time attributes match the filter (or keeps ONLY matching spans when the filter's exclude is false), and defers all other spans to the delegate sampler.

Parameters

$filter : AttributeFilter

The attribute filter evaluated against the span's start attributes

$delegate : Sampler = new AlwaysOnSampler()

Sampler that decides spans which do not match (default: AlwaysOnSampler)

propagation_context()

Create a PropagationContext.

Parameters

$spanContext : null|SpanContext = null

Optional span context

$baggage : null|Baggage = null

Optional baggage

array_carrier()

Create an ArrayCarrier.

Parameters

$data : array<string, string> = []

Initial carrier data

superglobal_carrier()

Create a SuperglobalCarrier.

w3c_trace_context()

Create a W3CTraceContext propagator.

w3c_baggage()

Create a W3CBaggage propagator.

composite_propagator()

Create a CompositePropagator.

Parameters

$propagators : Propagator

The propagators to combine

chain_detector()

Create a ChainDetector.

Parameters

$detectors : ResourceDetector

The detectors to chain

os_detector()

Create an OsDetector.

host_detector()

Create a HostDetector.

process_detector()

Create a ProcessDetector.

environment_detector()

Create an EnvironmentDetector.

composer_detector()

Create a ComposerDetector.

manual_detector()

Create a ManualDetector.

Parameters

$attributes : array<string, array<string|int, mixed>|bool|DateTimeInterface|float|int|string|Throwable>

Resource attributes

caching_detector()

Create a CachingDetector.

Parameters

$detector : ResourceDetector

The detector to wrap

$cachePath : null|string = null

Cache file path (default: sys_get_temp_dir()/flow_telemetry_resource.cache)

resource_detector()

Create a resource detector chain.

Parameters

$detectors : array<string|int, ResourceDetector> = []

Optional custom detectors (empty = use defaults)

error_log_handler()

Create the default ErrorLogHandler. Writes via PHP's error_log().

Parameters

$messageType : ErrorLogMessageType = ErrorLogMessageType::OperatingSystem

$expandNewlines : bool = false

$messagePrefix : string = '[flow-telemetry]'

stream_error_handler()

Create a StreamHandler. Appends formatted Throwables (one per line) to a file path or php:// stream wrapper.

Parameters

$destination : string

$filePermissions : int = 0644

$createDirectories : bool = true

$messagePrefix : string = '[flow-telemetry]'

syslog_error_handler()

Create a SyslogHandler. Writes via openlog/syslog/closelog.

Parameters

$ident : string = 'flow-telemetry'

$facility : SyslogFacility = SyslogFacility::User

$logOpts : int = LOG_PID

$severity : SyslogSeverity = SyslogSeverity::Error

udp_syslog_error_handler()

Create a UdpSyslogHandler. Sends RFC 5424-style syslog frames over UDP.

Parameters

$host : string

$port : int = 514

$ident : string = 'flow-telemetry'

$facility : SyslogFacility = SyslogFacility::User

$severity : SyslogSeverity = SyslogSeverity::Error

composite_error_handler()

Fan errors out to multiple handlers.

Parameters

$handlers : ErrorHandler

null_error_handler()

Discard every error. Use only in tests or for explicit silence.