@gus-eip/loggers 4.1.3 → 4.1.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 +81 -81
- package/dist/enum.d.ts +12 -0
- package/dist/enum.js +13 -1
- package/package.json +79 -79
package/README.md
CHANGED
|
@@ -1,82 +1,82 @@
|
|
|
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
|
-
```
|
|
62
|
-
This repository requires AWS SSM Parameter Store access to retrieve the SQS URL dynamically. Ensure that the application has permission to read LOGGER_SQS_URL.
|
|
63
|
-
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
## License
|
|
67
|
-
|
|
68
|
-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
69
|
-
|
|
70
|
-
---
|
|
71
|
-
|
|
72
|
-
## OAP-EIP LOGGER
|
|
73
|
-
|
|
74
|
-
Whenever a new use case is added in the enum.ts file, make sure to also:
|
|
75
|
-
|
|
76
|
-
1. Add a user-friendly label for it in usecase-mapping.ts.
|
|
77
|
-
|
|
78
|
-
2. Add a new entry in source-destination-mapping.ts with the correct usecase, brand, source, and destination.
|
|
79
|
-
|
|
80
|
-
3. After publishing the updated package, update the dependency in the gus-eip-analytics repository to reflect the latest version.
|
|
81
|
-
|
|
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
|
+
```
|
|
62
|
+
This repository requires AWS SSM Parameter Store access to retrieve the SQS URL dynamically. Ensure that the application has permission to read LOGGER_SQS_URL.
|
|
63
|
+
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## License
|
|
67
|
+
|
|
68
|
+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## OAP-EIP LOGGER
|
|
73
|
+
|
|
74
|
+
Whenever a new use case is added in the enum.ts file, make sure to also:
|
|
75
|
+
|
|
76
|
+
1. Add a user-friendly label for it in usecase-mapping.ts.
|
|
77
|
+
|
|
78
|
+
2. Add a new entry in source-destination-mapping.ts with the correct usecase, brand, source, and destination.
|
|
79
|
+
|
|
80
|
+
3. After publishing the updated package, update the dependency in the gus-eip-analytics repository to reflect the latest version.
|
|
81
|
+
|
|
82
82
|
Feel free to customize this README according to your specific package features, usage guidelines, and licensing terms.
|
package/dist/enum.d.ts
CHANGED
|
@@ -445,6 +445,15 @@ export declare class LoggerEnum {
|
|
|
445
445
|
INVALID_PLATFORM_EVENT: string;
|
|
446
446
|
INVALID_EVENT_STRUCTURE: string;
|
|
447
447
|
VALIDATION_FAILED: string;
|
|
448
|
+
CREATE_TASK_INITIATED: string;
|
|
449
|
+
CREATE_TASK_COMPLETED: string;
|
|
450
|
+
CREATE_TASK_FAILED: string;
|
|
451
|
+
CREATE_BULK_TASKS_INITIATED: string;
|
|
452
|
+
CREATE_BULK_TASKS_COMPLETED: string;
|
|
453
|
+
CREATE_BULK_TASKS_FAILED: string;
|
|
454
|
+
DOCUMENT_SYNC_INITIATED: string;
|
|
455
|
+
DOCUMENT_SYNC_COMPLETED: string;
|
|
456
|
+
DOCUMENT_SYNC_FAILED: string;
|
|
448
457
|
};
|
|
449
458
|
UseCase: {
|
|
450
459
|
PROGRAM_INFO: string;
|
|
@@ -636,5 +645,8 @@ export declare class LoggerEnum {
|
|
|
636
645
|
UNFC_ELLUCIAN: string;
|
|
637
646
|
ARDEN_GUS_SALESFORCE_INTEGRATION_HANDLER: string;
|
|
638
647
|
ARDEN_GUS_SALESFORCE_INTEGRATION_QUEUE: string;
|
|
648
|
+
GUS_SF_EVENTS_INBOUND_QUEUE: string;
|
|
649
|
+
GUS_EIP_INBOUND_INTEGRATION_HANDLER: string;
|
|
650
|
+
GUS_EIP_EVENTS_INBOUND_QUEUE: string;
|
|
639
651
|
};
|
|
640
652
|
}
|
package/dist/enum.js
CHANGED
|
@@ -456,6 +456,15 @@ let LoggerEnum = class LoggerEnum {
|
|
|
456
456
|
INVALID_PLATFORM_EVENT: 'INVALID_PLATFORM_EVENT',
|
|
457
457
|
INVALID_EVENT_STRUCTURE: 'INVALID_EVENT_STRUCTURE',
|
|
458
458
|
VALIDATION_FAILED: 'VALIDATION_FAILED',
|
|
459
|
+
CREATE_TASK_INITIATED: 'CREATE_TASK_INITIATED',
|
|
460
|
+
CREATE_TASK_COMPLETED: 'CREATE_TASK_COMPLETED',
|
|
461
|
+
CREATE_TASK_FAILED: 'CREATE_TASK_FAILED',
|
|
462
|
+
CREATE_BULK_TASKS_INITIATED: 'CREATE_BULK_TASKS_INITIATED',
|
|
463
|
+
CREATE_BULK_TASKS_COMPLETED: 'CREATE_BULK_TASKS_COMPLETED',
|
|
464
|
+
CREATE_BULK_TASKS_FAILED: 'CREATE_BULK_TASKS_FAILED',
|
|
465
|
+
DOCUMENT_SYNC_INITIATED: 'DOCUMENT_SYNC_INITIATED',
|
|
466
|
+
DOCUMENT_SYNC_COMPLETED: 'DOCUMENT_SYNC_COMPLETED',
|
|
467
|
+
DOCUMENT_SYNC_FAILED: 'DOCUMENT_SYNC_FAILED',
|
|
459
468
|
};
|
|
460
469
|
this.UseCase = {
|
|
461
470
|
PROGRAM_INFO: 'SAVE_PROGRAMME_DETAILS',
|
|
@@ -579,7 +588,7 @@ let LoggerEnum = class LoggerEnum {
|
|
|
579
588
|
APPLICATION_MATERIALS: 'SAVE_APPLICATION_MATERIALS',
|
|
580
589
|
AWARDS_AND_HONORS: 'SAVE_AWARDS_AND_HONORS',
|
|
581
590
|
ADDITIONAL_INFORMATION: 'SAVE_ADDITIONAL_INFORMATION',
|
|
582
|
-
DISCLOSURES: 'SAVE_DISCLOSURES'
|
|
591
|
+
DISCLOSURES: 'SAVE_DISCLOSURES',
|
|
583
592
|
};
|
|
584
593
|
this.Component = {
|
|
585
594
|
OAP_FRONTEND: 'OAP-FRONTEND',
|
|
@@ -647,6 +656,9 @@ let LoggerEnum = class LoggerEnum {
|
|
|
647
656
|
UNFC_ELLUCIAN: 'UNFC_ELLUCIAN',
|
|
648
657
|
ARDEN_GUS_SALESFORCE_INTEGRATION_HANDLER: 'ARDEN_GUS_SALESFORCE_INTEGRATION_HANDLER',
|
|
649
658
|
ARDEN_GUS_SALESFORCE_INTEGRATION_QUEUE: 'ARDEN_GUS_SALESFORCE_INTEGRATION_QUEUE',
|
|
659
|
+
GUS_SF_EVENTS_INBOUND_QUEUE: 'GUS_SF_EVENTS_INBOUND_QUEUE',
|
|
660
|
+
GUS_EIP_INBOUND_INTEGRATION_HANDLER: 'GUS_EIP_INBOUND_INTEGRATION_HANDLER',
|
|
661
|
+
GUS_EIP_EVENTS_INBOUND_QUEUE: 'GUS_EIP_EVENTS_INBOUND_QUEUE',
|
|
650
662
|
};
|
|
651
663
|
}
|
|
652
664
|
};
|
package/package.json
CHANGED
|
@@ -1,79 +1,79 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@gus-eip/loggers",
|
|
3
|
-
"version": "4.1.
|
|
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/client-ssm": "^3.759.0",
|
|
35
|
-
"aws-sdk": "^2.1590.0",
|
|
36
|
-
"axios": "^1.7.4"
|
|
37
|
-
},
|
|
38
|
-
"devDependencies": {
|
|
39
|
-
"@nestjs/common": "^10.0.2",
|
|
40
|
-
"@nestjs/core": "^10.0.2",
|
|
41
|
-
"@nestjs/platform-express": "^10.0.2",
|
|
42
|
-
"@nestjs/testing": "10.0.2",
|
|
43
|
-
"@types/express": "4.17.17",
|
|
44
|
-
"@types/jest": "29.5.2",
|
|
45
|
-
"@types/lodash": "^4.17.7",
|
|
46
|
-
"@types/node": "20.3.1",
|
|
47
|
-
"@types/supertest": "2.0.12",
|
|
48
|
-
"@typescript-eslint/eslint-plugin": "^5.60.0",
|
|
49
|
-
"@typescript-eslint/parser": "^5.60.0",
|
|
50
|
-
"eslint": "^8.43.0",
|
|
51
|
-
"eslint-config-prettier": "^8.8.0",
|
|
52
|
-
"eslint-plugin-prettier": "^4.2.1",
|
|
53
|
-
"jest": "29.5.0",
|
|
54
|
-
"prettier": "2.8.8",
|
|
55
|
-
"reflect-metadata": "^0.1.13",
|
|
56
|
-
"rxjs": "^7.8.1",
|
|
57
|
-
"supertest": "6.3.3",
|
|
58
|
-
"ts-jest": "29.1.0",
|
|
59
|
-
"ts-node": "10.9.1",
|
|
60
|
-
"tsc-watch": "6.0.4",
|
|
61
|
-
"tsconfig-paths": "4.2.0",
|
|
62
|
-
"tslint": "5.20.1",
|
|
63
|
-
"typescript": "^5.5.4"
|
|
64
|
-
},
|
|
65
|
-
"jest": {
|
|
66
|
-
"moduleFileExtensions": [
|
|
67
|
-
"js",
|
|
68
|
-
"json",
|
|
69
|
-
"ts"
|
|
70
|
-
],
|
|
71
|
-
"rootDir": "src",
|
|
72
|
-
"testRegex": ".spec.ts$",
|
|
73
|
-
"transform": {
|
|
74
|
-
"^.+\\.(t|j)s$": "ts-jest"
|
|
75
|
-
},
|
|
76
|
-
"coverageDirectory": "../coverage",
|
|
77
|
-
"testEnvironment": "node"
|
|
78
|
-
}
|
|
79
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "@gus-eip/loggers",
|
|
3
|
+
"version": "4.1.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/client-ssm": "^3.759.0",
|
|
35
|
+
"aws-sdk": "^2.1590.0",
|
|
36
|
+
"axios": "^1.7.4"
|
|
37
|
+
},
|
|
38
|
+
"devDependencies": {
|
|
39
|
+
"@nestjs/common": "^10.0.2",
|
|
40
|
+
"@nestjs/core": "^10.0.2",
|
|
41
|
+
"@nestjs/platform-express": "^10.0.2",
|
|
42
|
+
"@nestjs/testing": "10.0.2",
|
|
43
|
+
"@types/express": "4.17.17",
|
|
44
|
+
"@types/jest": "29.5.2",
|
|
45
|
+
"@types/lodash": "^4.17.7",
|
|
46
|
+
"@types/node": "20.3.1",
|
|
47
|
+
"@types/supertest": "2.0.12",
|
|
48
|
+
"@typescript-eslint/eslint-plugin": "^5.60.0",
|
|
49
|
+
"@typescript-eslint/parser": "^5.60.0",
|
|
50
|
+
"eslint": "^8.43.0",
|
|
51
|
+
"eslint-config-prettier": "^8.8.0",
|
|
52
|
+
"eslint-plugin-prettier": "^4.2.1",
|
|
53
|
+
"jest": "29.5.0",
|
|
54
|
+
"prettier": "2.8.8",
|
|
55
|
+
"reflect-metadata": "^0.1.13",
|
|
56
|
+
"rxjs": "^7.8.1",
|
|
57
|
+
"supertest": "6.3.3",
|
|
58
|
+
"ts-jest": "29.1.0",
|
|
59
|
+
"ts-node": "10.9.1",
|
|
60
|
+
"tsc-watch": "6.0.4",
|
|
61
|
+
"tsconfig-paths": "4.2.0",
|
|
62
|
+
"tslint": "5.20.1",
|
|
63
|
+
"typescript": "^5.5.4"
|
|
64
|
+
},
|
|
65
|
+
"jest": {
|
|
66
|
+
"moduleFileExtensions": [
|
|
67
|
+
"js",
|
|
68
|
+
"json",
|
|
69
|
+
"ts"
|
|
70
|
+
],
|
|
71
|
+
"rootDir": "src",
|
|
72
|
+
"testRegex": ".spec.ts$",
|
|
73
|
+
"transform": {
|
|
74
|
+
"^.+\\.(t|j)s$": "ts-jest"
|
|
75
|
+
},
|
|
76
|
+
"coverageDirectory": "../coverage",
|
|
77
|
+
"testEnvironment": "node"
|
|
78
|
+
}
|
|
79
|
+
}
|