KMP PHP API Reference

TelemetryCheckCommand extends Command
in package

Deploy-time validation for the KMP performance instrumentation stack.

Prints the effective (non-secret) telemetry configuration, verifies the LOGS directory is writable under the current uid, reports the PHP runtime fingerprint that will be emitted on every performance trace, and (with --send) writes a smoke trace through the Log facade so the operator can confirm end-to-end delivery to Application Insights.

Table of Contents

Methods

defaultName()  : string
execute()  : int|null
Prints effective telemetry config, storage health, and (with --send) writes a smoke trace.
buildOptionParser()  : ConsoleOptionParser
Configures CLI options for this command.
effectiveConfig()  : array<string, string>

Methods

defaultName()

public static defaultName() : string
Return values
string

Default command name as invoked from bin/cake.

execute()

Prints effective telemetry config, storage health, and (with --send) writes a smoke trace.

public execute(Arguments $args, ConsoleIo $io) : int|null
Parameters
$args : Arguments

Parsed arguments

$io : ConsoleIo

Console IO

Return values
int|null

CODE_SUCCESS on healthy config; CODE_ERROR on issues.

buildOptionParser()

Configures CLI options for this command.

protected buildOptionParser(ConsoleOptionParser $parser) : ConsoleOptionParser
Parameters
$parser : ConsoleOptionParser

Parser to configure

Return values
ConsoleOptionParser

effectiveConfig()

private effectiveConfig() : array<string, string>
Return values
array<string, string>
On this page

Search results