Nadi monitoring SDK for CakePHP applications. Captures exceptions, slow queries, and HTTP errors for the Nadi monitoring platform.

• PHP 8.1+
• CakePHP 4.5+ or 5.x

composer require nadi-pro/nadi-cakephp

Load the plugin in your Application.php:

public function bootstrap(): void
{
    parent::bootstrap();
    $this->addPlugin(\Nadi\CakePHP\NadiPlugin::class);
}

Add the configuration to your config/app.php or load config/nadi.php:

Configure::load('nadi');

Set environment variables:

NADI_ENABLED=true
NADI_DRIVER=log
NADI_API_KEY=your-api-key
NADI_APP_KEY=your-app-key

cake nadi:install          # Install Nadi
cake nadi:test             # Test connectivity
cake nadi:verify           # Verify configuration
cake nadi:update-shipper   # Update shipper binary

For detailed documentation, see the docs directory:

• Getting Started - Installation and setup
• Architecture - System design and patterns
• Configuration - Drivers, sampling, and environment variables
• Monitoring - Exceptions, HTTP, and slow queries
• Advanced - OpenTelemetry and compatibility

Important: Nadi captures and transmits application error data including exception messages, stack traces, SQL queries, HTTP request details, and custom content. This data may contain Personally Identifiable Information (PII).

As the consumer, you are responsible for:

• Sanitizing or redacting PII from entry content
• Filtering sensitive HTTP headers (e.g., Authorization, Cookie) from captured data
• Ensuring compliance with your organization's data handling policies (GDPR, HIPAA, SOC2, etc.)
• Using HTTPS endpoints for all drivers in production environments

See SECURITY.md for vulnerability reporting and security considerations.

MIT