@gus-eip/loggers 3.8.4 → 3.8.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +66 -66
- package/dist/cloudwatch.logger.js +2 -2
- package/dist/enum.d.ts +4 -0
- package/dist/enum.js +7 -3
- package/dist/module.js +2 -2
- package/package.json +78 -78
package/README.md
CHANGED
@@ -1,67 +1,67 @@
|
|
1
|
-
# @gus-eip/loggers
|
2
|
-
|
3
|
-
## Overview
|
4
|
-
|
5
|
-
`@gus-eip/loggers` is a package designed to provide logging functionality for your Node.js applications. It offers integration with various logging services, including CloudWatchLogger.
|
6
|
-
|
7
|
-
## Installation
|
8
|
-
|
9
|
-
You can install the package via npm:
|
10
|
-
|
11
|
-
```bash
|
12
|
-
npm install @gus-eip/loggers
|
13
|
-
```
|
14
|
-
|
15
|
-
## Usage
|
16
|
-
|
17
|
-
To use the logger module in your application, follow these steps:
|
18
|
-
|
19
|
-
1. Import `LoggerModule` from `@gus-eip/loggers` inside your module.
|
20
|
-
|
21
|
-
```javascript
|
22
|
-
import { LoggerModule } from '@gus-eip/loggers';
|
23
|
-
```
|
24
|
-
|
25
|
-
2. Configure `LoggerModule` in your module by calling the `forRoot` method.
|
26
|
-
|
27
|
-
```javascript
|
28
|
-
LoggerModule.forRoot({
|
29
|
-
region: process.env.REGION,
|
30
|
-
logGroupName: process.env.LOGGER_LOG_GROUP_NAME,
|
31
|
-
options: 'CloudWatchLogger',
|
32
|
-
}),
|
33
|
-
```
|
34
|
-
|
35
|
-
Ensure you provide the necessary environment variables (`REGION` and `LOGGER_LOG_GROUP_NAME`) for configuration.
|
36
|
-
|
37
|
-
## Configuration Options
|
38
|
-
|
39
|
-
- `region`: The AWS region where your CloudWatch logs are located.
|
40
|
-
- `logGroupName`: The name of the log group where logs will be sent.
|
41
|
-
- `options`: The options for the logger. Currently, only `'CloudWatchLogger'` is supported.
|
42
|
-
|
43
|
-
## Example
|
44
|
-
|
45
|
-
```javascript
|
46
|
-
import { Module } from '@nestjs/common';
|
47
|
-
import { LoggerModule } from '@gus-eip/loggers';
|
48
|
-
|
49
|
-
@Module({
|
50
|
-
imports: [
|
51
|
-
LoggerModule.forRoot({
|
52
|
-
region: process.env.REGION,
|
53
|
-
logGroupName: process.env.LOGGER_LOG_GROUP_NAME,
|
54
|
-
options: 'CloudWatchLogger',
|
55
|
-
}),
|
56
|
-
],
|
57
|
-
})
|
58
|
-
export class AppModule {}
|
59
|
-
```
|
60
|
-
|
61
|
-
## License
|
62
|
-
|
63
|
-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
64
|
-
|
65
|
-
---
|
66
|
-
|
1
|
+
# @gus-eip/loggers
|
2
|
+
|
3
|
+
## Overview
|
4
|
+
|
5
|
+
`@gus-eip/loggers` is a package designed to provide logging functionality for your Node.js applications. It offers integration with various logging services, including CloudWatchLogger.
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
You can install the package via npm:
|
10
|
+
|
11
|
+
```bash
|
12
|
+
npm install @gus-eip/loggers
|
13
|
+
```
|
14
|
+
|
15
|
+
## Usage
|
16
|
+
|
17
|
+
To use the logger module in your application, follow these steps:
|
18
|
+
|
19
|
+
1. Import `LoggerModule` from `@gus-eip/loggers` inside your module.
|
20
|
+
|
21
|
+
```javascript
|
22
|
+
import { LoggerModule } from '@gus-eip/loggers';
|
23
|
+
```
|
24
|
+
|
25
|
+
2. Configure `LoggerModule` in your module by calling the `forRoot` method.
|
26
|
+
|
27
|
+
```javascript
|
28
|
+
LoggerModule.forRoot({
|
29
|
+
region: process.env.REGION,
|
30
|
+
logGroupName: process.env.LOGGER_LOG_GROUP_NAME,
|
31
|
+
options: 'CloudWatchLogger',
|
32
|
+
}),
|
33
|
+
```
|
34
|
+
|
35
|
+
Ensure you provide the necessary environment variables (`REGION` and `LOGGER_LOG_GROUP_NAME`) for configuration.
|
36
|
+
|
37
|
+
## Configuration Options
|
38
|
+
|
39
|
+
- `region`: The AWS region where your CloudWatch logs are located.
|
40
|
+
- `logGroupName`: The name of the log group where logs will be sent.
|
41
|
+
- `options`: The options for the logger. Currently, only `'CloudWatchLogger'` is supported.
|
42
|
+
|
43
|
+
## Example
|
44
|
+
|
45
|
+
```javascript
|
46
|
+
import { Module } from '@nestjs/common';
|
47
|
+
import { LoggerModule } from '@gus-eip/loggers';
|
48
|
+
|
49
|
+
@Module({
|
50
|
+
imports: [
|
51
|
+
LoggerModule.forRoot({
|
52
|
+
region: process.env.REGION,
|
53
|
+
logGroupName: process.env.LOGGER_LOG_GROUP_NAME,
|
54
|
+
options: 'CloudWatchLogger',
|
55
|
+
}),
|
56
|
+
],
|
57
|
+
})
|
58
|
+
export class AppModule {}
|
59
|
+
```
|
60
|
+
|
61
|
+
## License
|
62
|
+
|
63
|
+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
64
|
+
|
65
|
+
---
|
66
|
+
|
67
67
|
Feel free to customize this README according to your specific package features, usage guidelines, and licensing terms.
|
@@ -285,8 +285,8 @@ let CloudWatchLoggerService = class CloudWatchLoggerService {
|
|
285
285
|
}
|
286
286
|
}
|
287
287
|
};
|
288
|
-
CloudWatchLoggerService =
|
288
|
+
exports.CloudWatchLoggerService = CloudWatchLoggerService;
|
289
|
+
exports.CloudWatchLoggerService = CloudWatchLoggerService = __decorate([
|
289
290
|
(0, common_1.Injectable)(),
|
290
291
|
__metadata("design:paramtypes", [String, String, String, Boolean])
|
291
292
|
], CloudWatchLoggerService);
|
292
|
-
exports.CloudWatchLoggerService = CloudWatchLoggerService;
|
package/dist/enum.d.ts
CHANGED
@@ -440,5 +440,9 @@ export declare class LoggerEnum {
|
|
440
440
|
MYUCW_GUS_SALESFORCE_INTEGRATION_HANDLER: string;
|
441
441
|
MYUCW_GUS_SALESFORCE_INTEGRATION_QUEUE: string;
|
442
442
|
OAP: string;
|
443
|
+
OCR_REQUEST_PROCESS_HANDLER: string;
|
444
|
+
OCR_RESPONSE_PROCESS_HANDLER: string;
|
445
|
+
OCR_INTEGRATION_SERVICE: string;
|
446
|
+
OCR_WORKFLOW: string;
|
443
447
|
};
|
444
448
|
}
|
package/dist/enum.js
CHANGED
@@ -450,11 +450,15 @@ let LoggerEnum = class LoggerEnum {
|
|
450
450
|
MY_UCW: 'MY_UCW',
|
451
451
|
MYUCW_GUS_SALESFORCE_INTEGRATION_HANDLER: 'MYUCW_GUS_SALESFORCE_INTEGRATION_HANDLER',
|
452
452
|
MYUCW_GUS_SALESFORCE_INTEGRATION_QUEUE: 'MYUCW_GUS_SALESFORCE_INTEGRATION_QUEUE',
|
453
|
-
OAP: 'OAP'
|
453
|
+
OAP: 'OAP',
|
454
|
+
OCR_REQUEST_PROCESS_HANDLER: 'OCR_REQUEST_PROCESS_HANDLER',
|
455
|
+
OCR_RESPONSE_PROCESS_HANDLER: 'OCR_RESPONSE_PROCESS_HANDLER',
|
456
|
+
OCR_INTEGRATION_SERVICE: 'OCR_INTEGRATION_SERVICE',
|
457
|
+
OCR_WORKFLOW: 'OCR_WORKFLOW'
|
454
458
|
};
|
455
459
|
}
|
456
460
|
};
|
457
|
-
LoggerEnum =
|
461
|
+
exports.LoggerEnum = LoggerEnum;
|
462
|
+
exports.LoggerEnum = LoggerEnum = __decorate([
|
458
463
|
(0, common_1.Injectable)()
|
459
464
|
], LoggerEnum);
|
460
|
-
exports.LoggerEnum = LoggerEnum;
|
package/dist/module.js
CHANGED
@@ -28,7 +28,7 @@ let LoggerModule = LoggerModule_1 = class LoggerModule {
|
|
28
28
|
};
|
29
29
|
}
|
30
30
|
};
|
31
|
-
LoggerModule =
|
31
|
+
exports.LoggerModule = LoggerModule;
|
32
|
+
exports.LoggerModule = LoggerModule = LoggerModule_1 = __decorate([
|
32
33
|
(0, common_1.Module)({})
|
33
34
|
], LoggerModule);
|
34
|
-
exports.LoggerModule = LoggerModule;
|
package/package.json
CHANGED
@@ -1,78 +1,78 @@
|
|
1
|
-
{
|
2
|
-
"name": "@gus-eip/loggers",
|
3
|
-
"version": "3.8.
|
4
|
-
"description": "@gus-eip/loggers is a package designed to provide logging functionality for your Node.js applications.",
|
5
|
-
"author": "gus",
|
6
|
-
"readmeFilename": "README.md",
|
7
|
-
"main": "dist/index.js",
|
8
|
-
"files": [
|
9
|
-
"dist/**/*",
|
10
|
-
"*.md"
|
11
|
-
],
|
12
|
-
"scripts": {
|
13
|
-
"start:dev": "tsc -w",
|
14
|
-
"build": "tsc",
|
15
|
-
"prepare": "npm run build",
|
16
|
-
"format": "prettier --write \"src/**/*.ts\"",
|
17
|
-
"lint": "tslint -p tsconfig.json -c tslint.json",
|
18
|
-
"test": "node --experimental-vm-modules ./node_modules/.bin/jest",
|
19
|
-
"test:watch": "jest --watch",
|
20
|
-
"test:cov": "jest --coverage",
|
21
|
-
"test:e2e": "jest --config ./test/jest-e2e.json"
|
22
|
-
},
|
23
|
-
"keywords": [
|
24
|
-
"nestjs",
|
25
|
-
"nodejs",
|
26
|
-
"javascript",
|
27
|
-
"typescript",
|
28
|
-
"eip-loggers"
|
29
|
-
],
|
30
|
-
"publishConfig": {
|
31
|
-
"access": "public"
|
32
|
-
},
|
33
|
-
"dependencies": {
|
34
|
-
"aws-sdk": "^2.1590.0",
|
35
|
-
"axios": "^1.7.4"
|
36
|
-
},
|
37
|
-
"devDependencies": {
|
38
|
-
"@nestjs/common": "^10.0.2",
|
39
|
-
"@nestjs/core": "^10.0.2",
|
40
|
-
"@nestjs/platform-express": "^10.0.2",
|
41
|
-
"@nestjs/testing": "10.0.2",
|
42
|
-
"@types/express": "4.17.17",
|
43
|
-
"@types/jest": "29.5.2",
|
44
|
-
"@types/lodash": "^4.17.7",
|
45
|
-
"@types/node": "20.3.1",
|
46
|
-
"@types/supertest": "2.0.12",
|
47
|
-
"@typescript-eslint/eslint-plugin": "^5.60.0",
|
48
|
-
"@typescript-eslint/parser": "^5.60.0",
|
49
|
-
"eslint": "^8.43.0",
|
50
|
-
"eslint-config-prettier": "^8.8.0",
|
51
|
-
"eslint-plugin-prettier": "^4.2.1",
|
52
|
-
"jest": "29.5.0",
|
53
|
-
"prettier": "2.8.8",
|
54
|
-
"reflect-metadata": "^0.1.13",
|
55
|
-
"rxjs": "^7.8.1",
|
56
|
-
"supertest": "6.3.3",
|
57
|
-
"ts-jest": "29.1.0",
|
58
|
-
"ts-node": "10.9.1",
|
59
|
-
"tsc-watch": "6.0.4",
|
60
|
-
"tsconfig-paths": "4.2.0",
|
61
|
-
"tslint": "5.20.1",
|
62
|
-
"typescript": "^5.5.4"
|
63
|
-
},
|
64
|
-
"jest": {
|
65
|
-
"moduleFileExtensions": [
|
66
|
-
"js",
|
67
|
-
"json",
|
68
|
-
"ts"
|
69
|
-
],
|
70
|
-
"rootDir": "src",
|
71
|
-
"testRegex": ".spec.ts$",
|
72
|
-
"transform": {
|
73
|
-
"^.+\\.(t|j)s$": "ts-jest"
|
74
|
-
},
|
75
|
-
"coverageDirectory": "../coverage",
|
76
|
-
"testEnvironment": "node"
|
77
|
-
}
|
78
|
-
}
|
1
|
+
{
|
2
|
+
"name": "@gus-eip/loggers",
|
3
|
+
"version": "3.8.5",
|
4
|
+
"description": "@gus-eip/loggers is a package designed to provide logging functionality for your Node.js applications.",
|
5
|
+
"author": "gus",
|
6
|
+
"readmeFilename": "README.md",
|
7
|
+
"main": "dist/index.js",
|
8
|
+
"files": [
|
9
|
+
"dist/**/*",
|
10
|
+
"*.md"
|
11
|
+
],
|
12
|
+
"scripts": {
|
13
|
+
"start:dev": "tsc -w",
|
14
|
+
"build": "tsc",
|
15
|
+
"prepare": "npm run build",
|
16
|
+
"format": "prettier --write \"src/**/*.ts\"",
|
17
|
+
"lint": "tslint -p tsconfig.json -c tslint.json",
|
18
|
+
"test": "node --experimental-vm-modules ./node_modules/.bin/jest",
|
19
|
+
"test:watch": "jest --watch",
|
20
|
+
"test:cov": "jest --coverage",
|
21
|
+
"test:e2e": "jest --config ./test/jest-e2e.json"
|
22
|
+
},
|
23
|
+
"keywords": [
|
24
|
+
"nestjs",
|
25
|
+
"nodejs",
|
26
|
+
"javascript",
|
27
|
+
"typescript",
|
28
|
+
"eip-loggers"
|
29
|
+
],
|
30
|
+
"publishConfig": {
|
31
|
+
"access": "public"
|
32
|
+
},
|
33
|
+
"dependencies": {
|
34
|
+
"aws-sdk": "^2.1590.0",
|
35
|
+
"axios": "^1.7.4"
|
36
|
+
},
|
37
|
+
"devDependencies": {
|
38
|
+
"@nestjs/common": "^10.0.2",
|
39
|
+
"@nestjs/core": "^10.0.2",
|
40
|
+
"@nestjs/platform-express": "^10.0.2",
|
41
|
+
"@nestjs/testing": "10.0.2",
|
42
|
+
"@types/express": "4.17.17",
|
43
|
+
"@types/jest": "29.5.2",
|
44
|
+
"@types/lodash": "^4.17.7",
|
45
|
+
"@types/node": "20.3.1",
|
46
|
+
"@types/supertest": "2.0.12",
|
47
|
+
"@typescript-eslint/eslint-plugin": "^5.60.0",
|
48
|
+
"@typescript-eslint/parser": "^5.60.0",
|
49
|
+
"eslint": "^8.43.0",
|
50
|
+
"eslint-config-prettier": "^8.8.0",
|
51
|
+
"eslint-plugin-prettier": "^4.2.1",
|
52
|
+
"jest": "29.5.0",
|
53
|
+
"prettier": "2.8.8",
|
54
|
+
"reflect-metadata": "^0.1.13",
|
55
|
+
"rxjs": "^7.8.1",
|
56
|
+
"supertest": "6.3.3",
|
57
|
+
"ts-jest": "29.1.0",
|
58
|
+
"ts-node": "10.9.1",
|
59
|
+
"tsc-watch": "6.0.4",
|
60
|
+
"tsconfig-paths": "4.2.0",
|
61
|
+
"tslint": "5.20.1",
|
62
|
+
"typescript": "^5.5.4"
|
63
|
+
},
|
64
|
+
"jest": {
|
65
|
+
"moduleFileExtensions": [
|
66
|
+
"js",
|
67
|
+
"json",
|
68
|
+
"ts"
|
69
|
+
],
|
70
|
+
"rootDir": "src",
|
71
|
+
"testRegex": ".spec.ts$",
|
72
|
+
"transform": {
|
73
|
+
"^.+\\.(t|j)s$": "ts-jest"
|
74
|
+
},
|
75
|
+
"coverageDirectory": "../coverage",
|
76
|
+
"testEnvironment": "node"
|
77
|
+
}
|
78
|
+
}
|