Spatie Flare Client PHP

https://github.com/spatie/flare-client-php
Admin
This PHP client sends errors and exceptions to Flare, providing robust error reporting for PHP 8.2...
Tokens:69,321
Snippets:831
Trust Score:10
License:MIT
Update:4 months ago
Show doc for...
Tokens:
Raw
### start

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare.md

Starts tracing for the main request/job lifecycle. This method creates the root application span and initializes the sampling decision.

```APIDOC
## start

### Description
Starts tracing for the main request/job lifecycle. Creates the root application span and initializes sampling decision.

### Method
`public function start(?int $timeUnixNano = null, array $attributes = [], ?string $traceparent = null): self`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **timeUnixNano** (int|null) - Optional - Start time in nanoseconds. Defaults to current time.
- **attributes** (array) - Optional - Initial attributes for root span. Defaults to an empty array.
- **traceparent** (string|null) - Optional - W3C trace context header for distributed tracing. Defaults to null.

### Request Example
```php
$flare->start();

// With custom timestamp and W3C traceparent
$flare->start(
    timeUnixNano: 1000000000000,
    attributes: ['environment' => 'production'],
    traceparent: '00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01'
);
```

### Response
#### Success Response
- **self** - Returns `$this` for method chaining.

#### Response Example
```php
// Example of method chaining
$flare->start()->someOtherMethod();
```

### Throws
- `Exception` if called while using subtask mode (via `lifecycle->startSubtask()`)
```

--------------------------------

### Example: Report Errors and Warnings

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare-config.md

This example demonstrates how to configure the client to only report errors and warnings by using a bitmask with `E_ERROR`, `E_USER_ERROR`, and `E_WARNING`.

```php
// Only report errors and warnings
$config->reportErrorLevels(E_ERROR | E_USER_ERROR | E_WARNING);
```

--------------------------------

### Complete Report Factory Example

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/report-factory.md

A comprehensive example demonstrating the creation and configuration of a report using the Report Factory, including exception handling, adding attributes, context, tags, and tracking.

```php
try {
    $payment = $paymentService->charge($user, 99.99);
} catch (PaymentException $e) {
    $report = $flare->reporter->createReport($e)
        // Core exception details
        ->throwable($e)
        ->message('Failed to charge payment')
        ->handled()
        
        // Context
        ->addAttributes([
            'user_id' => $user->id,
            'user_email' => $user->email,
            'amount' => 99.99,
            'currency' => 'USD',
            'payment_method' => 'credit_card',
            'order_id' => 'ord-' . $user->id,
        ])
        
        // Trace data
        ->span(...$flare->tracer->currentTrace())
        
        // Categorization
        ->addTags(['payment', 'critical', 'customer-facing'])
        
        // Tracking
        ->trackingUuid($flare->ids->uuid());
    
    // Send
    $flare->api->report($report);
    
    // Notify user
    notify($user)->payment_failed($report->trackingUuid);
}
```

--------------------------------

### Flare Instance Creation Example

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare.md

Demonstrates how to create a Flare instance using the `make` factory method. Examples show initialization with a raw API token string and with a configured `FlareConfig` object, including setting application details.

```php
// Using API token string
$flare = Flare::make('your-flare-api-token');

// Using FlareConfig
$config = FlareConfig::make('token')
    ->useDefaults()
    ->applicationName('My App')
    ->applicationVersion('1.0.0');
$flare = Flare::make($config);
```

--------------------------------

### Starting Flare Client Lifecycle

Source: https://github.com/spatie/flare-client-php/blob/main/UPGRADING.md

Replace registerFlareHandlers() with $flare->start() for framework-agnostic applications when upgrading from v3.0 to v3.1. This method also opens the lifecycle.

```php
$flare = Flare::make($config)->start();
```

--------------------------------

### Start Flare Lifecycle

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare.md

Initiates the main request or job tracing. Use this at the beginning of your script or job. It can accept a custom start time and W3C trace context header for distributed tracing.

```php
$flare->start();
```

```php
$flare->start(
    timeUnixNano: 1000000000000,
    attributes: ['environment' => 'production'],
    traceparent: '00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01'
);
```

--------------------------------

### Initialize and Start Reporting

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/README.md

Initializes the Flare client with an API token and registers handlers for uncaught exceptions and errors. It then starts tracing for the current request or job and ends the lifecycle to flush pending data.

```php
use Spatie\FlareClient\Flare;

// Create Flare instance with API token
$flare = Flare::make('your-flare-api-token');

// Register automatic handlers for uncaught exceptions and errors
$flare->registerFlareHandlers();

// Start tracing for this request/job
$flare->start();

// ... application code ...

// End lifecycle and flush all pending data
$flare->end();
```

--------------------------------

### startTrace

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/tracer.md

Starts a new trace or returns an existing trace ID if already started. It evaluates the sampling decision based on the parent context.

```APIDOC
## startTrace

### Description
Starts a new trace or returns an existing trace ID if already started. Evaluates sampling decision based on parent context.

### Method
`startTrace`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **traceId** (string|null) - Optional - Trace ID (both traceId and spanId required together)
- **spanId** (string|null) - Optional - Parent span ID
- **traceParent** (string|null) - Optional - W3C traceparent header for distributed tracing

### Returns
`bool` — true if sampling is enabled, false otherwise

### Throws
`Exception` if only one of traceId/spanId is provided

### Example
```php
// Auto-generate IDs and sample
$flare->tracer->startTrace();

