Dashboardy

Metrics::dashboard() naraz vyhodnotí zoznam zaregistrovaných metrík do jednej obálky s kľúčmi, so spoločným obdobím a voliteľne aj časovým pásmom — ideálne pre endpoint dashboardu:

use RoundlyConsulting\Metrics\Enums\Period;
use RoundlyConsulting\Metrics\Facades\Metrics;

return Metrics::dashboard(['users', 'revenue', 'churn'])
    ->range(Period::ThisMonth)
    ->timezone('America/New_York')   // optional shared timezone
    ->toArray();
// ['users' => [...envelope...], 'revenue' => [...], 'churn' => [...]]

// A custom window works the same way
Metrics::dashboard(['users', 'revenue'])
    ->range(Period::Custom, '2024-01-01 00:00:00', '2024-03-01 00:00:00')
    ->toArray();

• range(Period|string $range, ?string $customRangeStart = null, ?string $customRangeEnd = null) — použije sa na každú metriku; bez neho si každá metrika ponechá vlastné obdobie.
• timezone(?string $timezone) — vyhodnotí všetky metriky v spoločnom časovom pásme.
• toArray() — obálka s kľúčmi, jedna položka na kľúč, v zadanom poradí.

Vrátenie dashboardu

Dashboard implementuje Responsable, takže ho controller vráti priamo a dostane JSON obálku:

public function index()
{
    return Metrics::dashboard(['users', 'revenue', 'churn'])->range(request('period', 'TODAY'));
}

Každý kľúč musí byť zaregistrovaný — neznámy kľúč vyhodí UnknownMetricException pri vyhodnotení dashboardu.