README

Пакет для сбора и анализа метрик проектов

Метрики

Список возможных событий

• PROCESS_START - начало работы скрипта
• ROUTE_START - вызов целевого метода
• ROUTE_FINISH_SUCCESS - нормальное окончание работы скрипта
• ROUTE_FINISH_EXCEPTION - окончаний работы скрипта по эксепшену
• DB_REQUEST - запрос БД
• DB_RESPONSE - ответ БД
• API_REQUEST - запрос внешних API
• API_RESPONSE - ответ внешних API
• CUSTOM_METRIC - событие для подсчета кастомной метрики

Базовые метрики

• requests_hit_count - общее количество запросов
• requests_start_count - количество вызовов целевого метода
• requests_finish_success_count - количество нормальных окончаний работы скрипта
• requests_finish_exception_count - количество окончаний работы скрипта по эксепшену
• system_cpu_usage - процент загруки процессора
• system_load_average - среднее значение загруженности системы
• system_memory_usage - рамер используемой памяти
• system_memory_max - максимальный размер памяти
• logging_max_memory - максимальный расход памяти при формирования лога
• logging_execution_time - время формирования лога
• logging_tags_count - общее количество тегов

Метрики для нормальных окончаний работы скрипта

• success_max_memory - максимальный расход памяти
• success_execution_time - время исполнения скрипта
• success_db_requests - количество запросов к БД
• success_db_requests_time - общее время исполнения запросов БД
• success_db_requests_time_max - максимальное время исполнения среди запросов БД
• success_api_requests - количество запросов к внешним API
• success_api_requests_time - общее время ожидания внешних API
• success_api_requests_time_max - максимальное время ожидания внешних API

Метрики для окончаний работы скрипта по эксепшену

• exception_max_memory - максимальный расход памяти
• exception_execution_time - время исполнения скрипта
• exception_db_requests - количество запросов к БД
• exception_db_requests_time - общее время исполнения запросов БД
• exception_db_requests_time_max - максимальное время исполнения среди запросов БД
• exception_api_requests - количество запросов к внешним API
• exception_api_requests_time - общее время ожидания внешних API
• exception_api_requests_time_max - максимальное время ожидания внешних API

Кастомные метрики

• test_custom_metric - тестовая custom метрика

Рассчет метрик

• requests_hit_count = count(PROCESS_START)
• requests_start_count = count(ROUTE_START)
• requests_finish_success_count = count(ROUTE_FINISH_SUCCESS)
• requests_finish_exception_count = count(ROUTE_FINISH_EXCEPTION)
• max_memory = max(memory_usage_per_each_event)
• execution_time = time(ROUTE_FINISH_SUCCESS - time(PROCESS_START)
• db_requests = count(DB_REQUEST)
• db_requests_time = time(DB_RESPONSE) - time(DB_REQUEST)
• db_requests_time_max = max(time(DB_RESPONSE) - time(DB_REQUEST))
• api_requests = count(API_REQUEST)
• api_requests_time = time(API_RESPONSE) - time(API_REQUEST)
• api_requests_time_max = max(time(API_RESPONSE) - time(API_REQUEST))

Использование в коде

1. Установка пакета

   composer require falc0shka/php-metrics
   

2. Инициализация пакета

   use Falc0shka\PhpMetrics\PhpMetrics;
   
   $phpMetrics = PhpMetrics::getInstance();

3. Настройка

   $phpMetrics->setTag($module . '::' . $action)           // Установить tag для текущего запроса
       ->setProject('test_project')                        // Установить название проекта
       ->setLogMaxAge(30)                                  // Установить срок жизни лог файлов
       ->setLogPath(dirname(__FILE__) . '/log');           // Установить путь для сохранения файлов (для файловых логгеров)

4. Отключение

   $phpMetrics->disableMetrics();

5. Вызов событий

   try {
   
       // Вызов события начала скрипта
       $phpMetrics->dispatchEvent('ROUTE_START');
       
       // ...some logic...
       $out = call_user_func([$controller, $action]);
       $oResponce->output($out);
       
       // Вызов события нормального окончания скрипта
       $phpMetrics->dispatchEvent('ROUTE_FINISH_SUCCESS');
       
   } catch (Exception $e){
   
       // Вызов события окончания скрипта по эксепшену
       $phpMetrics->dispatchEvent('ROUTE_FINISH_EXCEPTION');
       
       // ...some exception logic...
       if(method_exists($e, 'outputError')){
           $e->outputError();
       } else {
           die($e->getMessage());
       };
      
   }

6. Кастомные метрики

   Для подсчета кастомных необходимо вызвать событие CUSTOM_METRIC, и допонительное передать массив с названием метрики, тегом и значением

   $phpMetrics->dispatchEvent('CUSTOM_METRIC', [
     'metric' => 'test_custom_metric_count',
     'tag' => 'CUSTOM_METRIC_TAG',
     'value' => 1,
   ]);

7. Включение системных метрик

   Для включения процесса сбора системных метрик

   $phpMetrics->enableSystemMetrics();

8. Включение общих метрик со всех проектов

   Для включения процесса сбора общих метрик со всех проектов

   $phpMetrics->enableAllProjectsMetrics();