// With W3C traceparent from incoming request
$flare->tracer->startTrace(traceParent: $_SERVER['HTTP_TRACEPARENT'] ?? null);

// With explicit trace context
$flare->tracer->startTrace(traceId: 'abc123', spanId: 'def456');
```
```

--------------------------------

### FlareConfig::make()

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/README.md

Creates a new Flare configuration instance. This is the starting point for customizing Flare's behavior.

```APIDOC
## FlareConfig::make()

### Description
Creates a new Flare configuration instance.

### Method
(Not specified, likely a static method)

### Endpoint
(Not applicable, SDK method)

### Parameters
(Parameters not specified in the source text)

### Request Example
(Example not specified in the source text)

### Response
(Response details not specified in the source text)
```

--------------------------------

### Start a New Trace with Auto-Generated IDs

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/tracer.md

Use this snippet to start a new trace when no existing trace context is available. IDs are automatically generated, and the sampling decision is evaluated.

```php
$flare->tracer->startTrace();
```

--------------------------------

### Start Trace with Explicit Trace Context

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/tracer.md

Manually start a trace by providing explicit trace and span IDs. This is useful for scenarios where you need precise control over trace identification.

```php
$flare->tracer->startTrace(traceId: 'abc123', spanId: 'def456');
```

--------------------------------

### Complete Flare Client PHP Configuration

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/configuration.md

This example demonstrates a comprehensive configuration of the Flare Client PHP. It covers setting up application metadata, controlling error reporting levels, enabling tracing, configuring data collection for requests, queries, commands, and more, as well as privacy settings and custom resource/span configurations.

```php
use Monolog\Level;
use Spatie\FlareClient\FlareConfig;

$config = FlareConfig::make('your-flare-api-token')
    ->useDefaults()
    
    // Application metadata
    ->applicationName('MyApplication')
    ->applicationVersion('1.0.0')
    ->applicationStage('production')
    ->applicationPath('/var/www/myapp')
    
    // Reporting control
    ->report(true)
    ->reportErrorLevels(E_ERROR | E_USER_ERROR | E_WARNING)
    ->filterExceptionsUsing(function (Exception $e) {
        return !($e instanceof \ModelNotFoundException);
    })
    
    // Tracing
    ->trace(true, maxSpans: 2048)
    ->sampleRate(0.5)  // Sample 50% of requests
    
    // Logging
    ->log(true, Level::Warning)
    
    // Data collection
    ->collectRequests(
        ignoredRoutes: ['health-check'],
        ignoredUrls: ['/webhook']
    )
    ->collectQueries(
        includeBindings: true,
        findOrigin: true
    )
    ->collectCommands()
    ->collectCacheEvents()
    ->collectExternalHttp()
    ->ignoreRedisCommands()  // Disable Redis tracking
    
    // Privacy
    ->censorClientIps(true)
    ->censorCookies(true)
    ->censorHeaders('Authorization', 'X-API-Key')
    ->censorBodyFields('password', 'credit_card')
    
    // Customization
    ->configureResource(function ($resource) {
        $resource->addAttribute('environment_type', 'cloud');
    })
    ->configureSpans(function ($span) {
        if (strpos($span->name, 'cache') !== false) {
            $span->addAttribute('performance_critical', true);
        }
    })
    ->overrideGrouping(
        MyCustomException::class,
        OverriddenGrouping::Message
    );

$flare = Flare::make($config);
```

--------------------------------

### Start and Send Trace with Traceparent

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/README.md

Accepts traceparent from an incoming request and sends traceparent to downstream services. Ensure the TRACEPARENT header is available in the server environment.

```php
// Accept traceparent from incoming request
$flare->tracer->startTrace(
    traceParent: $_SERVER['HTTP_TRACEPARENT'] ?? null
);

// Send traceparent to downstream services
$header = $flare->tracer->traceParent();
$client->request('GET', '/api/users', [
    'headers' => ['Traceparent' => $header]
]);
```

--------------------------------

### Start Trace with W3C Traceparent Header

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/tracer.md

Initiate a trace using the W3C traceparent header from an incoming request. This is crucial for distributed tracing to maintain context across services.

```php
$flare->tracer->startTrace(traceParent: $_SERVER['HTTP_TRACEPARENT'] ?? null);
```

--------------------------------

### PHP Tracer Exception: Starting Span Without Active Trace

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/errors.md

This exception is thrown when `startSpan()` is called when no trace is active. A trace must be started before any spans can be initiated.

```php
$tracer->startSpan('operation'); // When no trace - Throws Exception
```

--------------------------------

### new

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/report-factory.md

Creates a fresh instance of the ReportFactory, preserving configuration but clearing all previously added data. This is useful for starting a new report build process.

```APIDOC
## new

### Description
Create a fresh report factory instance, clearing all previous data but keeping configuration.

### Method
`new`

### Returns
`ReportFactory` — Fresh instance with same configuration

### Example
```php
$factory = $reportFactory
    ->new()
    ->throwable($exception);
```
```

--------------------------------

### Create New ReportFactory Instance

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/report-factory.md

Creates a fresh instance of the ReportFactory, preserving the configuration but clearing previous data. Useful for starting a new report.

```php
$factory = $reportFactory
    ->new()
    ->throwable($exception);
```

--------------------------------

### Configuring Flare Client with Daemon Sender

Source: https://github.com/spatie/flare-client-php/blob/main/UPGRADING.md

