stackify-log-monolog

Monolog handler for sending log messages and exceptions to Stackify. Monolog >=1.1.0 <2.0.0 is supported.

For Monolog > 2.0.0, please use the 2.x branch

Errors and Logs Overview:

http://support.stackify.com/errors-and-logs-overview/

Smarter Errors & Logs for PHP:

http://stackify.com/smarter-errors-logs-php/

Sign Up for a Trial:

http://www.stackify.com/sign-up/

Installation

Install the latest version with composer require stackify/monolog "~1.0"

Or add dependency to composer.json file:

"stackify/monolog": "~1.0",

If you use Symfony Monolog Bundle it is best to configure the Stackify handler using the Symfony Dependency Injection configuration files. See examples below.

There are three different transport options that can be configured to send data to Stackify. Below will show how to implement the different transport options.

ExecTransport

ExecTransport does not require a Stackify agent to be installed because it sends data directly to Stackify services. It collects log entries in batches, calls curl using the exec function, and sends data to the background immediately [exec('curl ... &')]. This will affect the performance of your application minimally, but it requires permissions to call exec inside the PHP script and it may cause silent data loss in the event of any network issues. This transport method does not work on Windows. To configure ExecTransport you need to pass the environment name and API key (license key):

PHP:

use Stackify\Log\Transport\ExecTransport;
use Stackify\Log\Monolog\Handler as StackifyHandler;
    
$transport = new ExecTransport('api_key');
$handler = new StackifyHandler('application_name', 'environment_name', $transport);
$logger = new Logger('logger');
$logger->pushHandler($handler);

Symfony:

services:
    stackify_transport:
        class: "Stackify\\Log\\Transport\ExecTransport"
        arguments: ["api_key"]
    stackify_handler:
        class: "Stackify\\Log\\Monolog\\Handler"
        arguments: ["application_name", "environment_name", "@stackify_transport"]
monolog:
    handlers:
        stackify:
            type: service
            id: stackify_handler

Optional Configuration

Proxy

• ExecTransport supports data delivery through proxy. Specify proxy using libcurl format: <[protocol://][user:password@]proxyhost[:port]>

$transport = new ExecTransport($apiKey, ['proxy' => 'https://55.88.22.11:3128']);

Curl path

• It can be useful to specify curl destination path for ExecTransport. This option is set to 'curl' by default.

$transport = new ExecTransport($apiKey, ['curlPath' => '/usr/bin/curl']);

CurlTransport

CurlTransport does not require a Stackify agent to be installed and it also sends data directly to Stackify services. It collects log entries in a single batch and sends data using native PHP cURL functions. This way is a blocking one, so it should not be used on production environments. To configure CurlTransport you need to pass environment name and API key (license key):

PHP:

use Stackify\Log\Transport\CurlTransport;
use Stackify\Log\Monolog\Handler as StackifyHandler;
    
$transport = new CurlTransport('api_key');
$handler = new StackifyHandler('application_name', 'environment_name', $transport);
$logger = new Logger('logger');
$logger->pushHandler($handler);

Symfony:

services:
    stackify_transport:
        class: "Stackify\\Log\\Transport\CurlTransport"
        arguments: ["api_key"]
    stackify_handler:
        class: "Stackify\\Log\\Monolog\\Handler"
        arguments: ["application_name", "environment_name", "@stackify_transport"]
monolog:
    handlers:
        stackify:
            type: service
            id: stackify_handler

Optional Configuration

Proxy

• CurlTransport supports data delivery through proxy. Specify proxy using libcurl format: <[protocol://][user:password@]proxyhost[:port]>

$transport = new CurlTransport($apiKey, ['proxy' => 'https://55.88.22.11:3128']);

AgentTransport

AgentTransport does not require additional configuration in your PHP code because all data is passed to the Stackify agent. The agent must be installed on the same machine. Local TCP socket on port 10515 is used, so performance of your application is affected minimally.

PHP:

use Monolog\Logger;
use Stackify\Log\Monolog\Handler as StackifyHandler;

$handler = new StackifyHandler('application_name');
$logger = new Logger('logger');
$logger->pushHandler($handler);

Symfony:

services:
    stackify_handler:
        class: "Stackify\\Log\\Monolog\\Handler"
        arguments: ["application_name"]
monolog:
    handlers:
        stackify:
            type: service
            id: stackify_handler

You will need to enable the TCP listener by checking the "PHP App Logs (Agent Log Collector)" in the server settings page in Stackify. See Log Collectors Page for more details.

Notes

To get more error details pass Exception objects to the logger if available:

try {
    $db->connect();
catch (DbException $ex) {
    // you may use any key name
    $logger->addError('DB is not available', ['ex' => $ex]);
}

Troubleshooting

If transport does not work, try looking into vendor\stackify\logger\src\Stackify\debug\log.log file (if it is available for writing). Errors are also written to global PHP error_log. Note that ExecTransport does not produce any errors at all, but you can switch it to debug mode:

$transport = new ExecTransport($apiKey, ['debug' => true]);

License

Copyright 2015 Stackify, LLC.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.