https://github.com/megapixel99/environment-based-logging
This is a npm module which manages logging between multiple environments.
https://github.com/megapixel99/environment-based-logging
env environment environment-variables logging nodejs npm
Last synced: 3 months ago
JSON representation
This is a npm module which manages logging between multiple environments.
- Host: GitHub
- URL: https://github.com/megapixel99/environment-based-logging
- Owner: Megapixel99
- License: mit
- Created: 2019-08-31T21:43:58.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-01T04:58:31.000Z (almost 7 years ago)
- Last Synced: 2025-03-07T00:28:32.140Z (over 1 year ago)
- Topics: env, environment, environment-variables, logging, nodejs, npm
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/environment-based-logging
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Environment Based Logging
This is a Logging library designed to be used with an application which has multiple environments.
It allows the user to customize their logs for different environments.
## Installation
npm i environment-based-logging
## Setup
1. Create an environment file with the variable: LOG_LEVEL
2. Use the following javascript in you file:
```
const envLogger = require('environment-based-logging');
var logger_with_lower_levels = new envLogger({
env_file: "path to environment file relative to your file (i.e. ../../environments/dev.env)",
log_levels: {
test: 0,
dev: 1,
patch: 2
},
log_lower_levels: true
});
```
3. Set LOG_LEVEL in your environment file to one of your log_levels (i.e. LOG_LEVEL=dev)
### Parameters
| Name | Type | Description | Default |
|:-----|:----:|:------------|:-------:|
| env_file | _string_ | The path to the environment file | _(required)_ |
| log_levels | _string_ | The names of the levels and their level in regards to development, with production being the highest | _(required)_ |
| log_lower_levels | _boolean_ | Determines whether lower levels should be logged | _false_ |
## Usage
javascript:
```
const envLogger = require('environment-based-logging');
var logger_with_lower_levels = new envLogger({
env_file: "../.env",
log_levels: {
test: 0,
dev: 1,
patch: 2
},
log_lower_levels: true
});
//Outputs all of the logs since log_lower_levels is true
logger_with_lower_levels.print("test with lower level, level test ", "test");
logger_with_lower_levels.print("test with lower level, level dev ", "dev");
logger_with_lower_levels.print("test with lower level, level patch ", "patch");
var logger_without_lower_levels = new envLogger({
env_file: "../.env",
log_levels: {
test: 0,
dev: 1,
patch: 2
},
log_lower_levels: false
});
//Only outputs some of the logs depending on the since log_lower_levels is false
logger_without_lower_levels.print("test without lower level, level test ", "test");
logger_without_lower_levels.print("test without lower level, level dev ", "dev");
logger_without_lower_levels.print("test without lower level, level patch ", "patch");
```
## Example
For the usage case above, `LOG_LEVEL=dev` in the environment file will output:
```
test with lower level, level test
test with lower level, level dev
test without lower level, level dev
```