Enable standalone logging and configure the Flare client to send logs, errors, and traces through the Flare daemon. This setup uses Monolog's Level enum for minimal log level and falls back to direct curl delivery if the daemon is unreachable.

```php
use Monolog\Level;
use Spatie\FlareClient\FlareConfig;
use Spatie\FlareClient\Senders\DaemonSender;

FlareConfig::make('your-api-key')
    ->log(minimalLevel: Level::Info)
    ->sendUsing(DaemonSender::class);
```

--------------------------------

### PHP Exception Handling for API Reports

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/api.md

Example of how to catch specific exceptions when reporting to Flare in test mode. This helps in debugging configuration issues.

```php
try {
    $flare->api->report($report, immediately: true, test: true);
} catch (InvalidData $e) {
    echo "Payload validation failed: " . $e->getMessage();
} catch (NotFound $e) {
    echo "Invalid API token";
} catch (BadResponseCode $e) {
    echo "Server error: " . $e->getMessage();
}
```

--------------------------------

### log

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare-config.md

Enable logging and set the minimum severity level for log messages. This method allows for fine-grained control over what gets logged.

```APIDOC
## log

### Description
Enable logging and set minimum severity level.

### Method
```php
public function log(bool $log = true, ?Level $minimalLevel = null): static
```

### Parameters
#### Method Parameters
- **log** (bool) - Optional - Enable logging. Defaults to true.
- **minimalLevel** (Level|null) - Optional - Minimum Monolog level. Defaults to null.

### Returns
`$this` for method chaining.

### Example
```php
use Monolog\Level;

$config->log(log: true, minimalLevel: Level::Warning);
```
```

--------------------------------

### Send Error Report Example

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/api.md

Sends an exception or error report to Flare. By default, reports are queued for batch sending. Use the `immediately` parameter to send instantly.

```php
$report = $flare->reporter->createReport($exception);
$report->addAttributes(['user_id' => 123]);

$payload = $flare->api->report($report);
echo "Sent report with " . count($payload['errors']) . " errors";
```

--------------------------------

### Create Distributed Traces

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/README.md

Enables the creation of distributed traces by starting a trace, creating spans for operations with optional attributes and events, and ending the trace to send the data.

```php
// Start tracing (usually at HTTP request or job start)
$flare->tracer->startTrace();

// Create spans for operations
$result = $flare->tracer->span(
    name: 'database.query',
    callback: fn() => DB::select('SELECT * FROM users'),
    attributes: ['db.system' => 'mysql'],
    endAttributes: fn($rows) => ['row_count' => count($rows)]
);

// Add events within spans
$flare->tracer->spanEvent('cache.hit', ['key' => 'user:123']);

// End tracing and send spans
$flare->tracer->endTrace();
```

--------------------------------

### Collect Server Information

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare-config.md

Enable the collection of server details, including host, OS, PHP version, Composer information, and installed packages. Specific entity types can be enabled or disabled.

```php
public function collectServerInfo(
    bool|array|FlareEntityType $host = Resource::DEFAULT_HOST_ENTITY_TYPES,
    bool|array|FlareEntityType $os = Resource::DEFAULT_OS_ENTITY_TYPES,
    bool|array|FlareEntityType $php = Resource::DEFAULT_PHP_ENTITY_TYPES,
    bool|array|FlareEntityType $composer = false,
    bool|array|FlareEntityType $composerPackages = Resource::DEFAULT_COMPOSER_PACKAGES_ENTITY_TYPES,
    array $extra = []
): static
```

--------------------------------

### collectServerInfo

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare-config.md

Collect server information (host, OS, PHP version, installed packages). Allows configuration of which server details to collect. Returns the current instance for method chaining.

```APIDOC
## collectServerInfo

### Description
Collect server information (host, OS, PHP version, installed packages).

### Method
`public function collectServerInfo(
    bool|array|FlareEntityType $host = Resource::DEFAULT_HOST_ENTITY_TYPES,
    bool|array|FlareEntityType $os = Resource::DEFAULT_OS_ENTITY_TYPES,
    bool|array|FlareEntityType $php = Resource::DEFAULT_PHP_ENTITY_TYPES,
    bool|array|FlareEntityType $composer = false,
    bool|array|FlareEntityType $composerPackages = Resource::DEFAULT_COMPOSER_PACKAGES_ENTITY_TYPES,
    array $extra = []
): static

### Parameters
#### Query Parameters
- **host** (bool|array|FlareEntityType) - Optional - Configuration for collecting host information.
- **os** (bool|array|FlareEntityType) - Optional - Configuration for collecting OS information.
- **php** (bool|array|FlareEntityType) - Optional - Configuration for collecting PHP version information.
- **composer** (bool|array|FlareEntityType) - Optional - Configuration for collecting Composer information. Defaults to `false`.
- **composerPackages** (bool|array|FlareEntityType) - Optional - Configuration for collecting Composer packages information.
- **extra** (array) - Optional - Additional options for server info collection.

### Returns
`static` - The current instance for method chaining.
```

--------------------------------

### Flare::start()

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/README.md

Begins the tracing lifecycle for the Flare client. Used to initiate the tracking of operations.

```APIDOC
## Flare::start()

### Description
Begins the tracing lifecycle for the Flare client.

### Method
(Not specified, likely an instance method)

### Endpoint
(Not applicable, SDK method)

### Parameters
(Parameters not specified in the source text)

### Request Example
(Example not specified in the source text)

