Skip to content

Commit f6522d0

Browse files
committed
Update README.md
1 parent f6601b9 commit f6522d0

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Install the latest version with `composer require stackify/logger`
1515

1616
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:
1717

18-
#### ExecTransport
18+
### ExecTransport
1919
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):
2020

2121
```php
@@ -26,7 +26,7 @@ $transport = new ExecTransport('api_key');
2626
$logger = new Logger('application_name', 'environment_name', $transport);
2727
```
2828

29-
###### Optional Configuration
29+
#### Optional Configuration
3030

3131
<b>Proxy</b>
3232
- 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]>
@@ -40,7 +40,7 @@ $logger = new Logger('application_name', 'environment_name', $transport);
4040
$transport = new ExecTransport($apiKey, ['curlPath' => '/usr/bin/curl']);
4141
```
4242

43-
#### CurlTransport
43+
### CurlTransport
4444
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):
4545
```php
4646
use Stackify\Log\Transport\CurlTransport;
@@ -50,22 +50,22 @@ $transport = new CurlTransport('api_key');
5050
$logger = new Logger('application_name', 'environment_name', $transport);
5151
```
5252

53-
###### Optional Configuration
53+
#### Optional Configuration
5454

5555
<b>Proxy</b>
5656
- 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]>
5757
```php
5858
$transport = new CurlTransport($apiKey, ['proxy' => 'https://55.88.22.11:3128']);
5959
```
60-
#### AgentTransport
60+
### AgentTransport
6161

6262
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.
6363
```php
6464
use Stackify\Log\Standalone\Logger;
6565

6666
$logger = new Logger('appname.com');
6767
```
68-
###### Optional Configuration
68+
#### Optional Configuration
6969
- You will need to enable the TCP listener by checking a checkbox in "Server Settings" in Stackify for your server on the Servers Page. You can also change the default behavior for all your servers by going to the [Log Collectors Page](http://docs.stackify.com/m/7787/l/302705-log-collectors).
7070

7171
## Troubleshooting

0 commit comments

Comments
 (0)