Skip to content

Emit workspace executor metrics #570

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chubes4 merged 1 commit into from
Jun 6, 2026
Merged

Emit workspace executor metrics #570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
174 changes: 157 additions & 17 deletions inc/AgentsApi/WorkspaceExecutorAdapter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,35 +303,46 @@ public static function target_metadata(): array {
public function executeWP_Agent_Tool_Call( array $tool_call, array $tool_definition, array $context = array() ): array {
unset( $context );

$started_at = microtime(true);
$input_bytes = self::payload_bytes(is_array($tool_call['parameters'] ?? null) ? $tool_call['parameters'] : array());

$tool_name = (string) ( $tool_call['tool_name'] ?? $tool_definition['name'] ?? '' );
$config = self::TOOL_MAP[ $tool_name ] ?? null;
if ( null === $config ) {
return self::error_result($tool_name, 'DMC workspace executor does not provide this tool.', 'unsupported_tool');
return self::error_result($tool_name, 'DMC workspace executor does not provide this tool.', 'unsupported_tool', null, $input_bytes, null, $started_at);
}

if ( ! function_exists('wp_get_ability') ) {
return self::error_result($tool_name, 'WordPress Abilities API is not available.', 'abilities_api_unavailable');
return self::error_result($tool_name, 'WordPress Abilities API is not available.', 'abilities_api_unavailable', $config, $input_bytes, null, $started_at);
}

$ability = wp_get_ability( (string) $config['ability'] );
if ( ! is_object($ability) || ! method_exists($ability, 'execute') ) {
return self::error_result($tool_name, 'Mapped DMC ability is not registered.', 'ability_unavailable');
return self::error_result($tool_name, 'Mapped DMC ability is not registered.', 'ability_unavailable', $config, $input_bytes, null, $started_at);
}

$result = $ability->execute(is_array($tool_call['parameters'] ?? null) ? $tool_call['parameters'] : array());
$ability_started_at = microtime(true);
$result = $ability->execute(is_array($tool_call['parameters'] ?? null) ? $tool_call['parameters'] : array());
$ability_timing_ms = self::elapsed_ms($ability_started_at);
if ( function_exists('is_wp_error') && is_wp_error($result) ) {
return self::error_result(
$tool_name,
method_exists($result, 'get_error_message') ? $result->get_error_message() : 'DMC ability failed.',
method_exists($result, 'get_error_code') ? $result->get_error_code() : 'ability_error'
method_exists($result, 'get_error_code') ? $result->get_error_code() : 'ability_error',
$config,
$input_bytes,
null,
$started_at,
$ability_timing_ms
);
}

return array(
'success' => true,
'tool_name' => $tool_name,
'result' => $result,
'runtime' => self::runtime_metadata($config),
'success' => true,
'tool_name' => $tool_name,
'result' => $result,
'runtime' => self::runtime_metadata($config),
'execution_metrics' => self::execution_metrics($tool_name, $config, $input_bytes, $result, $started_at, null, $ability_timing_ms),
);
}

Expand All @@ -352,16 +363,145 @@ private static function runtime_metadata( array $config ): array {
/**
* @return array<string,mixed>
*/
private static function error_result( string $tool_name, string $message, string $error_type ): array {
private static function error_result(
string $tool_name,
string $message,
string $error_type,
?array $config = null,
int $input_bytes = 0,
$output = null,
?float $started_at = null,
?float $ability_timing_ms = null
): array {
$runtime = array(
'executor_target' => self::TARGET_ID,
'side_effect_boundary' => 'data-machine-code',
);
if ( null !== $config ) {
$runtime = self::runtime_metadata($config);
}

return array(
'success' => false,
'tool_name' => $tool_name,
'error' => $message,
'error_type' => $error_type,
'runtime' => array(
'executor_target' => self::TARGET_ID,
'side_effect_boundary' => 'data-machine-code',
'success' => false,
'tool_name' => $tool_name,
'error' => $message,
'error_type' => $error_type,
'runtime' => $runtime,
'execution_metrics' => self::execution_metrics($tool_name, $config, $input_bytes, $output, $started_at ?? microtime(true), $error_type, $ability_timing_ms),
);
}

/**
* Build numeric/classification-only executor metrics for placement policy.
*
* @param array<string,mixed>|null $config Tool map config.
* @param mixed $output Raw ability output.
* @return array<string,mixed>
*/
private static function execution_metrics( string $tool_name, ?array $config, int $input_bytes, $output, float $started_at, ?string $failure_class, ?float $ability_timing_ms ): array {
$output_bytes = null === $output ? 0 : self::payload_bytes($output);
$ability_name = null === $config ? '' : (string) $config['ability'];

$metrics = array(
'executor_target' => self::TARGET_ID,
'tool_name' => $tool_name,
'wall_time_ms' => self::elapsed_ms($started_at),
'ability_call_count' => '' === $ability_name || null === $ability_timing_ms ? 0 : 1,
'ability_timings_ms' => array(),
'payload_bytes' => array(
'input' => $input_bytes,
'output' => $output_bytes,
),
'artifacts' => self::artifact_metrics($output),
'side_effect_classes' => null === $config ? array() : self::side_effect_classes($config),
'side_effect_boundary' => 'data-machine-code',
'failure_class' => $failure_class,
);

if ( '' !== $ability_name && null !== $ability_timing_ms ) {
$metrics['ability_timings_ms'][] = array(
'ability' => $ability_name,
'ms' => $ability_timing_ms,
);
}

return $metrics;
}

private static function elapsed_ms( float $started_at ): float {
return round(max(0, microtime(true) - $started_at) * 1000, 3);
}

/**
* @param mixed $payload Payload to count without retaining raw contents.
*/
private static function payload_bytes( $payload ): int {
$encoded = wp_json_encode($payload);
if ( false === $encoded ) {
return 0;
}

return strlen($encoded);
}

/**
* @param array<string,mixed> $config Tool map config.
* @return list<string>
*/
private static function side_effect_classes( array $config ): array {
$classes = array();
foreach ( $config['side_effects'] as $side_effect ) {
$parts = explode('.', (string) $side_effect, 2);
if ( '' !== $parts[0] ) {
$classes[] = $parts[0];
}
}

return array_values(array_unique($classes));
}

/**
* @param mixed $payload Raw ability output.
* @return array{count:int,bytes:int}
*/
private static function artifact_metrics( $payload ): array {
$metrics = array(
'count' => 0,
'bytes' => 0,
);
self::accumulate_artifact_metrics($payload, $metrics);

return $metrics;
}

/**
* @param mixed $payload Raw ability output.
* @param array{count:int,bytes:int} $metrics Running metrics.
*/
private static function accumulate_artifact_metrics( $payload, array &$metrics ): void {
if ( ! is_array($payload) ) {
return;
}

if ( isset($payload['artifact_size_bytes']) && is_numeric($payload['artifact_size_bytes']) ) {
++$metrics['count'];
$metrics['bytes'] += max(0, (int) $payload['artifact_size_bytes']);
} elseif ( isset($payload['size_bytes']) && is_numeric($payload['size_bytes']) && self::looks_like_artifact_row($payload) ) {
++$metrics['count'];
$metrics['bytes'] += max(0, (int) $payload['size_bytes']);
}

foreach ( $payload as $value ) {
self::accumulate_artifact_metrics($value, $metrics);
}
}

/**
* @param array<mixed> $row Candidate artifact row.
*/
private static function looks_like_artifact_row( array $row ): bool {
return isset($row['artifact'], $row['size_bytes'])
|| isset($row['artifact_path'], $row['size_bytes'])
|| isset($row['path'], $row['size_bytes']);
}
}
45 changes: 44 additions & 1 deletion tests/smoke-agents-api-workspace-executor-adapter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ function is_wp_error( $value ): bool {
return $value instanceof WP_Error;
}

function wp_json_encode( $value ) {
return json_encode($value);
}

class WP_Error {
public function __construct( private string $code, private string $message ) {}

Expand All @@ -55,11 +59,24 @@ public function execute( array $input ): array {
'input' => $input,
);

return array(
$result = array(
'success' => true,
'ability' => $this->name,
'input' => $input,
);

if ( 'datamachine-code/workspace-write' === $this->name ) {
$result['artifacts'] = array(
array(
'path' => $input['path'] ?? 'artifact.txt',
'size_bytes' => 12345,
'raw_artifact' => str_repeat('artifact-payload-', 512),
'secret_marker' => $input['content'] ?? '',
),
);
}

return $result;
}
}

Expand Down Expand Up @@ -151,6 +168,31 @@ public function execute( array $input ): array {
$assert('executor delegates to DMC workspace-read ability', 'datamachine-code/workspace-read' === ( $GLOBALS['dmc_agents_api_executed_ability']['name'] ?? '' ));
$assert('executor passes parameters through unchanged', 'README.md' === ( $GLOBALS['dmc_agents_api_executed_ability']['input']['path'] ?? '' ));
$assert('executor result preserves runtime target metadata', 'data-machine-code/blessed-workspace' === ( $result['runtime']['executor_target'] ?? '' ));
$assert('executor emits execution metrics', isset($result['execution_metrics']['wall_time_ms']));
$assert('executor metrics count the DMC ability call', 1 === (int) ( $result['execution_metrics']['ability_call_count'] ?? 0 ));
$assert('executor metrics include per-ability timing', 'datamachine-code/workspace-read' === ( $result['execution_metrics']['ability_timings_ms'][0]['ability'] ?? '' ));
$assert('executor metrics count payload bytes without replacing result semantics', (int) ( $result['execution_metrics']['payload_bytes']['input'] ?? 0 ) > 0);
$assert('read metrics report no mutating side-effect classes', array() === ( $result['execution_metrics']['side_effect_classes'] ?? null ));

$secret_content = 'super-secret-token-value-' . str_repeat('x', 1024);
$write_result = $executor->executeWP_Agent_Tool_Call(
array(
'tool_name' => 'client/filesystem_write',
'parameters' => array(
'repo' => 'demo@branch',
'path' => 'build/output.txt',
'content' => $secret_content,
),
),
$tools['client/filesystem_write'],
array()
);
$write_metrics = $write_result['execution_metrics'] ?? array();
$metrics_json = json_encode($write_metrics);
$assert('write metrics report filesystem side-effect class', array( 'filesystem' ) === ( $write_metrics['side_effect_classes'] ?? null ));
$assert('write metrics count artifact references by bytes', 1 === (int) ( $write_metrics['artifacts']['count'] ?? 0 ) && 12345 === (int) ( $write_metrics['artifacts']['bytes'] ?? 0 ));
$assert('write metrics do not copy secret input values', false !== $metrics_json && ! str_contains($metrics_json, 'super-secret-token-value'));
$assert('write metrics do not copy oversized raw artifact payloads', false !== $metrics_json && ! str_contains($metrics_json, 'artifact-payload-'));

$unsupported = $executor->executeWP_Agent_Tool_Call(
array(
Expand All @@ -161,6 +203,7 @@ public function execute( array $input ): array {
array()
);
$assert('unsupported tools fail without side effects', false === ( $unsupported['success'] ?? true ) && 'unsupported_tool' === ( $unsupported['error_type'] ?? '' ));
$assert('failure metrics expose normalized failure class', 'unsupported_tool' === ( $unsupported['execution_metrics']['failure_class'] ?? '' ));

if ( ! empty($failures) ) {
echo "\nFAIL: " . count($failures) . " assertion(s) failed\n";
Expand Down
Loading