### Response
(Response details not specified in the source text)
```

--------------------------------

### Create FlareConfig Instance with API Token

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare-config.md

Use the `make` factory method to create a new configuration instance, providing your Flare API token. This is the recommended way to initialize the configuration.

```php
public static function make(string $apiToken): static

$config = FlareConfig::make('your-flare-api-token');
```

--------------------------------

### PHP Exception Handling for Tracer Initialization

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/errors.md

Demonstrates how to catch and handle generic `Exception` errors during trace initialization using a try-catch block.

```php
use Exception;

try {
    if (!$tracer->currentTraceId()) {
        $tracer->startTrace();
    }
    $span = $tracer->startSpan('operation');
} catch (Exception $e) {
    // Handle trace initialization error
    echo "Trace error: " . $e->getMessage();
}
```

--------------------------------

### Start a new span

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/tracer.md

Starts a new span with a given name and optional attributes. Returns `AddSpanResult::LimitReached` if the span limit is exceeded. Throws an exception if no active trace is present.

```php
$span = $flare->tracer->startSpan('database.query', attributes: [
    'db.system' => 'mysql',
    'db.statement' => 'SELECT * FROM users',
]);

if ($span instanceof Span) {
    // Use span
}
```

--------------------------------

### Flare::make()

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/README.md

Creates a new instance of the Flare client. This is the primary entry point for initializing the library.

```APIDOC
## Flare::make()

### Description
Creates a new instance of the Flare client.

### Method
(Not specified, likely a static method or constructor)

### Endpoint
(Not applicable, SDK method)

### Parameters
(Parameters not specified in the source text)

### Request Example
(Example not specified in the source text)

### Response
(Response details not specified in the source text)
```

--------------------------------

### Update CommandRecorder::recordStart() for Attribute Providers

Source: https://github.com/spatie/flare-client-php/blob/main/UPGRADING.md

In v3, `CommandRecorder::recordStart()` uses attribute providers instead of direct arguments for command, arguments, and entry point class. Helper methods are available to streamline the process.

```php
// Before
$flare->command()->recordStart(
    command: 'app:sync',
    arguments: $input,
    entryPointClass: SyncCommand::class,
);

// After
$flare->command()->recordStart(
    new SymfonyInputCommandAttributesProvider($input, 'app:sync', SyncCommand::class),
);

// Or use the helpers:
$flare->command()->recordStartFromSymfonyInput('app:sync', $input, SyncCommand::class);
$flare->command()->recordStartFromCli('app:sync', SyncCommand::class);
$flare->command()->recordStartFromDefined('app:sync', $arguments, SyncCommand::class);
```

--------------------------------

### Configure Flare Client with Environment Variables

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/configuration.md

Instantiate FlareConfig using environment variables for API token, application stage, and version. Defaults are provided for stage and version if not set.

```php
$config = FlareConfig::make(env('FLARE_API_TOKEN'))
    ->applicationStage(env('APP_ENV', 'development'))
    ->applicationVersion(env('APP_VERSION', '0.0.1'));
```

--------------------------------

### Running Project Commands

Source: https://github.com/spatie/flare-client-php/blob/main/CLAUDE.MD

Common commands for testing, static analysis, and code formatting using Composer.

```bash
composer test          # Pest tests
composer analyse       # PHPStan level 8
composer format        # php-cs-fixer (with --allow-risky=yes)
```

--------------------------------

### Get Current Trace ID

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/tracer.md

Retrieves the current trace ID. Returns null if the trace is not being sampled.

```php
public function currentTraceId(): ?string
```

--------------------------------

### filterExceptionsUsing

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/reporter.md

Sets a callback function to filter which exceptions get reported. This replaces any previously set filter.

```APIDOC
## filterExceptionsUsing

### Description
Set callback to filter which exceptions get reported. Replaces any previously set filter.

### Method
```php
public function filterExceptionsUsing(Closure $filterExceptionsCallable): static
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### filterExceptionsCallable
- **filterExceptionsCallable** (Closure(Exception):bool) - Required - Return true to report, false to skip

### Returns
`$this` for method chaining

### Example
```php
$flare->reporter->filterExceptionsUsing(function (Exception $e) {
    // Don't report 404s
    if ($e instanceof ModelNotFoundException) {
        return false;
    }
    
    // Don't report validation errors
    if ($e instanceof ValidationException) {
        return false;
    }
    
    return true;
});
```
```

--------------------------------

### Configure Application Metadata

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/configuration.md

Set application name, version, stage, and path for reporting to Flare. Ensure the API token is provided during initialization.

```php
$config = FlareConfig::make('token')
    ->applicationName('MyApp')
    ->applicationVersion('1.2.3')
    ->applicationStage('production')
    ->applicationPath('/var/www/myapp');
```

--------------------------------

### Run Tests with Composer

Source: https://github.com/spatie/flare-client-php/blob/main/README.md

Execute the test suite for the Flare Client PHP package using Composer.

```bash
composer test
```

--------------------------------

### Get Current Span ID

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/tracer.md

Retrieves the current active span ID. Returns null if no span is active.

```php
public function currentSpanId(): ?string
```

--------------------------------

### Filter Exceptions by Type

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/errors.md

Use this closure to prevent specific exception types from being reported. For example, exclude ModelNotFoundException and ValidationException.

