Browse documentation

#Telemetry OTLP Bridge

The OTLP (OpenTelemetry Protocol) Bridge provides serializers and transports for sending telemetry data to OpenTelemetry-compatible backends. It extends the Flow Telemetry library with production-ready export capabilities.

#Installation

For detailed installation instructions, see the installation page.

#Transports

The bridge provides three transport options for sending telemetry data to OTLP endpoints.

#Curl Transport (Recommended)

The Curl transport uses curl_multi for non-blocking I/O, making it ideal for production environments where you want to minimize latency impact on your application.

<?php

use function Flow\Bridge\Telemetry\OTLP\DSL\{
    otlp_curl_transport,
    otlp_curl_options,
    otlp_json_serializer,
};

$transport = otlp_curl_transport(
    endpoint: 'http://localhost:4318',
    serializer: otlp_json_serializer(),
);

// With custom options (timeouts in milliseconds — see "Timeouts" below)
$transport = otlp_curl_transport(
    endpoint: 'https://otlp.example.com:4318',
    serializer: otlp_json_serializer(),
    options: otlp_curl_options()
        ->withTimeout(2000)
        ->withConnectTimeout(500)
        ->withHeader('Authorization', 'Bearer your-token')
        ->withCompression(),
);

#gRPC Transport

The gRPC transport uses the native gRPC protocol for high-performance binary communication. It requires the ext-grpc PHP extension. OTLP/gRPC mandates Protobuf, so the transport instantiates the protobuf request factory internally — no serializer parameter.

<?php

use function Flow\Bridge\Telemetry\OTLP\DSL\otlp_grpc_transport;

$transport = otlp_grpc_transport(endpoint: 'localhost:4317');

// With authentication and a tighter call deadline (in milliseconds)
$transport = otlp_grpc_transport(
    endpoint: 'otlp.example.com:4317',
    headers: [
        'Authorization' => 'Bearer your-token',
    ],
    insecure: false, // Use TLS
    timeoutMs: 2000, // call deadline: connect + send + receive
);

Note: gRPC has no separate connect timeout — timeoutMs is the per-call deadline that bounds DNS, connect, send, and receive together. See Timeouts.

#Stream Transport

The Stream transport implements the OTLP File Exporter spec. It writes JSONL to either an absolute file path or a php:// stream wrapper. The handle is opened once in the constructor and reused across send() calls; each call appends one JSON Line under LOCK_EX so concurrent writers interleave at line boundaries.

Only JSON encoding is supported per the spec — the transport hard-codes the JSON serializer; there is no serializer parameter.

<?php

use function Flow\Bridge\Telemetry\OTLP\DSL\otlp_stream_transport;

// Append to a file (creates parent directories by default, chmod 0644 on first create)
$transport = otlp_stream_transport('/var/log/otel/logs.jsonl');

// Stream wrapper destinations for FaaS / Kubernetes log scraping
$transport = otlp_stream_transport('php://stdout');
$transport = otlp_stream_transport('php://stderr');

// Tweak file mode and disable directory creation
$transport = otlp_stream_transport(
    destination: '/var/log/otel/logs.jsonl',
    filePermissions: 0o640,
    createDirectories: false,
);

filePermissions and createDirectories apply only when the destination is a file path; they are ignored for php:// URIs. For production deployments.

One transport instance writes to one destination. To split logs, metrics, and traces across multiple files, build three transports and wire them to three exporters. To keep all signals in one file (the OpenTelemetry Collector handles mixed JSONL just fine), reuse the same destination across exporters.

#Wire Encoding

The OTLP spec defines fixed encodings per transport. The bridge enforces them.

For curl, pass otlp_json_serializer() (default) or otlp_protobuf_serializer():

<?php

use function Flow\Bridge\Telemetry\OTLP\DSL\{otlp_curl_transport, otlp_json_serializer, otlp_protobuf_serializer};

// JSON over HTTP — default; great for development and debugging
$transport = otlp_curl_transport('http://localhost:4318');

