Skip to content

Commit b54a5ce

Browse files
committed
Update README.md
1 parent 3052743 commit b54a5ce

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,11 @@ Start sending logs:
2323
// this should be executed only once in the app
2424
stackify.start({apiKey: '***', env: 'dev'});
2525
```
26-
The following options could be passed. 'apiKey' is the only one that required:
27-
* __apiKey:__ client license key
28-
* __env:__ environment name
29-
* __exitOnError:__ boolean flag indicating whether to shutdown the server after logging an uncaught exception, defaults to false
30-
* __proxy:__ proxy server if you want to send requests via proxy.
31-
* __debug:__ boolean flag, turning on the debug mode. When set to true the log file (`stackify-debug.log`) is created in the working directory and all of the library actions is being written to it, defaults to false.
32-
26+
The following options could be passed to the start method:
27+
* __apiKey: (Required)__ Stackify API key
28+
* __env:__ Environment name. If a Stackify agent is installed, this does not need to be set. If a Stackify agent is not installed, this should be set to the environment name.
29+
* __proxy:__ HTTP proxy
30+
* __debug:__ Enables internal debug logging for troubleshooting. Defaults to false.
3331

3432
*Notice:* stackify-logger sends synchronous requests if you call `process.exit()`. Sending via proxy wouldn't be possible in this case.
3533

@@ -92,7 +90,7 @@ If logging isn't working, enable internal debug logging for Stackify by setting
9290
stackify.start({apiKey: '***', env: 'dev', debug: true});
9391
```
9492

95-
You will see stackify-debug.log in your application's directory.
93+
You will see `stackify-debug.log` in your application's directory.
9694

9795
## License
9896

0 commit comments

Comments
 (0)