```php
$flare->filterExceptionsUsing(function (Exception $e) {
    // Don't report 404s
    if ($e instanceof ModelNotFoundException) {
        return false;
    }
    
    // Don't report validation errors
    if ($e instanceof ValidationException) {
        return false;
    }
    
    return true; // Report everything else
});
```

--------------------------------

### Get Default Argument Reducers

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare-config.md

Retrieve the default list of reducer classes used for processing stack frame arguments.

```php
public static function defaultArgumentReducers(): array
```

--------------------------------

### Replace application() reset with lifecycle reset

Source: https://github.com/spatie/flare-client-php/blob/main/UPGRADING.md

The `ApplicationRecorder` has been removed. Reset and flush behavior is now managed by `Lifecycle`. Use `$flare->lifecycle->reset()` instead of `$flare->application()->reset()`.

```php
// Before
$flare->application()->reset();

// After
$flare->lifecycle->reset();
```

--------------------------------

### Get All Recorded Logs

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/logger.md

Retrieves all log records stored in the current session. Useful for inspecting or processing logs before they are flushed.

```php
$allLogs = $flare->log()->logs();
echo count($allLogs) . " logs recorded";

foreach ($allLogs as $log) {
    echo $log['body'] . " (" . $log['severityText'] . ")\n";
}
```

--------------------------------

### Update RequestRecorder::recordStart() for Attribute Providers

Source: https://github.com/spatie/flare-client-php/blob/main/UPGRADING.md

Before v3, `RequestRecorder::recordStart()` accepted direct arguments like request, route, and entryPointClass. In v3, it now requires an `RequestAttributesProvider`. Helper methods are available to simplify provider creation.

```php
// Before
$flare->request()->recordStart(
    request: $request,
    route: '/users/{id}',
    entryPointClass: UserController::class,
);

// After
$flare->request()->recordStart(
    new SymfonyRequestAttributesProvider($redactor, $request),
);

// Or use the helper that builds the provider for you:
$flare->request()->recordStartFromSymfonyRequest($request);
```

--------------------------------

### startSpan

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/tracer.md

Starts a new span. This span will be a child of the current parent span. If the span limit is reached, it returns `AddSpanResult::LimitReached`.

```APIDOC
## startSpan

### Description
Start a new span under the current parent. Returns `AddSpanResult::LimitReached` if span limit exceeded.

### Method
POST (assumed)

### Endpoint
/tracer/startSpan (assumed)

### Parameters
#### Request Body
- **name** (string) - Required - Span name/operation
- **time** (int|null) - Optional - Current time - Start time in nanos
- **attributes** (array) - Optional - [] - Initial attributes

### Request Example
```json
{
  "name": "database.query",
  "attributes": {
    "db.system": "mysql",
    "db.statement": "SELECT * FROM users"
  }
}
```

### Returns
Span|AddSpanResult — Span or limit reached result

### Throws
Exception — if no active trace
```

--------------------------------

### make

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare.md

Creates and initializes a Flare instance. This factory method automatically registers handlers and configures defaults.

```APIDOC
## make

### Description
Create and initialize a Flare instance. Automatically registers handlers and configures defaults.

### Method
`make`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **apiToken** (string|FlareConfig) - Required - Flare API token or FlareConfig instance

### Returns
`self` - Initialized Flare instance ready to use

### Throws
None (exceptions during provider setup are not caught)

### Example
```php
// Using API token string
$flare = Flare::make('your-flare-api-token');

// Using FlareConfig
$config = FlareConfig::make('token')
    ->useDefaults()
    ->applicationName('My App')
    ->applicationVersion('1.0.0');
$flare = Flare::make($config);
```
```

--------------------------------

### Enable Logging with Minimum Level

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/configuration.md

Enable logging to Flare and specify the minimum Monolog level to record. Only logs at or above this level will be sent.

```php
use Monolog\Level;

$config->log(
    log: true,
    minimalLevel: Level::Warning
);
```

--------------------------------

### withApplicationStage

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare.md

Set the environment or stage for the application. This method allows you to specify the current stage, such as 'production' or 'staging', for reports sent to Flare. It accepts a string or a closure that returns a string.

```APIDOC
## withApplicationStage

### Description
Set the environment/stage (e.g., 'production', 'staging').

### Method
```php
public function withApplicationStage(string|Closure $stage): self
```

### Parameters
#### Path Parameters
- **stage** (string|Closure) - Required - Stage name or callable

### Response
- **self** - Returns `$this` for method chaining
```

--------------------------------

### Recommended Production Settings for Flare Client

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/configuration.md

Configure Flare Client for production with default settings, 10% sampling, and censoring of IPs, cookies, and sessions.

```php
FlareConfig::make($token)
    ->useDefaults()
    ->applicationStage('production')
    ->sampleRate(0.1)  // 10% sampling
    ->censorClientIps(true)
    ->censorCookies(true)
    ->censorSession(true)
```

--------------------------------

### Handle BadResponseCode Exception

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/errors.md

Catch BadResponseCode to handle unexpected HTTP status codes from the Flare API. This example shows basic error message display.

```php
try {
    $flare->report($exception);
} catch (BadResponseCode $e) {
    echo "Flare API error: " . $e->getMessage();
    // Handle server errors, rate limiting, etc.
}
```

--------------------------------

### Configure Flare API with Custom Implementation

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/api.md

Shows how to set a custom API implementation by assigning a class name to FlareConfig's api property.

```php
class CustomApi extends Api {
    public function report(/* ... */) {
        // Custom implementation
    }
}

$config->api = CustomApi::class;
```

