ErrorReport
in package
implements
JsonSerializable
Privacy-safe description of one terminally failed Inttegro SDK operation.
Reports intentionally exclude credentials, headers, bodies, resource IDs, dynamic URLs,
exception messages, and stack traces. Applications receive a report only when they explicitly
configure an error reporter on Client.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $apiError : APIErrorReportContext|null
- Safe machine-readable API error fields, when applicable.
- $category : string
- Stable failure category.
- $eventId : string
- Unique identifier for this report event.
- $exceptionType : string
- Exception class name without its message or stack trace.
- $fingerprint : string
- Stable value used to group equivalent failures.
- $http : HTTPReportContext
- Privacy-safe HTTP operation metadata.
- $occurredAt : string
- Offset-bearing timestamp at which the failure report was created.
- $operation : string
- Logical SDK operation, such as `orders.create`.
- $schemaVersion : int
- Report schema version.
- $sdk : SDKReportContext
- SDK language and version.
- $severity : string
- Failure severity.
- $trace : TraceReportContext|null
- Application-owned trace identifiers, when tracing was active.
Methods
- __construct() : mixed
- Creates an immutable failure report from fields already filtered by the SDK.
- jsonSerialize() : array<string, mixed>
Properties
$apiError read-only
Safe machine-readable API error fields, when applicable.
public
APIErrorReportContext|null
$apiError
= null
$category read-only
Stable failure category.
public
string
$category
$eventId read-only
Unique identifier for this report event.
public
string
$eventId
$exceptionType read-only
Exception class name without its message or stack trace.
public
string
$exceptionType
$fingerprint read-only
Stable value used to group equivalent failures.
public
string
$fingerprint
$http read-only
Privacy-safe HTTP operation metadata.
public
HTTPReportContext
$http
$occurredAt read-only
Offset-bearing timestamp at which the failure report was created.
public
string
$occurredAt
$operation read-only
Logical SDK operation, such as `orders.create`.
public
string
$operation
$schemaVersion read-only
Report schema version.
public
int
$schemaVersion
$sdk read-only
SDK language and version.
public
SDKReportContext
$sdk
$severity read-only
Failure severity.
public
string
$severity
$trace read-only
Application-owned trace identifiers, when tracing was active.
public
TraceReportContext|null
$trace
= null
Methods
__construct()
Creates an immutable failure report from fields already filtered by the SDK.
public
__construct(int $schemaVersion, string $eventId, string $occurredAt, string $severity, string $category, string $operation, SDKReportContext $sdk, HTTPReportContext $http, string $exceptionType, string $fingerprint[, APIErrorReportContext|null $apiError = null ][, TraceReportContext|null $trace = null ]) : mixed
Parameters
- $schemaVersion : int
-
Report schema version.
- $eventId : string
-
Unique event identifier.
- $occurredAt : string
-
Offset-bearing event timestamp.
- $severity : string
-
Failure severity.
- $category : string
-
Stable failure category.
- $operation : string
-
Logical SDK operation.
- $sdk : SDKReportContext
-
SDK identity.
- $http : HTTPReportContext
-
Privacy-safe HTTP metadata.
- $exceptionType : string
-
Exception class name without its message or stack trace.
- $fingerprint : string
-
Stable grouping fingerprint.
- $apiError : APIErrorReportContext|null = null
-
Safe API error fields.
- $trace : TraceReportContext|null = null
-
Application-owned trace identifiers.
jsonSerialize()
public
jsonSerialize() : array<string, mixed>
Return values
array<string, mixed> —Complete JSON-safe report with null contexts omitted.