RT-1844 - adding in logServerVariables toggle (defaults to disabled)

Author: darinhoward

.gitignore

@@ -1,2 +1,3 @@
 vendor
 composer.lock
+.idea

README.md

@@ -66,18 +66,27 @@ monolog:
 
 #### Optional Configuration
 
-<b>Proxy</b>
+**Proxy**
 - ExecTransport supports data delivery through proxy. Specify proxy using [libcurl format](http://curl.haxx.se/libcurl/c/CURLOPT_PROXY.html): <[protocol://][user:password@]proxyhost[:port]>
 ```php
 $transport = new ExecTransport($apiKey, ['proxy' => 'https://55.88.22.11:3128']);
 ```
 
-<b>Curl path</b>
+**Curl path**
 - It can be useful to specify ```curl``` destination path for ExecTransport. This option is set to 'curl' by default.
 ```php
 $transport = new ExecTransport($apiKey, ['curlPath' => '/usr/bin/curl']);
 ```
 
+**Log Server Environment Variables**
+- Server environment variables can be added to error log message metadata. **Note:** This will log all 
+system environment variables; do not enable if sensitive information such as passwords or keys are stored this way.
+
+ ```php
+$handler = new StackifyHandler('application_name', 'environment_name', $transport, true); 
+```
+
+
 ### 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](http://php.net/manual/en/book.curl.php) 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):
@@ -111,12 +120,20 @@ monolog:
 
 #### Optional Configuration
 
-<b>Proxy</b>
+**Proxy**
 - CurlTransport supports data delivery through proxy. Specify proxy using [libcurl format](http://curl.haxx.se/libcurl/c/CURLOPT_PROXY.html): <[protocol://][user:password@]proxyhost[:port]>
 ```php
 $transport = new CurlTransport($apiKey, ['proxy' => 'https://55.88.22.11:3128']);
 ```
 
+**Log Server Environment Variables**
+- Server environment variables can be added to error log message metadata. **Note:** This will log all 
+system environment variables; do not enable if sensitive information such as passwords or keys are stored this way.
+
+ ```php
+$handler = new StackifyHandler('application_name', 'environment_name', $transport, true); 
+```
+
 ### AgentTransport
 
 AgentTransport does not require additional configuration in your PHP code because all data is passed to the [Stackify agent](https://stackify.screenstepslive.com/s/3095/m/7787/l/119709-installation-for-linux). 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.
@@ -126,7 +143,7 @@ PHP:
 use Monolog\Logger;
 use Stackify\Log\Monolog\Handler as StackifyHandler;
 
-$handler = new StackifyHandler('application_name');
+$handler = new StackifyHandler('application_name', 'environment_name');
 $logger = new Logger('logger');
 $logger->pushHandler($handler);
 ```
@@ -136,7 +153,7 @@ Symfony:
 services:
     stackify_handler:
         class: "Stackify\\Log\\Monolog\\Handler"
-        arguments: ["application_name"]
+        arguments: ["application_name", "environment_name"]
 monolog:
     handlers:
         stackify:
@@ -146,6 +163,16 @@ monolog:
 
 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](http://docs.stackify.com/m/7787/l/302705-log-collectors) for more details.
 
+#### Optional Settings
+
+**Log Server Environment Variables**
+- Server environment variables can be added to error log message metadata. **Note:** This will log all 
+system environment variables; do not enable if sensitive information such as passwords or keys are stored this way.
+
+ ```php
+$handler = new StackifyHandler('application_name', 'environment_name', null, true); 
+```
+
 ## Notes
 
 To get more error details pass Exception objects to the logger if available:
@@ -167,7 +194,7 @@ $transport = new ExecTransport($apiKey, ['debug' => true]);
 
 ## License
 
-Copyright 2015 Stackify, LLC.
+Copyright 2018 Stackify, LLC.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

composer.json

@@ -7,12 +7,14 @@
     "license": "Apache-2.0",
     "require": {
         "php": "^7.0",
-        "stackify/logger": "~1.0",
+        "stackify/logger": "~1.1",
         "monolog/monolog": "~2.0"
     },
     "autoload": {
         "psr-4": {
             "Stackify\\Log\\Monolog\\": "src/Stackify/Log/Monolog"
         }
-    }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
 }

src/Stackify/Log/Monolog/Handler.php

@@ -17,10 +17,10 @@ class Handler extends AbstractHandler
      */
     private $transport;
 
-    public function __construct($appName, $environmentName = null, TransportInterface $transport = null, $level = Logger::DEBUG, $bubble = true)
+    public function __construct($appName, $environmentName = null, TransportInterface $transport = null, $logServerVariables = false, $level = Logger::DEBUG, $bubble = true)
     {
         parent::__construct($level, $bubble);
-        $messageBuilder = new MessageBuilder('Stackify Monolog v.2.0', $appName, $environmentName);
+        $messageBuilder = new MessageBuilder('Stackify Monolog v.2.0', $appName, $environmentName, $logServerVariables);
         if (null === $transport) {
             $transport = new AgentTransport();
         }