--------------------------------

### Recommended Development Settings for Flare Client

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/configuration.md

Configure Flare Client for development, sampling all traces, logging debug information, and disabling IP censoring.

```php
FlareConfig::make($token)
    ->useDefaults()
    ->applicationStage('development')
    ->alwaysSampleTraces()  // Trace everything
    ->log(true, Level::Debug)  // Log everything
    ->censorClientIps(false)  // Don't censor in dev
```

--------------------------------

### Logs Endpoint Success Response

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/endpoints.md

Example of a successful response when log entries are processed by the /v1/logs endpoint. The response includes a data object with type and ID.

```http
HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": {
        "type": "logs",
        "id": "logs-123"
    }
}
```

--------------------------------

### span

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/tracer.md

Creates a span around a callback's execution. It automatically handles the start and end of the span, including setting the exception status if an error occurs during execution.

```APIDOC
## span

### Description
Create span around callback execution. Automatically handles start/end and exception status.

### Method
POST (assumed)

### Endpoint
/tracer/span (assumed)

### Parameters
#### Request Body
- **name** (string) - Required - Span name
- **callback** (Closure():T) - Required - Work to trace
- **attributes** (array) - Optional - [] - Initial attributes
- **endAttributes** (Closure(T):array|null) - Optional - null - Attributes from return value
- **startTime** (int|null) - Optional - null - Start time in nanos
- **endTime** (int|null) - Optional - null - End time in nanos
- **includeMemoryUsage** (bool) - Optional - false - Record peak memory

### Returns
Mixed — Return value from callback
```

--------------------------------

### __construct

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare.md

Initializes a Flare instance with all core components. This constructor is typically invoked via the `make()` factory method.

```APIDOC
## __construct

### Description
Initializes a Flare instance with all core components. Normally invoked via `make()` factory.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Method
`__construct`

### Parameters
- **lifecycle** (Lifecycle) - Required - Manages request/job lifecycle and spans
- **tracer** (Tracer) - Required - Handles distributed tracing spans
- **logger** (Logger) - Required - Sends logs to Flare
- **reporter** (Reporter) - Required - Reports exceptions and errors
- **backTracer** (BackTracer) - Required - Generates stack traces
- **ids** (Ids) - Required - Generates IDs for traces and spans
- **time** (Time) - Required - Provides current time in nanos
- **sentReports** (SentReports) - Required - Tracks sent reports for deduplication
- **resource** (Resource) - Optional - Service metadata (name, version)
- **scope** (Scope) - Optional - Scope for logging context
- **recorders** (Recorders) - Optional - Manages data recorders

### Request Example
None

### Response
#### Success Response
None

#### Response Example
None
```

--------------------------------

### Flare Factory Method `make`

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare.md

The static `make` method provides a convenient way to create and initialize a Flare instance. It automatically registers necessary handlers and configures default settings. This method accepts either a Flare API token as a string or a pre-configured `FlareConfig` object.

```php
public static function make(
    string|FlareConfig $apiToken
): self
```

--------------------------------

### Handle ConnectionError Exception

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/errors.md

Catch ConnectionError to handle network connectivity failures when trying to reach the Flare API. This example shows queuing reports for later retry.

```php
try {
    $flare->report($exception);
} catch (ConnectionError $e) {
    // Queue report locally, retry later
    $pendingReports[] = ['exception' => $exception, 'retryAt' => time() + 60];
}
```

--------------------------------

### API Client Constructor

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/api.md

Initializes the API client with endpoint and authentication details. Requires various dependencies for formatting, metadata, and transport.

```php
public function __construct(
    protected string $apiToken,
    protected string $baseUrl,
    protected Exporter $exporter,
    protected Resource $resource,
    protected Scope $scope,
    protected Sender $sender,
    protected bool $disableQueue
): void
```

--------------------------------

### defaultArgumentReducers

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare-config.md

Get default argument reducers for stack frame arguments. This helper method provides access to the default reducers used for processing stack frame arguments.

```APIDOC
## defaultArgumentReducers

### Description
Get default argument reducers for stack frame arguments.

### Method
```php
public static function defaultArgumentReducers(): array
```

### Returns
`array` - List of reducer classes
```

--------------------------------

### Use Default Flare Configuration

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare-config.md

Applies recommended default settings for error collection, censoring, and context. Returns the current instance for method chaining.

```php
$flare = Flare::make(
    FlareConfig::make('token')->useDefaults()
);
```

--------------------------------

### Report Specific Error Levels

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare-config.md

Filter which PHP error levels get reported by specifying a bitmask of E_* constants. This allows you to control the granularity of errors captured.

```php
public function reportErrorLevels(int $reportErrorLevels): static
```

--------------------------------

### Reporter Constructor

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/reporter.md

Initializes the reporter with configuration for handling and filtering exceptions. This is the primary entry point for setting up the Flare client's reporting capabilities.