// Protobuf over HTTP — smaller payloads; recommended for production
$transport = otlp_curl_transport('http://localhost:4318', otlp_protobuf_serializer());

The Protobuf serializer requires the google/protobuf package.

#Timeouts

Both the curl and gRPC transports default to aggressive, local-collector-friendly timeouts: the production recommendation is to run an OpenTelemetry Collector close to the application (loopback, UDS, or sidecar), so the roundtrip is sub-millisecond and a stuck collector should not freeze your PHP process at shutdown.

timeout_ms is the per-request deadline. shutdown_timeout_ms is a separate wall-clock budget enforced only when draining pending requests during shutdown() — it lets you keep timeout_ms tight without freezing graceful exit under load. Pending requests still in flight after the shutdown deadline are abandoned and reported as failed (via the failover transport if configured, otherwise via the shutdown TransportException).

Tune the defaults up only when you have a remote collector. For a collector across regions or a managed SaaS endpoint, 5000–10000 ms for both timeouts is reasonable.

<?php

use function Flow\Bridge\Telemetry\OTLP\DSL\{otlp_curl_options, otlp_curl_transport, otlp_grpc_transport};

// Local collector — defaults are usually fine
$curl = otlp_curl_transport('http://localhost:4318');
$grpc = otlp_grpc_transport('localhost:4317');

// Remote collector — raise both to suit your network
$remoteCurl = otlp_curl_transport(
    endpoint: 'https://otlp.example.com:4318',
    options: otlp_curl_options()
        ->withTimeout(5000)
        ->withConnectTimeout(1000),
);

$remoteGrpc = otlp_grpc_transport(
    endpoint: 'otlp.example.com:4317',
    insecure: false,
    timeoutMs: 5000,
);

Why milliseconds: telemetry exports to a local collector complete in microseconds; the second-granularity API in earlier versions could not express tight, realistic deadlines. A negative value to withTimeout() / withConnectTimeout() raises \InvalidArgumentException.

#Failover Transport

Both CurlTransport and GrpcTransport accept an optional Transport $failover argument. When set, batches that failed on the primary are forwarded to the failover transport so telemetry is preserved even when the primary backend is unreachable. A typical pairing is gRPC primary → Stream (JSONL on disk) failover so a downed collector still leaves recoverable data the operator can replay later.

#How it works

The transport defers error handling to the next send() or shutdown(). When the next call drains the prior in-flight request:

1. Primary OK — the batch is dropped from the pending list. Nothing else happens.
2. Primary failed, failover accepted — the prior batch is forwarded to failover->send(); data preserved. The transport still raises a FailoverTransportException so the operator is informed primary is degraded.
3. Primary failed, failover also failed — the prior batch is lost. The exception carries both throwables in the failures list.

In every case the current request is dispatched to the primary before the exception is raised, so the new batch is never lost due to a prior failure.

On shutdown(), the primary drains pending requests, applies the same forwarding logic, then calls failover->shutdown() (cascade). The failover lifecycle is owned by the primary — you do not need to shut it down separately.

#Behavior matrix

FailoverTransportException extends TransportException, so existing catch (TransportException $e) blocks in exporters keep working. The structured $exception->failures list is available when you want per-batch detail:

foreach ($exception->failures as $failure) {
    $failure['primary'];   // \Throwable — the primary error
    $failure['failover'];  // \Throwable|null — null means failover absorbed the batch
}

#Examples

<?php

use function Flow\Bridge\Telemetry\OTLP\DSL\{otlp_curl_transport, otlp_grpc_transport, otlp_protobuf_serializer, otlp_stream_transport};

// gRPC primary → JSONL on disk failover (recommended for production)
$transport = otlp_grpc_transport(
    endpoint: 'localhost:4317',
    failover: otlp_stream_transport('/var/log/otel/failed.jsonl'),
);

