Payload

Endpoint

POST https://ingress.flareapp.io/v1/logs

Headers

Authentication

Authenticate using your project's private API key in the x-api-token header.

Payload

The log payload follows the OpenTelemetry protocol structure.

Resource Logs

Resource

A resource represents the entity producing telemetry data (your application/service). For a list of common resource attributes, see Resources.

Scope Logs

Scope

A scope represents the instrumentation library that produced the logs.

Log Records

A log record represents a single log entry. Each record must have at least one timestamp field (timeUnixNano or observedTimeUnixNano).

Severity Numbers

Severity numbers follow the OpenTelemetry severity mapping:

Attribute Format

All attributes and the log record body field use the OpenTelemetry typed attribute format. See Attribute Formats for the full format specification and value types.

Entry Point

A log record produced inside a request, command, or job may carry the flare.entry_point.* attributes that describe the surrounding work. This lets logs be filtered alongside the errors and traces from the same source. See Entry points for the schema.

Responses

All responses include CORS headers (Access-Control-Allow-Origin: *) and return application/json.

Success response:

{}

Validation error responses include the field path and a description of the issue:

{
    "message": "The given data was invalid.",
    "errors": {
        "resourceLogs.0.scopeLogs.0.logRecords.0.timeUnixNano": [
            "Either timeUnixNano or observedTimeUnixNano is required."
        ]
    }
}

Example

{
    "resourceLogs": [
        {
            "resource": {
                "attributes": [
                    { "key": "service.name", "value": { "stringValue": "My Application" } },
                    { "key": "service.version", "value": { "stringValue": "1.0.0" } },
                    { "key": "service.stage", "value": { "stringValue": "production" } },
                    { "key": "telemetry.sdk.language", "value": { "stringValue": "PHP" } },
                    { "key": "telemetry.sdk.name", "value": { "stringValue": "spatie/flare-client-php" } },
                    { "key": "telemetry.sdk.version", "value": { "stringValue": "1.0.0" } }
                ],
                "droppedAttributesCount": 0
            },
            "scopeLogs": [
                {
                    "scope": {
                        "name": "spatie/laravel-flare",
                        "version": "1.0.0"
                    },
                    "logRecords": [
                        {
                            "timeUnixNano": "1710252000000000000",
                            "observedTimeUnixNano": "1710252000000000000",
                            "severityNumber": 9,
                            "severityText": "INFO",
                            "body": {
                                "stringValue": "User logged in successfully"
                            },
                            "attributes": [
                                { "key": "user.id", "value": { "intValue": 42 } },
                                { "key": "http.route", "value": { "stringValue": "/login" } }
                            ],
                            "droppedAttributesCount": 0,
                            "traceId": "a1b2c3d4e5f67890a1b2c3d4e5f67890",
                            "spanId": "1234567890abcdef"
                        },
                        {
                            "timeUnixNano": "1710252001000000000",
                            "observedTimeUnixNano": "1710252001000000000",
                            "severityNumber": 17,
                            "severityText": "ERROR",
                            "body": {
                                "stringValue": "Failed to send welcome email"
                            },
                            "attributes": [
                                { "key": "exception.type", "value": { "stringValue": "Swift_TransportException" } },
                                { "key": "exception.message", "value": { "stringValue": "Connection refused" } }
                            ],
                            "droppedAttributesCount": 0
                        }
                    ]
                }
            ]
        }
    ]
}