```APIDOC
## Constructor Reporter

### Description
Initializes the reporter with configuration for handling and filtering exceptions.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Method Signature
```php
public function __construct(
    protected readonly Api $api,
    protected readonly bool $disabled,
    protected readonly Tracer $tracer,
    protected readonly Lifecycle $lifecycle,
    protected readonly SentReports $sentReports,
    protected readonly ?int $reportErrorLevels,
    protected null|Closure $filterExceptionsCallable,
    protected null|Closure $filterReportsCallable,
    protected readonly ReportFactory $reportFactory,
    protected readonly array $middleware,
    protected readonly Recorders $recorders,
    protected readonly bool $addReportsToTraces
): void
```

### Parameters Details
- **api** (Api) - Required - API client for sending reports
- **disabled** (bool) - Required - Disable all reporting
- **tracer** (Tracer) - Required - Distributed tracer
- **lifecycle** (Lifecycle) - Required - Lifecycle manager
- **sentReports** (SentReports) - Required - Sent report tracking
- **reportErrorLevels** (int|null) - Optional - Error levels to report (Default: null)
- **filterExceptionsCallable** (Closure|null) - Optional - Exception filter (Default: null)
- **filterReportsCallable** (Closure|null) - Optional - Report filter (Default: null)
- **reportFactory** (ReportFactory) - Required - Report builder
- **middleware** (array) - Required - Report middleware
- **recorders** (Recorders) - Required - Data recorders
- **addReportsToTraces** (bool) - Required - Add errors as span events
```

--------------------------------

### Configure DaemonSender

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/configuration.md

Configure the DaemonSender to use a separate daemon process for sending data. Specific configuration options for the daemon can be provided.

```php
$config->sendUsing(DaemonSender::class, [
    // Daemon-specific config
]);
```

--------------------------------

### Filter Exceptions Using Callback

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare.md

Set a callback to filter which exceptions get reported. The callback should return true to report and false to skip. Returns `$this` for method chaining.

```php
$flare->filterExceptionsUsing(function (Exception $e) {
    // Don't report specific exceptions
    if ($e instanceof ModelNotFoundException) {
        return false;
    }
    return true;
});
```

--------------------------------

### EntryPoint

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/types.md

Provides metadata about how the application was invoked, such as through HTTP, a command, or a job.

```APIDOC
## Class EntryPoint

### Description
Metadata about how the application was invoked (HTTP, command, job, etc.).

### Namespace
`Spatie\FlareClient\EntryPoint`

### Methods

#### `toAttributes(): array`
Converts the entry point information into attributes.
```

--------------------------------

### Define Application Invocation with EntryPoint

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/types.md

Contains metadata about how the application was invoked, such as HTTP requests, commands, or jobs. Use this to provide invocation context.

```php
class EntryPoint
{
    public ?string $type;
    public ?string $method;
    public ?string $path;
    public ?string $command;
    public ?string $jobName;
    
    public function toAttributes(): array;
}
```

--------------------------------

### Automatic Queue Flushing

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/errors.md

Errors are automatically queued and sent at the end of the application lifecycle. Use `start()` before your application code and `end()` in a `finally` block to ensure reports are flushed.

```php
// Errors are automatically queued and sent at lifecycle end
$flare->start();
try {
    // Application code
} finally {
    $flare->end();  // Automatically flushes queued reports
}
```

--------------------------------

### FlareConfig methods

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/README.md

Provides access to over 50 fluent methods for configuring the Flare client. These methods allow for extensive customization of the client's behavior.

```APIDOC
## FlareConfig methods

### Description
Provides access to over 50 fluent methods for configuring the Flare client.

### Method
(Various instance methods)

### Endpoint
(Not applicable, SDK methods)

### Parameters
(Parameters vary by method, not specified in source)

### Request Example
(Example not specified in the source text)

### Response
(Response details not specified in the source text)
```

--------------------------------

### PHP Tracer Exception: Ending Span Without Active Trace

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/errors.md

This exception occurs when `endSpan()` is called without an active trace being started. Ensure a trace is initiated before ending a span.

```php
$tracer->endSpan($span); // When no trace started - Throws Exception
```

--------------------------------

### Filter Exceptions Using a Callback

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare-config.md

Set a callback function to filter which exceptions get reported. The callback receives an `Exception` object and should return `true` to report the exception, or `false` to ignore it.

```php
public function filterExceptionsUsing(Closure $filterExceptionsCallable): static
```

--------------------------------

### Logging with Flare API

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/api.md

Illustrates how to flush logs using the Flare API's log method.

```php
// Logs - uses api->log()
$flare->log()->flush();
```

--------------------------------

### Get Current Parent Span ID

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/tracer.md

Retrieves the parent span ID of the current span, useful for creating child spans. Returns null if the current span is the root span.

```php
public function currentParentSpanId(): ?string
```

--------------------------------

### FlareConfig Constructor

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare-config.md

Directly instantiate the FlareConfig class. This is generally not recommended; use the `make()` factory method instead. The constructor accepts numerous parameters for detailed configuration.

```php
public function __construct(
    public ?string $apiToken = null,
    public string $baseUrl = Api::BASE_URL,
    public array $collects = [],
    // App
    public ?string $applicationPath = null,
    public string $applicationName = 'PHP application',
    public ?string $applicationVersion = null,
    public ?string $applicationStage = null,
    // Censoring
    public bool $censorClientIps = false,
    public array $censorHeaders = [],
    public array $censorBodyFields = [],
    public bool $censorCookies = false,
    public bool $censorSession = false,
    // Reporting
    public bool $report = true,
    public ?int $reportErrorLevels = null,
    public ?Closure $filterExceptionsCallable = null,
    public ?Closure $filterReportsCallable = null,
    public array $overriddenGroupings = [],
    // Tracing
    public bool $trace = true,
    public ?array $traceLimits = null,
    public ?Closure $configureScopeCallable = null,
    public ?Closure $configureResourceCallable = null,
    public ?Closure $configureSpansCallable = null,
    public ?Closure $configureSpanEventsCallable = null,
    // Logging
    public bool $log = false,
    public ?Level $minimalLogLevel = null,
    // Client Infrastructure
    public string $sender = CurlSender::class,
    public array $senderConfig = [],
    public string $sampler = RateSampler::class,
    public array $samplerConfig = [],
    public string $exporter = OpenTelemetryJsonExporter::class,
    public string $collectsResolver = CollectsResolver::class,
    public string $ids = Ids::class,
    public string $time = SystemTime::class,
    public string $memory = SystemMemory::class,
    public string $api = Api::class,
): void
```