// Curl primary → Stream (php://stderr) failover for FaaS / Kubernetes log scraping
$transport = otlp_curl_transport(
    endpoint: 'http://localhost:4318',
    serializer: otlp_protobuf_serializer(),
    failover: otlp_stream_transport('php://stderr'),
);

#Edge case: blocking on shutdown

The drain logic uses each backend's native non-blocking primitive where it exists. gRPC's UnaryCall::wait() is blocking by design — when the second flush arrives before the prior call resolved, it waits for resolution before forwarding to failover. This is mitigated by the per-call timeoutMs deadline; configure it tight enough that a stuck collector cannot hang shutdown indefinitely. See Timeouts.

#Caveats

• The failover is single-level: a failover transport cannot itself declare another failover. Compose multiple primaries instead if you need cascading destinations.
• Forwarding to the failover happens on the next flush, not at the moment of failure. A single batch lost between the first send and process exit is surfaced from shutdown().
• The failover transport receives the original Signals instance — it sees the same content the primary did.

#Complete Setup

Here's a complete example showing how to set up telemetry with OTLP export.

#Production Setup with Curl Transport

<?php

use function Flow\Telemetry\DSL\{
    telemetry,
    resource,
    tracer_provider,
    meter_provider,
    logger_provider,
    batching_span_processor,
    batching_metric_processor,
    batching_log_processor,
};
use function Flow\Bridge\Telemetry\OTLP\DSL\{
    otlp_curl_transport,
    otlp_curl_options,
    otlp_json_serializer,
    otlp_exporter,
};

$resource = resource([
    'service.name' => 'order-service',
    'service.version' => '1.2.0',
    'deployment.environment' => 'production',
]);

$options = otlp_curl_options()
    ->withTimeout(2000)
    ->withCompression();

$transport = otlp_curl_transport(
    endpoint: 'http://otel-collector:4318',
    serializer: otlp_json_serializer(),
    options: $options,
);

$exporter = otlp_exporter($transport);

$telemetry = telemetry(
    $resource,
    tracer_provider(batching_span_processor($exporter)),
    meter_provider(batching_metric_processor($exporter)),
    logger_provider(batching_log_processor($exporter)),
);

// Register shutdown handler for graceful termination
$telemetry->registerShutdownFunction();

// Use telemetry
$tracer = $telemetry->tracer('http-handler');
$span = $tracer->span('handle-request');
$span->setAttribute('http.method', 'POST');
$span->setAttribute('http.url', '/api/orders');
$tracer->complete($span);

#Setup with Grafana Cloud

<?php

use function Flow\Telemetry\DSL\{
    telemetry,
    resource,
    tracer_provider,
    batching_span_processor,
};
use function Flow\Bridge\Telemetry\OTLP\DSL\{
    otlp_curl_transport,
    otlp_curl_options,
    otlp_protobuf_serializer,
    otlp_exporter,
};

$transport = otlp_curl_transport(
    endpoint: 'https://otlp-gateway-prod-eu-west-0.grafana.net/otlp',
    serializer: otlp_protobuf_serializer(),
    options: otlp_curl_options()
        ->withHeader('Authorization', 'Basic ' . base64_encode('instance-id:api-key')),
);

$telemetry = telemetry(
    resource(['service.name' => 'my-app']),
    tracer_provider(batching_span_processor(otlp_exporter($transport))),
);

#Setup with Honeycomb

<?php

use function Flow\Telemetry\DSL\{
    telemetry,
    resource,
    tracer_provider,
    batching_span_processor,
};
use function Flow\Bridge\Telemetry\OTLP\DSL\{
    otlp_curl_transport,
    otlp_curl_options,
    otlp_protobuf_serializer,
    otlp_exporter,
};

$transport = otlp_curl_transport(
    endpoint: 'https://api.honeycomb.io',
    serializer: otlp_protobuf_serializer(),
    options: otlp_curl_options()
        ->withHeader('x-honeycomb-team', 'your-api-key'),
);

$telemetry = telemetry(
    resource(['service.name' => 'my-app']),
    tracer_provider(batching_span_processor(otlp_exporter($transport))),
);

