Brandon Nicholls

RESCOI-873: Documents changes to logging configuration

Showing 1 changed file with 17 additions and 0 deletions
......@@ -135,6 +135,23 @@ System configuration for COI is done with environment variables. Environment var
>: the log level to use. 0 (Info), 1 (Warn), 2 (Error)
>*Default*: 2
>
>**DEBUG**:
The components to generate logs for. Uses the [debug](https://www.npmjs.com/package/debug) package. `coi` is the app namespace, each module (i.e. a `.js` file) has a sub namespace, and db modules only have a namespace for each function.
>
*Note: Error level logs will always be displayed independent of this variable.*
>
*Examples*:
>
`coi:*` - Display all logs generated for the given LOG_LEVEL
>
`coi:ProjectDB:*` - Only display logs generated in the project-db.js module
>
`coi:ProjectDB:insertProject` - Only display logs generated by the insertProject function in the project-db.js module
>
`coi:ProjectDB:insertProject,coi:DisclosureDB:*` - Only display logs from the disclosure-db.js module or the insertProject function
>
*Default:* `coi:*`
>
>**TRUST_PROXY**
>: The value to pass to app.set('trust_proxy', <YOUR STRING HERE>)
>*Default*: *None*
......