HttpTelemetry
in package
FinalYes
Builds, extends, modifies, and formats SDK telemetry data.
Table of Contents
Properties
- $environment : null|array<string|int, mixed>
- Additional environmental data tp send with telemetry headers, such as PHP version.
- $packageName : string|null
- Library package name to send with telemetry headers.
- $packageVersion : string|null
- Library package version to send with telemetry headers.
Methods
- build() : string
- Return a header-formatted string.
- get() : array<string|int, mixed>
- Get the current header data as an array.
- reset() : void
- Reset Telemetry to defaults.
- setCorePackage() : void
- Set the main SDK name and version to the PHP SDK.
- setEnvironmentData() : void
- Replace the current env data with new data.
- setEnvProperty() : void
- Add an optional env property for SDK telemetry.
- setPackage() : void
- Set the main SDK name and version.
Properties
$environment
Additional environmental data tp send with telemetry headers, such as PHP version.
private
static null|array<string|int, mixed>
$environment
= null
$packageName
Library package name to send with telemetry headers.
private
static string|null
$packageName
= null
$packageVersion
Library package version to send with telemetry headers.
private
static string|null
$packageVersion
= null
Methods
build()
Return a header-formatted string.
public
static build() : string
Return values
stringget()
Get the current header data as an array.
public
static get() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>reset()
Reset Telemetry to defaults.
public
static reset() : void
setCorePackage()
Set the main SDK name and version to the PHP SDK.
public
static setCorePackage() : void
setEnvironmentData()
Replace the current env data with new data.
public
static setEnvironmentData(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>
-
env data to add
setEnvProperty()
Add an optional env property for SDK telemetry.
public
static setEnvProperty(string $name, string $version) : void
Parameters
- $name : string
-
property name to set, name of dependency or platform
- $version : string
-
version number of dependency or platform
setPackage()
Set the main SDK name and version.
public
static setPackage(string $name, string $version) : void
Parameters
- $name : string
-
SDK name
- $version : string
-
SDK version number