--------------------------------

### Register Error Handler for Specific Error Levels

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/errors.md

Configure the error handler to only report critical errors by specifying the desired PHP error level constants. This example focuses on fatal user-generated and compile errors.

```php
// Only report critical errors, not warnings
$flare->registerErrorHandler(
    E_ERROR | E_CORE_ERROR | E_COMPILE_ERROR | E_USER_ERROR
);
```

--------------------------------

### Set Application Stage

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare-config.md

Defines the application's environment stage (e.g., production, staging, development). Accepts a string or a closure.

```php
public function applicationStage(string|Closure $stage): static
```

--------------------------------

### Execute a callback within a span

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/tracer.md

Creates a span around the execution of a callback function. Automatically handles starting and ending the span, and setting the exception status if an error occurs. Attributes can be added based on the return value of the callback.

```php
$result = $flare->tracer->span(
    'database.query',
    fn() => DB::select('SELECT * FROM users'),
    attributes: ['db.system' => 'mysql'],
    endAttributes: fn($rows) => ['row_count' => count($rows)]
);
```

--------------------------------

### Python Example of Error Report Shape

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/endpoints.md

This is a conceptual representation of an error report payload, useful for understanding the structure of data sent to Flare. It includes details about the error message, exception class, tracking UUID, and contextual information like request and response details.

```Python
# Conceptual representation of error report payload
{
    "message": "TypeError: unsupported operand type(s)",
    "exception_class": "TypeError",
    "handled": False,
    "tracking_uuid": "abc-123-def",
    "relationships": {
        "error_report": {
            "data": {
                "attributes": {
                    "message": "unsupported operand type(s)",
                    "language": "php",
                    "exception_class": "TypeError",
                    "context": {
                        "request": {
                            "method": "POST",
                            "url": "https://example.com/api/users",
                            "headers": {...},
                            "body": {...}
                        },
                        "response": {
                            "status": 500,
                            "headers": {...}
                        }
                    }
                }
            }
        }
    }
}
```

--------------------------------

### withApplicationVersion

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/flare.md

Set the application version. This method allows you to specify the version of your application, which will be included in the reports sent to Flare. It accepts a string or a closure that returns a string.

```APIDOC
## withApplicationVersion

### Description
Set the application version.

### Method
```php
public function withApplicationVersion(string|Closure $version): self
```

### Parameters
#### Path Parameters
- **version** (string|Closure) - Required - Version string or callable

### Response
- **self** - Returns `$this` for method chaining
```

--------------------------------

### High Performance Settings for Flare Client

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/configuration.md

Configure Flare Client for high performance with reduced trace limits, 1% sampling, and ignoring common query types.

```php
FlareConfig::make($token)
    ->trace(true, maxSpans: 512)  // Reduced limits
    ->sampleRate(0.01)  // 1% sampling
    ->ignoreQueries()
    ->ignoreExternalHttp()
    ->ignoreCommands()
    ->ignoreJobs()
```

--------------------------------

### Tracer Class Constructor

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/api-reference/tracer.md

Initializes the Tracer with essential dependencies like the API client, time provider, ID generator, memory tracker, recorders, and entry point resolver. It also accepts optional configurations for sampling, span customization, and limits.

```php
public function __construct(
    protected readonly Api $api,
    ?array $limits,
    public readonly Time $time,
    public readonly Ids $ids,
    public readonly Memory $memory,
    protected Recorders $recorders,
    protected readonly EntryPointResolver $entryPointResolver,
    public readonly Sampler $sampler = new RateSampler([]),
    public ?Closure $configureSpansCallable = null,
    public ?Closure $configureSpanEventsCallable = null,
    public bool $sampling = false,
    protected bool $paused = false,
    public readonly bool $disabled = false,
    protected Closure|null $gracefulSpanEnderClosure = null
): void
```

--------------------------------

### Implement and Collect Custom Recorders

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/README.md

Allows for custom data collection by implementing the `Recorder` interface. The custom recorder can then be registered with the configuration.

```php
use Spatie\FlareClient\Contracts\Recorders\Recorder;

class CustomRecorder implements Recorder {
    public function record(/* ... */) {
        // Collect custom data
    }
}

$config->collectRecorders([
    CustomRecorder::class => []
]);
```

--------------------------------

### Tracer::startTrace()

Source: https://github.com/spatie/flare-client-php/blob/main/_autodocs/README.md

Begins a distributed trace. Used to initiate a new trace operation.

```APIDOC
## Tracer::startTrace()

### Description
Begins a distributed trace.

### Method
(Not specified, likely a static method)

### Endpoint
(Not applicable, SDK method)

### Parameters
(Parameters not specified in the source text)

### Request Example
(Example not specified in the source text)

### Response
(Response details not specified in the source text)
```
Tokens:
Raw