alishojaeiir/yii2-elastic-apm

Elastic Agent for Yii2 Framework

1.1.2 2026-07-19 09:26 UTC

Requires

• php: >=7.1.0
• ivoglent/elastic-apm-agent-v2: 1.0.1
• yiisoft/yii2: ~2.0.14

BSD-3-Clause

• Ali Shojaei

Published on Packagist.org on 2026-07-20 09:46 UTC

README

Elastic Agent for Yii2 Framework

Installation

Let install this module via composer

composer require --prefer-dist --profile -vvv alishojaeiir/yii2-elastic-apm

Configuration

'apm' => [
    'class' => 'ivoglent\yii2\apm\Module',
    'configs' => [
        'agent' => [
            'serverUrl' => 'localhost:8200',
            'name' => 'Service name',
            'token' => APM_TOKEN,
            'environment' => 'production',
        ],
        // top-level, sibling of 'agent' — NOT nested inside it
        'client_setting' => [
            'timeout' => 1,          // total request timeout, seconds
            'connect_timeout' => 1,  // TCP connect timeout, seconds
        ],
        'skipExceptions' => [ /* ... */ ],
        'skipCommands' => [ /* ... */ ],
    ],
    'enabled' => true,
],

To enable database monitoring, let config the DB command like :

'components' => [
    'db' => [
        'class' => 'yii\db\Connection',
        'dsn' => '',
        'username' => '',
        'password' => '',
        'charset' => 'utf8mb4',
        'commandClass' => APM_ENABLED ? 'ivoglent\yii2\apm\components\db\mysql\Command' : '\yii\db\Command',
    ]
]

NOTE Rememeber add apm module to bootstrap section:

'bootstrap' => ['log', 'apm'],

Transaction

This module will auto start new transaction after BEFORE_REQUEDT event. But you can manual start new transaction on Console application like consumer ..etc

$transactionId = Uuid::uuid4()->toString();
$txtName = sprintf('consumer.%s', str_replace('-', '.', $queue->getName()));
Yii::$app->getModule('apm')->getAgent()->startTransaction($txtName, 'consumer', App::$app->getRequestId());
Yii::$app->getModule('apm')->getAgent()->setTransactionId($transactionId);

and stop

Yii::$app->getModule('apm')->getAgent()->stopTransaction();

Trace

Start new span

$span = Yii::$app->getModule('apm')->getAgent()->startTrace('Process::'.$reflect->getShortName(), 'process');

and stop :

Yii::$app->getModule('apm')->getAgent()->stopTrace($span->getId());

Error / exception notify

try {

} catch (\Exception $throwable) { Yii::$app->getModule('apm')->getAgent()->notifyException($throwable); }