Skip to content

Commit aef2493

Browse files
committed
Update README.md
1 parent 628bada commit aef2493

1 file changed

Lines changed: 15 additions & 13 deletions

File tree

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ There are three different transport options that can be configured to send data
1717

1818
### <a name="transport"></a>Transport options:
1919

20-
21-
- <b>ExecTransport</b> does not require Stackify agent to be installed because it sends data directly to Stackify services. It collects log entries in a single batch, calls curl using the ```exec``` function, and sends it 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):
20+
###ExecTransport:
21+
ExecTransport does not require a Stackify agent to be installed because it sends data directly to Stackify services. It collects log entries in a single batch, calls curl using the ```exec``` function, and sends it 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):
2222
```php
2323
use Stackify\Log\Transport\ExecTransport;
2424
use Stackify\Log\Monolog\Handler as StackifyHandler;
@@ -36,18 +36,20 @@ There are three different transport options that can be configured to send data
3636
class: "Stackify\\Log\\Monolog\\Handler"
3737
arguments: ["application_name", "environment_name", "@stackify_transport"]
3838
```
39-
###Configuration:
40-
####Proxy
41-
ExecTransport and CurlTransport support data delivery through proxy. Specify proxy using [libcurl format](http://curl.haxx.se/libcurl/c/CURLOPT_PROXY.html): <[protocol://][user:password@]proxyhost[:port]>
39+
####Configuration:
40+
<b>Proxy</b>
41+
- ExecTransport and CurlTransport support data delivery through proxy. Specify proxy using [libcurl format](http://curl.haxx.se/libcurl/c/CURLOPT_PROXY.html): <[protocol://][user:password@]proxyhost[:port]>
4242
```php
4343
$transport = new ExecTransport($apiKey, ['proxy' => 'https://55.88.22.11:3128']);
4444
```
45-
####Curl path
46-
It can be useful to specify ```curl``` destination path for ExecTransport. This option is set to 'curl' by default.
45+
46+
<b>Curl path</b>
47+
- It can be useful to specify ```curl``` destination path for ExecTransport. This option is set to 'curl' by default.
4748
```php
4849
$transport = new ExecTransport($apiKey, ['curlPath' => '/usr/bin/curl']);
4950
```
50-
- <b>CurlTransport</b> 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):
51+
###CurlTransport
52+
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):
5153
```php
5254
use Stackify\Log\Transport\CurlTransport;
5355
use Stackify\Log\Monolog\Handler as StackifyHandler;
@@ -65,14 +67,14 @@ $transport = new ExecTransport($apiKey, ['curlPath' => '/usr/bin/curl']);
6567
class: "Stackify\\Log\\Monolog\\Handler"
6668
arguments: ["application_name", "environment_name", "@stackify_transport"]
6769
```
68-
###Configuration:
69-
####Proxy
70-
ExecTransport and CurlTransport support data delivery through proxy. Specify proxy using [libcurl format](http://curl.haxx.se/libcurl/c/CURLOPT_PROXY.html): <[protocol://][user:password@]proxyhost[:port]>
70+
####Configuration:
71+
<b>Proxy</b>
72+
- ExecTransport and CurlTransport support data delivery through proxy. Specify proxy using [libcurl format](http://curl.haxx.se/libcurl/c/CURLOPT_PROXY.html): <[protocol://][user:password@]proxyhost[:port]>
7173
```php
7274
$transport = new CurlTransport($apiKey, ['proxy' => 'https://55.88.22.11:3128']);
7375
```
74-
75-
- <b>AgentTransport</b> does not require additional configuration on PHP side because all data is passed to the [Stackify agent](https://stackify.screenstepslive.com/s/3095/m/7787/l/119709-installation-for-linux), which must be installed on the same machine. Local TCP socket is used, so performance of your application is affected minimally.
76+
###AgentTransport
77+
AgentTransport does not require additional configuration on PHP side because all data is passed to the [Stackify agent](https://stackify.screenstepslive.com/s/3095/m/7787/l/119709-installation-for-linux), which must be installed on the same machine. Local TCP socket is used, so performance of your application is affected minimally.
7678

7779
## Troubleshooting
7880
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](http://php.net/manual/en/errorfunc.configuration.php#ini.error-log).

0 commit comments

Comments
 (0)