#OpenTelemetry Collector

The recommended production architecture is to deploy an OpenTelemetry Collector close to your application (same network, Kubernetes cluster, or sidecar container). This approach provides several benefits:

• Decouple application from backends - Your application sends telemetry to a single local endpoint, unaware of the final destinations
• Change APM backends without code changes - Switch from Jaeger to Grafana or add Datadog by updating collector configuration only
• Fan-out to multiple backends - Send the same telemetry data to multiple APM systems simultaneously
• Offload processing - Batching, retry logic, filtering, and sampling happen in the collector, not your application
• Reduce network latency - Local collector accepts data quickly; it handles slow or unreliable external connections

#Sample Collector Configuration

# otel-collector-config.yaml
receivers:
  otlp:
    protocols:
      grpc:
        endpoint: 0.0.0.0:4317
      http:
        endpoint: 0.0.0.0:4318

processors:
  batch:
    timeout: 5s
    send_batch_size: 512

exporters:
  # Local Jaeger for development
  otlp/jaeger:
    endpoint: jaeger:4317
    tls:
      insecure: true

  # Grafana Cloud
  otlp/grafana:
    endpoint: otlp-gateway-prod-eu-west-0.grafana.net:443
    headers:
      Authorization: Basic ${GRAFANA_AUTH}

  # Honeycomb
  otlp/honeycomb:
    endpoint: api.honeycomb.io:443
    headers:
      x-honeycomb-team: ${HONEYCOMB_API_KEY}

service:
  pipelines:
    traces:
      receivers: [otlp]
      processors: [batch]
      exporters: [otlp/jaeger, otlp/grafana, otlp/honeycomb]
    metrics:
      receivers: [otlp]
      processors: [batch]
      exporters: [otlp/grafana]
    logs:
      receivers: [otlp]
      processors: [batch]
      exporters: [otlp/grafana]

#Docker Compose Example

# compose.yaml
services:
  otel-collector:
    image: otel/opentelemetry-collector-contrib:latest
    command: ["--config=/etc/otel-collector-config.yaml"]
    volumes:
      - ./otel-collector-config.yaml:/etc/otel-collector-config.yaml
    ports:
      - "4317:4317"  # gRPC
      - "4318:4318"  # HTTP
    environment:
      - GRAFANA_AUTH=${GRAFANA_AUTH}
      - HONEYCOMB_API_KEY=${HONEYCOMB_API_KEY}

  app:
    build: .
    environment:
      - OTEL_EXPORTER_OTLP_ENDPOINT=http://otel-collector:4318
    depends_on:
      - otel-collector

With this setup, your PHP application only needs to know about http://otel-collector:4318. Adding or removing APM backends becomes a configuration change in the collector, requiring no application redeployment.

#Configuration Options

The CurlTransportOptions class provides a fluent interface for configuring the curl transport.

See Timeouts for guidance on the default values.

Example:

<?php

use function Flow\Bridge\Telemetry\OTLP\DSL\otlp_curl_options;

$options = otlp_curl_options()
    ->withTimeout(2000)
    ->withConnectTimeout(500)
    ->withHeader('Authorization', 'Bearer token')
    ->withHeader('X-Custom-Header', 'value')
    ->withCompression()
    ->withSslVerification(verifyPeer: true, verifyHost: true)
    ->withProxy('http://proxy:8080');

#OTLP Endpoints

Standard OTLP endpoint paths:

The transport automatically appends the correct path based on the signal type. You only need to provide the base endpoint URL.

HTTP endpoints:

• OpenTelemetry Collector: http://localhost:4318
• Grafana Cloud: https://otlp-gateway-prod-{region}.grafana.net/otlp
• Honeycomb: https://api.honeycomb.io

gRPC endpoints:

• OpenTelemetry Collector: localhost:4317
• Jaeger: localhost:4317

Found a typo or an outdated section? Edit this page on GitHub ↗