Skip to content

backport (4.x): Switch to Observability Pipeline endpoints for querying metrics #1578

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
merged 5 commits into from
Nov 17, 2025
Merged

backport (4.x): Switch to Observability Pipeline endpoints for querying metrics #1578

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dab8bb3
Switch to Observability Pipeline endpoints for querying metrics (#1536)
romainneutron Nov 5, 2025
0ff89f3
Fix PHP 5.6 compatibility and remove Selector dependency.
pjcdawkins Nov 5, 2025
6c7c301
Fix service access patterns for PHP 5.6 compatibility.
pjcdawkins Nov 5, 2025
93b39a8
Short array syntax
pjcdawkins Nov 11, 2025
108f054
Fix exception thrown when backend does not have received values for t…
romainneutron Nov 13, 2025
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
1 change: 0 additions & 1 deletion src/Application.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,6 @@ protected function getCommands()
$commands[] = new Command\Organization\User\OrganizationUserUpdateCommand();
$commands[] = new Command\Metrics\AllMetricsCommand();
$commands[] = new Command\Metrics\CpuCommand();
$commands[] = new Command\Metrics\CurlCommand();
$commands[] = new Command\Metrics\DiskUsageCommand();
$commands[] = new Command\Metrics\MemCommand();
$commands[] = new Command\Project\ProjectClearBuildCacheCommand();
Expand Down
203 changes: 143 additions & 60 deletions src/Command/Metrics/AllMetricsCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
<?php
namespace Platformsh\Cli\Command\Metrics;

use Khill\Duration\Duration;
use Platformsh\Cli\Model\Metrics\Aggregation;
use Platformsh\Cli\Model\Metrics\Field;
use Platformsh\Cli\Model\Metrics\Format;
use Platformsh\Cli\Model\Metrics\MetricKind;
use Platformsh\Cli\Model\Metrics\SourceField;
use Platformsh\Cli\Model\Metrics\SourceFieldPercentage;
use Khill\Duration\Duration;
use Platformsh\Cli\Service\PropertyFormatter;
use Platformsh\Cli\Service\Table;
use Symfony\Component\Console\Input\InputInterface;
Expand All @@ -11,7 +16,10 @@

class AllMetricsCommand extends MetricsCommandBase
{
private $tableHeader = [
/**
* @var array
*/
private static $tableHeader = [
'timestamp' => 'Timestamp',
'service' => 'Service',
'type' => 'Type',
Expand Down Expand Up @@ -41,7 +49,22 @@ class AllMetricsCommand extends MetricsCommandBase
'tmp_inodes_percent' => '/tmp inodes %',
];

private $defaultColumns = ['timestamp', 'service', 'cpu_percent', 'mem_percent', 'disk_percent', 'tmp_disk_percent'];
/**
* @var array
*/
private $defaultColumns = [
'timestamp',
'service',

'cpu_percent',
'mem_percent',
'disk_percent',
'inodes_percent',

'tmp_disk_percent',
'tmp_inodes_percent',
];


/**
* {@inheritdoc}
Expand All @@ -53,85 +76,145 @@ protected function configure()
->setDescription('Show CPU, disk and memory metrics for an environment')
->addOption('bytes', 'B', InputOption::VALUE_NONE, 'Show sizes in bytes');
$this->addExample('Show metrics for the last ' . (new Duration())->humanize(self::DEFAULT_RANGE));
$this->addExample('Show metrics in five-minute intervals over the last hour', '-i 5m -r 1h');
$this->addExample('Show metrics over the last hour', ' -r 1h');
$this->addExample('Show metrics for all SQL services', '--type mariadb,%sql');
$this->addMetricsOptions()
->addProjectOption()
->addEnvironmentOption();
Table::configureInput($this->getDefinition(), $this->tableHeader, $this->defaultColumns);
$this->addMetricsOptions()->addProjectOption()->addEnvironmentOption();
Table::configureInput($this->getDefinition(), self::$tableHeader, $this->defaultColumns);
PropertyFormatter::configureInput($this->getDefinition());
}

/**
* {@inheritdoc}
* @param InputInterface $input
* @param OutputInterface $output
* @return int
*/
protected function execute(InputInterface $input, OutputInterface $output)
{
$timeSpec = $this->validateTimeInput($input);
if ($timeSpec === false) {
return 1;
}
$result = $this->processQuery($input, [
MetricKind::API_TYPE_CPU,
MetricKind::API_TYPE_DISK,
MetricKind::API_TYPE_MEMORY,
MetricKind::API_TYPE_INODES,
], [MetricKind::API_AGG_AVG]);

$this->chooseEnvFilter = $this->filterEnvsMaybeActive();
$this->validateInput($input, false, true);

/** @var \Platformsh\Cli\Service\Table $table */
$table = $this->getService('table');

if (!$table->formatIsMachineReadable()) {
$this->displayEnvironmentHeader();
}

// Only request the metrics fields that will be displayed.
//
// The fields are the selected column names (according to the $table
// service), filtered to only those that contain an underscore.
$fieldNames = array_filter($table->columnsToDisplay($this->tableHeader, $this->defaultColumns), function ($c) { return strpos($c, '_') !== false; });
$values = $this->fetchMetrics($input, $timeSpec, $this->getSelectedEnvironment(), $fieldNames);
if ($values === false) {
return 1;
}
$values = $result[0];
$environment = $result[1];

$bytes = $input->getOption('bytes');

$rows = $this->buildRows($values, [
'cpu_used' => new Field('cpu_used', Field::FORMAT_ROUNDED_2DP),
'cpu_limit' => new Field('cpu_limit', Field::FORMAT_ROUNDED_2DP),
'cpu_percent' => new Field('cpu_percent', Field::FORMAT_PERCENT),

'mem_used' => new Field('mem_used', $bytes ? Field::FORMAT_ROUNDED : Field::FORMAT_MEMORY),
'mem_limit' => new Field('mem_limit', $bytes ? Field::FORMAT_ROUNDED : Field::FORMAT_MEMORY),
'mem_percent' => new Field('mem_percent', Field::FORMAT_PERCENT),

'disk_used' => new Field('disk_used', $bytes ? Field::FORMAT_ROUNDED : Field::FORMAT_DISK),
'disk_limit' => new Field('disk_limit', $bytes ? Field::FORMAT_ROUNDED : Field::FORMAT_DISK),
'disk_percent' => new Field('disk_percent', Field::FORMAT_PERCENT),

'tmp_disk_used' => new Field('tmp_disk_used', $bytes ? Field::FORMAT_ROUNDED : Field::FORMAT_DISK),
'tmp_disk_limit' => new Field('tmp_disk_limit', $bytes ? Field::FORMAT_ROUNDED : Field::FORMAT_DISK),
'tmp_disk_percent' => new Field('tmp_disk_percent', Field::FORMAT_PERCENT),

'inodes_used' => new Field('inodes_used', Field::FORMAT_ROUNDED),
'inodes_limit' => new Field('inodes_used', Field::FORMAT_ROUNDED),
'inodes_percent' => new Field('inodes_percent', Field::FORMAT_PERCENT),

'tmp_inodes_used' => new Field('tmp_inodes_used', Field::FORMAT_ROUNDED),
'tmp_inodes_limit' => new Field('tmp_inodes_used', Field::FORMAT_ROUNDED),
'tmp_inodes_percent' => new Field('tmp_inodes_percent', Field::FORMAT_PERCENT),
]);
'cpu_used' => new Field(
Format::ROUNDED_2P,
new SourceField(MetricKind::CPU_USED, Aggregation::AVG)
),
'cpu_limit' => new Field(
Format::ROUNDED_2P,
new SourceField(MetricKind::CPU_LIMIT, Aggregation::MAX)
),
'cpu_percent' => new Field(
Format::PERCENT,
new SourceFieldPercentage(
new SourceField(MetricKind::CPU_USED, Aggregation::AVG),
new SourceField(MetricKind::CPU_LIMIT, Aggregation::MAX)
)
),

'mem_used' => new Field(
$bytes ? Format::ROUNDED : Format::MEMORY,
new SourceField(MetricKind::MEMORY_USED, Aggregation::AVG)
),
'mem_limit' => new Field(
$bytes ? Format::ROUNDED : Format::MEMORY,
new SourceField(MetricKind::MEMORY_LIMIT, Aggregation::MAX)
),
'mem_percent' => new Field(
Format::PERCENT,
new SourceFieldPercentage(
new SourceField(MetricKind::MEMORY_USED, Aggregation::AVG),
new SourceField(MetricKind::MEMORY_LIMIT, Aggregation::MAX)
),
false
),

'disk_used' => new Field(
$bytes ? Format::ROUNDED : Format::DISK,
new SourceField(MetricKind::DISK_USED, Aggregation::AVG, '/mnt')
),
'disk_limit' => new Field(
$bytes ? Format::ROUNDED : Format::DISK,
new SourceField(MetricKind::DISK_LIMIT, Aggregation::MAX, '/mnt')
),
'disk_percent' => new Field(
Format::PERCENT,
new SourceFieldPercentage(
new SourceField(MetricKind::DISK_USED, Aggregation::AVG, '/mnt'),
new SourceField(MetricKind::DISK_LIMIT, Aggregation::MAX, '/mnt')
)
),

'tmp_disk_used' => new Field(
$bytes ? Format::ROUNDED : Format::DISK,
new SourceField(MetricKind::DISK_USED, Aggregation::AVG, '/tmp')
),
'tmp_disk_limit' => new Field(
$bytes ? Format::ROUNDED : Format::DISK,
new SourceField(MetricKind::DISK_LIMIT, Aggregation::MAX, '/tmp')
),
'tmp_disk_percent' => new Field(
Format::PERCENT,
new SourceFieldPercentage(
new SourceField(MetricKind::DISK_USED, Aggregation::AVG, '/tmp'),
new SourceField(MetricKind::DISK_LIMIT, Aggregation::MAX, '/tmp')
)
),

'inodes_used' => new Field(
Format::ROUNDED,
new SourceField(MetricKind::INODES_USED, Aggregation::AVG, '/mnt')
),
'inodes_limit' => new Field(
Format::ROUNDED,
new SourceField(MetricKind::INODES_LIMIT, Aggregation::MAX, '/mnt')
),
'inodes_percent' => new Field(
Format::PERCENT,
new SourceFieldPercentage(
new SourceField(MetricKind::INODES_USED, Aggregation::AVG, '/mnt'),
new SourceField(MetricKind::INODES_LIMIT, Aggregation::MAX, '/mnt')
)
),

'tmp_inodes_used' => new Field(
Format::ROUNDED,
new SourceField(MetricKind::INODES_USED, Aggregation::AVG, '/tmp')
),
'tmp_inodes_limit' => new Field(
Format::ROUNDED,
new SourceField(MetricKind::INODES_LIMIT, Aggregation::MAX, '/tmp')
),
'tmp_inodes_percent' => new Field(
Format::PERCENT,
new SourceFieldPercentage(
new SourceField(MetricKind::INODES_USED, Aggregation::AVG, '/tmp'),
new SourceField(MetricKind::INODES_LIMIT, Aggregation::MAX, '/tmp')
)
),
], $environment);

/** @var \Platformsh\Cli\Service\Table $table */
$table = $this->getService('table');
if (!$table->formatIsMachineReadable()) {
/** @var PropertyFormatter $formatter */
$formatter = $this->getService('property_formatter');
$this->stdErr->writeln(\sprintf(
'Metrics at <info>%s</info> intervals from <info>%s</info> to <info>%s</info>:',
(new Duration())->humanize($timeSpec->getInterval()),
$formatter->formatDate($timeSpec->getStartTime()),
$formatter->formatDate($timeSpec->getEndTime())
(new Duration())->humanize($values['_grain']),
$formatter->formatDate($values['_from']),
$formatter->formatDate($values['_to'])
));
}

$table->render($rows, $this->tableHeader, $this->defaultColumns);
$table->render($rows, self::$tableHeader, $this->defaultColumns);

if (!$table->formatIsMachineReadable()) {
$this->explainHighMemoryServices();
Expand Down
75 changes: 43 additions & 32 deletions src/Command/Metrics/CpuCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@
<?php
namespace Platformsh\Cli\Command\Metrics;

use Khill\Duration\Duration;
use Platformsh\Cli\Model\Metrics\Aggregation;
use Platformsh\Cli\Model\Metrics\Field;
use Platformsh\Cli\Model\Metrics\Format;
use Platformsh\Cli\Model\Metrics\MetricKind;
use Platformsh\Cli\Model\Metrics\SourceField;
use Platformsh\Cli\Model\Metrics\SourceFieldPercentage;
use Khill\Duration\Duration;
use Platformsh\Cli\Service\PropertyFormatter;
use Platformsh\Cli\Service\Table;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class CpuCommand extends MetricsCommandBase
{
private $tableHeader = [
/**
* @var array
*/
private static $tableHeader = [
'timestamp' => 'Timestamp',
'service' => 'Service',
'type' => 'Type',
Expand All @@ -19,6 +27,9 @@ class CpuCommand extends MetricsCommandBase
'percent' => 'Used %',
];

/**
* @var array
*/
private $defaultColumns = ['timestamp', 'service', 'used', 'limit', 'percent'];

/**
Expand All @@ -29,55 +40,55 @@ protected function configure()
$this->setName('metrics:cpu')
->setAliases(['cpu'])
->setDescription('Show CPU usage of an environment');
$this->addMetricsOptions()
->addProjectOption()
->addEnvironmentOption();
Table::configureInput($this->getDefinition(), $this->tableHeader, $this->defaultColumns);
$this->addMetricsOptions()->addProjectOption()->addEnvironmentOption();
Table::configureInput($this->getDefinition(), self::$tableHeader, $this->defaultColumns);
PropertyFormatter::configureInput($this->getDefinition());
}

/**
* {@inheritdoc}
* @param InputInterface $input
* @param OutputInterface $output
* @return int
*/
protected function execute(InputInterface $input, OutputInterface $output)
{
$timeSpec = $this->validateTimeInput($input);
if ($timeSpec === false) {
return 1;
}

$this->validateInput($input, false, true);
$result = $this->processQuery($input, [MetricKind::API_TYPE_CPU], [MetricKind::API_AGG_AVG]);

/** @var \Platformsh\Cli\Service\Table $table */
$table = $this->getService('table');

if (!$table->formatIsMachineReadable()) {
$this->displayEnvironmentHeader();
}

$values = $this->fetchMetrics($input, $timeSpec, $this->getSelectedEnvironment(), ['cpu_used', 'cpu_percent', 'cpu_limit']);
if ($values === false) {
return 1;
}
$values = $result[0];
$environment = $result[1];

$rows = $this->buildRows($values, [
'used' => new Field('cpu_used', Field::FORMAT_ROUNDED_2DP),
'limit' => new Field('cpu_limit', Field::FORMAT_ROUNDED_2DP),
'percent' => new Field('cpu_percent', Field::FORMAT_PERCENT),
]);
'used' => new Field(
Format::ROUNDED_2P,
new SourceField(MetricKind::CPU_USED, Aggregation::AVG)
),
'limit' => new Field(
Format::ROUNDED_2P,
new SourceField(MetricKind::CPU_LIMIT, Aggregation::MAX)
),
'percent' => new Field(
Format::PERCENT,
new SourceFieldPercentage(
new SourceField(MetricKind::CPU_USED, Aggregation::AVG),
new SourceField(MetricKind::CPU_LIMIT, Aggregation::MAX)
)
),
], $environment);

/** @var \Platformsh\Cli\Service\Table $table */
$table = $this->getService('table');
if (!$table->formatIsMachineReadable()) {
/** @var PropertyFormatter $formatter */
$formatter = $this->getService('property_formatter');
$this->stdErr->writeln(\sprintf(
'Average CPU usage at <info>%s</info> intervals from <info>%s</info> to <info>%s</info>:',
(new Duration())->humanize($timeSpec->getInterval()),
$formatter->formatDate($timeSpec->getStartTime()),
$formatter->formatDate($timeSpec->getEndTime())
(new Duration())->humanize($values['_grain']),
$formatter->formatDate($values['_from']),
$formatter->formatDate($values['_to'])
));
}

$table->render($rows, $this->tableHeader, $this->defaultColumns);
$table->render($rows, self::$tableHeader, $this->defaultColumns);

return 0;
}
Expand Down
Loading
Loading