class ConfigurationNormalizer

Constants

DEFAULT_HTTP_METHODS

Methods

array
normalize(array $configuration)

Normalize configuration consumed by a producing process.

array
instrumentation(mixed $configuration, bool $tracesActive, bool $logsActive, bool $metricsActive)

Normalize class-keyed instrumentation settings.

array
instrumentationRecord(string $class, array $options)

Normalize one instrumentation record.

array|bool
instrumentationMetrics(mixed $configuration, string $path)

Normalize a boolean or class-defined metric map.

array
queueDepthTargets(mixed $configuration, string $path)

Normalize configured queue-depth targets.

int|null
nullablePositiveInteger(mixed $value, string $path)

Normalize a nullable positive integer.

bool
instrumentationHasOutput(string $class, array $options, bool $builtIn, bool $tracesActive, bool $logsActive, bool $metricsActive)

Determine whether an instrumentation has any enabled output.

array
instrumentationDefaults()

Return fixed defaults for replaceable built-in instrumentation records.

array
service(mixed $configuration)

Normalize service resource defaults.

array
metrics(mixed $configuration)

Normalize metrics signal configuration.

array
traces(mixed $configuration)

Normalize trace signal configuration.

array
logs(mixed $configuration)

Normalize log signal configuration.

array
exporters(mixed $configuration)

Normalize named exporter configurations.

array
otlpDefaults()

Return default OTLP exporter settings used to restore replaced records.

string
exporterName(mixed $configuration, string $path)

Normalize an exporter list to its single selected name.

array
record(mixed $configuration, array $defaults, string $path)

Merge a replaceable configuration record with its fixed defaults.

bool
boolean(array $configuration, string $key, string $path)

Read a required boolean value.

string
string(array $configuration, string $key, string $path)

Read a required string value.

string|null
nullableString(array $configuration, string $key, string $path)

Read a nullable string value.

string|null
nullableClass(array $configuration, string $key, string $path)

Read a nullable class string.

int
integer(array $configuration, string $key, string $path)

Read a required integer value.

void
ensurePositiveInteger(int $value, string $path)

Ensure an integer value is positive when its setting is active.

array
stringList(mixed $configuration, string $path)

Normalize a list of strings.

array
associativeArray(mixed $configuration, string $path)

Normalize an associative array.

invalidType(string $path, string $expected, mixed $value)

Create a consistent invalid-configuration exception.

Details

at line 48
array normalize(array $configuration)

Normalize configuration consumed by a producing process.

Parameters

array $configuration

Return Value

array

at line 127
protected array instrumentation(mixed $configuration, bool $tracesActive, bool $logsActive, bool $metricsActive)

Normalize class-keyed instrumentation settings.

Parameters

mixed $configuration
bool $tracesActive
bool $logsActive
bool $metricsActive

Return Value

array

at line 220
protected array instrumentationRecord(string $class, array $options)

Normalize one instrumentation record.

Parameters

string $class
array $options

Return Value

array

at line 268
protected array|bool instrumentationMetrics(mixed $configuration, string $path)

Normalize a boolean or class-defined metric map.

Parameters

mixed $configuration
string $path

Return Value

array|bool

at line 290
protected array queueDepthTargets(mixed $configuration, string $path)

Normalize configured queue-depth targets.

Parameters

mixed $configuration
string $path

Return Value

array

at line 308
protected int|null nullablePositiveInteger(mixed $value, string $path)

Normalize a nullable positive integer.

Parameters

mixed $value
string $path

Return Value

int|null

at line 328
protected bool instrumentationHasOutput(string $class, array $options, bool $builtIn, bool $tracesActive, bool $logsActive, bool $metricsActive)

Determine whether an instrumentation has any enabled output.

Parameters

string $class
array $options
bool $builtIn
bool $tracesActive
bool $logsActive
bool $metricsActive

Return Value

bool

at line 369
protected array instrumentationDefaults()

Return fixed defaults for replaceable built-in instrumentation records.

Return Value

array

at line 523
protected array service(mixed $configuration)

Normalize service resource defaults.

Parameters

mixed $configuration

Return Value

array

at line 545
protected array metrics(mixed $configuration)

Normalize metrics signal configuration.

Parameters

mixed $configuration

Return Value

array

at line 590
protected array traces(mixed $configuration)

Normalize trace signal configuration.

Parameters

mixed $configuration

Return Value

array

at line 676
protected array logs(mixed $configuration)

Normalize log signal configuration.

Parameters

mixed $configuration

Return Value

array

at line 744
protected array exporters(mixed $configuration)

Normalize named exporter configurations.

Parameters

mixed $configuration

Return Value

array

at line 776
protected array otlpDefaults()

Return default OTLP exporter settings used to restore replaced records.

Return Value

array

at line 803
protected string exporterName(mixed $configuration, string $path)

Normalize an exporter list to its single selected name.

Parameters

mixed $configuration
string $path

Return Value

string

at line 830
protected array record(mixed $configuration, array $defaults, string $path)

Merge a replaceable configuration record with its fixed defaults.

Parameters

mixed $configuration
array $defaults
string $path

Return Value

array

at line 842
protected bool boolean(array $configuration, string $key, string $path)

Read a required boolean value.

Parameters

array $configuration
string $key
string $path

Return Value

bool

at line 856
protected string string(array $configuration, string $key, string $path)

Read a required string value.

Parameters

array $configuration
string $key
string $path

Return Value

string

at line 870
protected string|null nullableString(array $configuration, string $key, string $path)

Read a nullable string value.

Parameters

array $configuration
string $key
string $path

Return Value

string|null

at line 884
protected string|null nullableClass(array $configuration, string $key, string $path)

Read a nullable class string.

Parameters

array $configuration
string $key
string $path

Return Value

string|null

at line 892
protected int integer(array $configuration, string $key, string $path)

Read a required integer value.

Parameters

array $configuration
string $key
string $path

Return Value

int

at line 906
protected void ensurePositiveInteger(int $value, string $path)

Ensure an integer value is positive when its setting is active.

Parameters

int $value
string $path

Return Value

void

at line 918
protected array stringList(mixed $configuration, string $path)

Normalize a list of strings.

Parameters

mixed $configuration
string $path

Return Value

array

at line 938
protected array associativeArray(mixed $configuration, string $path)

Normalize an associative array.

Parameters

mixed $configuration
string $path

Return Value

array

at line 950
protected InvalidArgumentException invalidType(string $path, string $expected, mixed $value)

Create a consistent invalid-configuration exception.

Parameters

string $path
string $expected
mixed $value

Return Value

InvalidArgumentException