README

CodeIgniter adapter for the Bugban error & monitoring SDK. Works with CodeIgniter 3 and CodeIgniter 4, and even in composer-free legacy projects. PHP 7.0+.

Install (Composer)

composer require bugban/codeigniter

Set your credentials as environment variables (in .env or the server env):

BUGBAN_API_KEY=bb_xxxxxxxxxxxxxxxx
BUGBAN_HOST=https://bugban.online

CodeIgniter 3

Option A — hooks (recommended)

Enable hooks in application/config/config.php:
```
$config['enable_hooks'] = TRUE;
```

$hook['pre_system'] = array(
    'class'    => 'Bugban\\CodeIgniter\\Hooks\\BugbanHook',
    'function' => '__construct',
    'filename' => '', // loaded via Composer autoloader
    'filepath' => '',
);

The hook reads BUGBAN_API_KEY and BUGBAN_HOST from the environment and boots the SDK (init + register global handlers) automatically.

Option B — composer-free (legacy)

If you cannot run Composer, require the core SDK's manual autoloader directly in index.php (before CodeIgniter bootstraps):

require __DIR__ . '/path/to/bugban-php-sdk/autoload.php';

\Bugban\Sdk\Bugban::init([
    'api_key' => getenv('BUGBAN_API_KEY') ?: 'bb_xxxxxxxxxxxxxxxx',
    'host'    => 'https://bugban.online',
]);
\Bugban\Sdk\Bugban::registerHandlers();

⚠️ CI3 caveat: CodeIgniter 3 calls set_exception_handler() during its own bootstrap, which replaces the handler you register in index.php. So the index.php approach alone captures manual Bugban::capture($e) calls but not uncaught exceptions. For automatic capture of uncaught exceptions in CI3, use Option A (the pre_system hook) — it runs after CI3 installs its handler and re-registers Bugban's, so Bugban wins.

CodeIgniter 4

Events::on('pre_system', static function () {
    \Bugban\CodeIgniter\BugbanCI::boot([
        'api_key' => getenv('BUGBAN_API_KEY'),
        'host'    => getenv('BUGBAN_HOST'),
    ]);
});

BugbanCI::boot() initializes the SDK and registers global error, exception and shutdown handlers.

Slow query monitoring

Queries slower than slow_query_ms (default 1000 ms, pass it in the boot() config array) are batched and sent non-blocking at shutdown. Disable with 'capture_queries' => false.

CodeIgniter 4 — automatic: boot() subscribes to the framework's DBQuery event. Works with any DB driver (MySQLi, Postgre, SQLite3, ...).
CodeIgniter 3 — no query event exists, so call this once late in the request (e.g. a post_system hook). It reads the driver's built-in query log (save_queries must stay enabled — it is by default):
```
\Bugban\CodeIgniter\BugbanCI::flushCi3Queries();
```
Or record individual queries manually from anywhere:
```
\Bugban\Sdk\Bugban::recordQuery($sql, $durationMs, ['connection' => 'mysqli']);
```

Manual capture

Anywhere in your app:

use Bugban\CodeIgniter\BugbanCI;

try {
    // ...
} catch (\Throwable $e) {
    BugbanCI::capture($e);
}

Or via the core facade:

\Bugban\Sdk\Bugban::captureMessage('Payment gateway timeout', 'error');

Log capture (errors logged but not thrown)

Errors you catch and log without re-throwing only reach the log file. Enable capture_logs and forward them to Bugban with recordLog():

\Bugban\Sdk\Bugban::init([
    'api_key'      => 'bb_xxxxxxxx',
    'host'         => 'https://bugban.online',
    'capture_logs' => true,
    'log_level'    => 'error', // minimum PSR level forwarded
]);

// Anywhere you'd log an error:
\Bugban\Sdk\Bugban::recordLog('error', 'Payment gateway timeout', ['order_id' => 123]);

// Caught-and-logged throwable (attach it for a full stacktrace):
try { risky(); } catch (\Throwable $e) {
    \Bugban\Sdk\Bugban::recordLog('error', $e->getMessage(), ['exception' => $e]);
}

Records below log_level are dropped; context is redacted; recordLog() never throws.

bugban / codeigniter

Maintainers

Package info

Statistics

Security