@reyaxyz/athena-logger 0.2.2 → 0.2.3
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 +25 -3
- package/dist/action.js +20 -0
- package/dist/action.js.map +1 -0
- package/dist/error.js +26 -0
- package/dist/error.js.map +1 -0
- package/dist/index.js +13 -3
- package/dist/index.js.map +1 -1
- package/dist/logger.js +44 -0
- package/dist/logger.js.map +1 -0
- package/dist/types/action.d.ts +9 -0
- package/dist/types/action.d.ts.map +1 -0
- package/dist/types/error.d.ts +10 -0
- package/dist/types/error.d.ts.map +1 -0
- package/dist/types/index.d.ts +20 -1
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/logger.d.ts +11 -0
- package/dist/types/logger.d.ts.map +1 -0
- package/dist/types/utils/checkWalletAddress/index.d.ts +2 -0
- package/dist/types/utils/checkWalletAddress/index.d.ts.map +1 -0
- package/dist/utils/checkWalletAddress/index.js +8 -0
- package/dist/utils/checkWalletAddress/index.js.map +1 -0
- package/package.json +8 -2
- package/src/action.ts +35 -0
- package/src/error.ts +30 -0
- package/src/index.ts +13 -1
- package/src/logger.ts +53 -0
- package/src/utils/checkWalletAddress/index.ts +2 -0
package/README.md
CHANGED
|
@@ -4,6 +4,28 @@
|
|
|
4
4
|
|
|
5
5
|
<br />
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
7
|
+
## Searching Logs in Datadog
|
|
8
|
+
|
|
9
|
+
To search logs in Datadog, use the appropriate log tags. The service is customizable. Here are examples for searching user journey actions and errors:
|
|
10
|
+
|
|
11
|
+
### User Journey Actions
|
|
12
|
+
|
|
13
|
+
To find user journey actions, search with the tag `athena.user_journey`:
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
service:<your-service> athena.user_journey @user.walletAddress:<wallet-address>
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
### Errors
|
|
21
|
+
|
|
22
|
+
To find errors, search with the tag athena.error:
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
service:test athena.error @user.walletAddress:0x123
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
| Statements | Branches | Functions | Lines |
|
|
30
|
+
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
|
31
|
+
|  |  |  |  |
|
package/dist/action.js
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.action = void 0;
|
|
4
|
+
var browser_logs_1 = require("@datadog/browser-logs");
|
|
5
|
+
var logger_1 = require("./logger");
|
|
6
|
+
var checkWalletAddress_1 = require("./utils/checkWalletAddress");
|
|
7
|
+
var action = function (_a) {
|
|
8
|
+
var walletAddress = _a.walletAddress, action = _a.action, error = _a.error, message = _a.message, payload = _a.payload;
|
|
9
|
+
if (!(0, checkWalletAddress_1.isWalletAddressProvided)(walletAddress)) {
|
|
10
|
+
console.warn('Logger missing wallet address');
|
|
11
|
+
return;
|
|
12
|
+
}
|
|
13
|
+
if (!(0, logger_1.isLoggerInitialized)()) {
|
|
14
|
+
console.warn('Logger not initialized');
|
|
15
|
+
return;
|
|
16
|
+
}
|
|
17
|
+
browser_logs_1.datadogLogs.logger.info("athena.user_journey/".concat(action).concat(message ? ": ".concat(message) : ''), payload, error);
|
|
18
|
+
};
|
|
19
|
+
exports.action = action;
|
|
20
|
+
//# sourceMappingURL=action.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"action.js","sourceRoot":"/","sources":["action.ts"],"names":[],"mappings":";;;AAAA,sDAAoD;AACpD,mCAA+C;AAC/C,iEAAqE;AAU9D,IAAM,MAAM,GAAG,UAAC,EAMG;QALxB,aAAa,mBAAA,EACb,MAAM,YAAA,EACN,KAAK,WAAA,EACL,OAAO,aAAA,EACP,OAAO,aAAA;IAEP,IAAI,CAAC,IAAA,4CAAuB,EAAC,aAAa,CAAC,EAAE,CAAC;QAC5C,OAAO,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;QAC9C,OAAO;IACT,CAAC;IAED,IAAI,CAAC,IAAA,4BAAmB,GAAE,EAAE,CAAC;QAC3B,OAAO,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QACvC,OAAO;IACT,CAAC;IAED,0BAAW,CAAC,MAAM,CAAC,IAAI,CACrB,8BAAuB,MAAM,SAAG,OAAO,CAAC,CAAC,CAAC,YAAK,OAAO,CAAE,CAAC,CAAC,CAAC,EAAE,CAAE,EAC/D,OAAO,EACP,KAAc,CACf,CAAC;AACJ,CAAC,CAAC;AAtBW,QAAA,MAAM,UAsBjB","sourcesContent":["import { datadogLogs } from '@datadog/browser-logs';\nimport { isLoggerInitialized } from './logger';\nimport { isWalletAddressProvided } from './utils/checkWalletAddress';\n\nexport type UserJourneyActionParams = {\n walletAddress: string;\n action: string;\n error?: Error | unknown;\n message?: string;\n payload?: Record<string, unknown>;\n};\n\nexport const action = ({\n walletAddress,\n action,\n error,\n message,\n payload,\n}: UserJourneyActionParams) => {\n if (!isWalletAddressProvided(walletAddress)) {\n console.warn('Logger missing wallet address');\n return;\n }\n\n if (!isLoggerInitialized()) {\n console.warn('Logger not initialized');\n return;\n }\n\n datadogLogs.logger.info(\n `athena.user_journey/${action}${message ? `: ${message}` : ''}`,\n payload,\n error as Error,\n );\n};\n"]}
|
package/dist/error.js
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __assign = (this && this.__assign) || function () {
|
|
3
|
+
__assign = Object.assign || function(t) {
|
|
4
|
+
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
5
|
+
s = arguments[i];
|
|
6
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
7
|
+
t[p] = s[p];
|
|
8
|
+
}
|
|
9
|
+
return t;
|
|
10
|
+
};
|
|
11
|
+
return __assign.apply(this, arguments);
|
|
12
|
+
};
|
|
13
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
14
|
+
exports.error = void 0;
|
|
15
|
+
var browser_logs_1 = require("@datadog/browser-logs");
|
|
16
|
+
var logger_1 = require("./logger");
|
|
17
|
+
var error = function (_a) {
|
|
18
|
+
var action = _a.action, message = _a.message, metadata = _a.metadata, walletAddress = _a.walletAddress, error = _a.error;
|
|
19
|
+
if (!(0, logger_1.isLoggerInitialized)()) {
|
|
20
|
+
console.warn('Logger not initialized');
|
|
21
|
+
return;
|
|
22
|
+
}
|
|
23
|
+
browser_logs_1.datadogLogs.logger.error("athena.error/".concat(action).concat(message ? ": ".concat(message) : ''), __assign(__assign({}, metadata), (walletAddress && { user: { walletAddress: walletAddress } })), error);
|
|
24
|
+
};
|
|
25
|
+
exports.error = error;
|
|
26
|
+
//# sourceMappingURL=error.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"error.js","sourceRoot":"/","sources":["error.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,sDAAoD;AACpD,mCAA+C;AAWxC,IAAM,KAAK,GAAG,UAAC,EAML;QALf,MAAM,YAAA,EACN,OAAO,aAAA,EACP,QAAQ,cAAA,EACR,aAAa,mBAAA,EACb,KAAK,WAAA;IAEL,IAAI,CAAC,IAAA,4BAAmB,GAAE,EAAE,CAAC;QAC3B,OAAO,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QACvC,OAAO;IACT,CAAC;IAED,0BAAW,CAAC,MAAM,CAAC,KAAK,CACtB,uBAAgB,MAAM,SAAG,OAAO,CAAC,CAAC,CAAC,YAAK,OAAO,CAAE,CAAC,CAAC,CAAC,EAAE,CAAE,wBACnD,QAAQ,GAAK,CAAC,aAAa,IAAI,EAAE,IAAI,EAAE,EAAE,aAAa,eAAA,EAAE,EAAE,CAAC,GAChE,KAAc,CACf,CAAC;AACJ,CAAC,CAAC;AAjBW,QAAA,KAAK,SAiBhB","sourcesContent":["import { datadogLogs } from '@datadog/browser-logs';\nimport { isLoggerInitialized } from './logger';\n\ntype LogErrorParams = {\n action: string;\n error: unknown;\n walletAddress?: string;\n // Optional! If not provided, will try to extract message from Error\n message?: string;\n metadata?: Record<string, unknown>;\n};\n\nexport const error = ({\n action,\n message,\n metadata,\n walletAddress,\n error,\n}: LogErrorParams) => {\n if (!isLoggerInitialized()) {\n console.warn('Logger not initialized');\n return;\n }\n\n datadogLogs.logger.error(\n `athena.error/${action}${message ? `: ${message}` : ''}`,\n { ...metadata, ...(walletAddress && { user: { walletAddress } }) },\n error as Error,\n );\n};\n"]}
|
package/dist/index.js
CHANGED
|
@@ -1,6 +1,16 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
4
|
-
var
|
|
5
|
-
|
|
3
|
+
exports.Athena = void 0;
|
|
4
|
+
var action_1 = require("./action");
|
|
5
|
+
var error_1 = require("./error");
|
|
6
|
+
var logger_1 = require("./logger");
|
|
7
|
+
exports.Athena = {
|
|
8
|
+
initialize: logger_1.initialize,
|
|
9
|
+
UserJourney: {
|
|
10
|
+
action: action_1.action,
|
|
11
|
+
},
|
|
12
|
+
Error: {
|
|
13
|
+
error: error_1.error,
|
|
14
|
+
},
|
|
15
|
+
};
|
|
6
16
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"/","sources":["index.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"/","sources":["index.ts"],"names":[],"mappings":";;;AAAA,mCAAkC;AAClC,iCAAgC;AAChC,mCAAsC;AAEzB,QAAA,MAAM,GAAG;IACpB,UAAU,qBAAA;IACV,WAAW,EAAE;QACX,MAAM,iBAAA;KACP;IACD,KAAK,EAAE;QACL,KAAK,eAAA;KACN;CACF,CAAC","sourcesContent":["import { action } from './action';\nimport { error } from './error';\nimport { initialize } from './logger';\n\nexport const Athena = {\n initialize,\n UserJourney: {\n action,\n },\n Error: {\n error,\n },\n};\n"]}
|
package/dist/logger.js
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.isLoggingAllowed = exports.isLoggerInitialized = exports.initialize = void 0;
|
|
4
|
+
var browser_logs_1 = require("@datadog/browser-logs");
|
|
5
|
+
var initialized = false;
|
|
6
|
+
var allowLogging = false;
|
|
7
|
+
var initialize = function (_a) {
|
|
8
|
+
var clientToken = _a.clientToken, environment = _a.environment, service = _a.service, version = _a.version;
|
|
9
|
+
var isLocalhost = environment === 'localhost';
|
|
10
|
+
if (!environment || !clientToken || !service || !version) {
|
|
11
|
+
initialized = false;
|
|
12
|
+
allowLogging = false;
|
|
13
|
+
return;
|
|
14
|
+
}
|
|
15
|
+
if (isLocalhost) {
|
|
16
|
+
initialized = true;
|
|
17
|
+
allowLogging = false;
|
|
18
|
+
return;
|
|
19
|
+
}
|
|
20
|
+
try {
|
|
21
|
+
browser_logs_1.datadogLogs.init({
|
|
22
|
+
clientToken: clientToken,
|
|
23
|
+
env: environment,
|
|
24
|
+
service: service,
|
|
25
|
+
sessionSampleRate: 100,
|
|
26
|
+
site: 'datadoghq.eu',
|
|
27
|
+
forwardConsoleLogs: ['error'],
|
|
28
|
+
forwardErrorsToLogs: true,
|
|
29
|
+
version: version,
|
|
30
|
+
});
|
|
31
|
+
initialized = true;
|
|
32
|
+
allowLogging = true;
|
|
33
|
+
}
|
|
34
|
+
catch (err) {
|
|
35
|
+
initialized = false;
|
|
36
|
+
allowLogging = false;
|
|
37
|
+
}
|
|
38
|
+
};
|
|
39
|
+
exports.initialize = initialize;
|
|
40
|
+
var isLoggerInitialized = function () { return initialized; };
|
|
41
|
+
exports.isLoggerInitialized = isLoggerInitialized;
|
|
42
|
+
var isLoggingAllowed = function () { return allowLogging; };
|
|
43
|
+
exports.isLoggingAllowed = isLoggingAllowed;
|
|
44
|
+
//# sourceMappingURL=logger.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"logger.js","sourceRoot":"/","sources":["logger.ts"],"names":[],"mappings":";;;AAAA,sDAAoD;AAEpD,IAAI,WAAW,GAAG,KAAK,CAAC;AACxB,IAAI,YAAY,GAAG,KAAK,CAAC;AASlB,IAAM,UAAU,GAAG,UAAC,EAKR;QAJjB,WAAW,iBAAA,EACX,WAAW,iBAAA,EACX,OAAO,aAAA,EACP,OAAO,aAAA;IAEP,IAAM,WAAW,GAAG,WAAW,KAAK,WAAW,CAAC;IAChD,IAAI,CAAC,WAAW,IAAI,CAAC,WAAW,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;QACzD,WAAW,GAAG,KAAK,CAAC;QACpB,YAAY,GAAG,KAAK,CAAC;QACrB,OAAO;IACT,CAAC;IAED,IAAI,WAAW,EAAE,CAAC;QAChB,WAAW,GAAG,IAAI,CAAC;QACnB,YAAY,GAAG,KAAK,CAAC;QACrB,OAAO;IACT,CAAC;IAED,IAAI,CAAC;QACH,0BAAW,CAAC,IAAI,CAAC;YACf,WAAW,aAAA;YACX,GAAG,EAAE,WAAW;YAChB,OAAO,SAAA;YACP,iBAAiB,EAAE,GAAG;YACtB,IAAI,EAAE,cAAc;YACpB,kBAAkB,EAAE,CAAC,OAAO,CAAC;YAC7B,mBAAmB,EAAE,IAAI;YACzB,OAAO,SAAA;SACR,CAAC,CAAC;QAEH,WAAW,GAAG,IAAI,CAAC;QACnB,YAAY,GAAG,IAAI,CAAC;IACtB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,WAAW,GAAG,KAAK,CAAC;QACpB,YAAY,GAAG,KAAK,CAAC;IACvB,CAAC;AACH,CAAC,CAAC;AArCW,QAAA,UAAU,cAqCrB;AAEK,IAAM,mBAAmB,GAAG,cAAM,OAAA,WAAW,EAAX,CAAW,CAAC;AAAxC,QAAA,mBAAmB,uBAAqB;AAC9C,IAAM,gBAAgB,GAAG,cAAM,OAAA,YAAY,EAAZ,CAAY,CAAC;AAAtC,QAAA,gBAAgB,oBAAsB","sourcesContent":["import { datadogLogs } from '@datadog/browser-logs';\n\nlet initialized = false;\nlet allowLogging = false;\n\ntype InitializeParams = {\n clientToken: string;\n environment: string;\n service: string;\n version: string;\n};\n\nexport const initialize = ({\n clientToken,\n environment,\n service,\n version,\n}: InitializeParams) => {\n const isLocalhost = environment === 'localhost';\n if (!environment || !clientToken || !service || !version) {\n initialized = false;\n allowLogging = false;\n return;\n }\n\n if (isLocalhost) {\n initialized = true;\n allowLogging = false;\n return;\n }\n\n try {\n datadogLogs.init({\n clientToken,\n env: environment,\n service,\n sessionSampleRate: 100,\n site: 'datadoghq.eu',\n forwardConsoleLogs: ['error'],\n forwardErrorsToLogs: true,\n version,\n });\n\n initialized = true;\n allowLogging = true;\n } catch (err) {\n initialized = false;\n allowLogging = false;\n }\n};\n\nexport const isLoggerInitialized = () => initialized;\nexport const isLoggingAllowed = () => allowLogging;\n"]}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
export type UserJourneyActionParams = {
|
|
2
|
+
walletAddress: string;
|
|
3
|
+
action: string;
|
|
4
|
+
error?: Error | unknown;
|
|
5
|
+
message?: string;
|
|
6
|
+
payload?: Record<string, unknown>;
|
|
7
|
+
};
|
|
8
|
+
export declare const action: ({ walletAddress, action, error, message, payload, }: UserJourneyActionParams) => void;
|
|
9
|
+
//# sourceMappingURL=action.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"action.d.ts","sourceRoot":"/","sources":["action.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,uBAAuB,GAAG;IACpC,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC,CAAC;AAEF,eAAO,MAAM,MAAM,wDAMhB,uBAAuB,SAgBzB,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
type LogErrorParams = {
|
|
2
|
+
action: string;
|
|
3
|
+
error: unknown;
|
|
4
|
+
walletAddress?: string;
|
|
5
|
+
message?: string;
|
|
6
|
+
metadata?: Record<string, unknown>;
|
|
7
|
+
};
|
|
8
|
+
export declare const error: ({ action, message, metadata, walletAddress, error, }: LogErrorParams) => void;
|
|
9
|
+
export {};
|
|
10
|
+
//# sourceMappingURL=error.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"error.d.ts","sourceRoot":"/","sources":["error.ts"],"names":[],"mappings":"AAGA,KAAK,cAAc,GAAG;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF,eAAO,MAAM,KAAK,yDAMf,cAAc,SAWhB,CAAC"}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1,2 +1,21 @@
|
|
|
1
|
-
export declare const
|
|
1
|
+
export declare const Athena: {
|
|
2
|
+
initialize: ({ clientToken, environment, service, version, }: {
|
|
3
|
+
clientToken: string;
|
|
4
|
+
environment: string;
|
|
5
|
+
service: string;
|
|
6
|
+
version: string;
|
|
7
|
+
}) => void;
|
|
8
|
+
UserJourney: {
|
|
9
|
+
action: ({ walletAddress, action, error, message, payload, }: import("./action").UserJourneyActionParams) => void;
|
|
10
|
+
};
|
|
11
|
+
Error: {
|
|
12
|
+
error: ({ action, message, metadata, walletAddress, error, }: {
|
|
13
|
+
action: string;
|
|
14
|
+
error: unknown;
|
|
15
|
+
walletAddress?: string | undefined;
|
|
16
|
+
message?: string | undefined;
|
|
17
|
+
metadata?: Record<string, unknown> | undefined;
|
|
18
|
+
}) => void;
|
|
19
|
+
};
|
|
20
|
+
};
|
|
2
21
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"/","sources":["index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"/","sources":["index.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;CAQlB,CAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
type InitializeParams = {
|
|
2
|
+
clientToken: string;
|
|
3
|
+
environment: string;
|
|
4
|
+
service: string;
|
|
5
|
+
version: string;
|
|
6
|
+
};
|
|
7
|
+
export declare const initialize: ({ clientToken, environment, service, version, }: InitializeParams) => void;
|
|
8
|
+
export declare const isLoggerInitialized: () => boolean;
|
|
9
|
+
export declare const isLoggingAllowed: () => boolean;
|
|
10
|
+
export {};
|
|
11
|
+
//# sourceMappingURL=logger.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"logger.d.ts","sourceRoot":"/","sources":["logger.ts"],"names":[],"mappings":"AAKA,KAAK,gBAAgB,GAAG;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,UAAU,oDAKpB,gBAAgB,SAgClB,CAAC;AAEF,eAAO,MAAM,mBAAmB,eAAoB,CAAC;AACrD,eAAO,MAAM,gBAAgB,eAAqB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"/","sources":["utils/checkWalletAddress/index.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,uBAAuB,kBAAmB,MAAM,YACrC,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.isWalletAddressProvided = void 0;
|
|
4
|
+
var isWalletAddressProvided = function (walletAddress) {
|
|
5
|
+
return Boolean(walletAddress);
|
|
6
|
+
};
|
|
7
|
+
exports.isWalletAddressProvided = isWalletAddressProvided;
|
|
8
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"/","sources":["utils/checkWalletAddress/index.ts"],"names":[],"mappings":";;;AAAO,IAAM,uBAAuB,GAAG,UAAC,aAAqB;IAC3D,OAAA,OAAO,CAAC,aAAa,CAAC;AAAtB,CAAsB,CAAC;AADZ,QAAA,uBAAuB,2BACX","sourcesContent":["export const isWalletAddressProvided = (walletAddress: string) =>\n Boolean(walletAddress);\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@reyaxyz/athena-logger",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.3",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public",
|
|
6
6
|
"registry": "https://registry.npmjs.org"
|
|
@@ -35,6 +35,12 @@
|
|
|
35
35
|
"dependencies": {
|
|
36
36
|
"@reyaxyz/common": "0.113.0"
|
|
37
37
|
},
|
|
38
|
+
"devDependencies": {
|
|
39
|
+
"@datadog/browser-logs": "5.17.1"
|
|
40
|
+
},
|
|
41
|
+
"peerDependencies": {
|
|
42
|
+
"@datadog/browser-logs": "5.17.1"
|
|
43
|
+
},
|
|
38
44
|
"packageManager": "pnpm@8.3.1",
|
|
39
|
-
"gitHead": "
|
|
45
|
+
"gitHead": "77a1eef6477ba500889cdda36143544126cf1840"
|
|
40
46
|
}
|
package/src/action.ts
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { datadogLogs } from '@datadog/browser-logs';
|
|
2
|
+
import { isLoggerInitialized } from './logger';
|
|
3
|
+
import { isWalletAddressProvided } from './utils/checkWalletAddress';
|
|
4
|
+
|
|
5
|
+
export type UserJourneyActionParams = {
|
|
6
|
+
walletAddress: string;
|
|
7
|
+
action: string;
|
|
8
|
+
error?: Error | unknown;
|
|
9
|
+
message?: string;
|
|
10
|
+
payload?: Record<string, unknown>;
|
|
11
|
+
};
|
|
12
|
+
|
|
13
|
+
export const action = ({
|
|
14
|
+
walletAddress,
|
|
15
|
+
action,
|
|
16
|
+
error,
|
|
17
|
+
message,
|
|
18
|
+
payload,
|
|
19
|
+
}: UserJourneyActionParams) => {
|
|
20
|
+
if (!isWalletAddressProvided(walletAddress)) {
|
|
21
|
+
console.warn('Logger missing wallet address');
|
|
22
|
+
return;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
if (!isLoggerInitialized()) {
|
|
26
|
+
console.warn('Logger not initialized');
|
|
27
|
+
return;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
datadogLogs.logger.info(
|
|
31
|
+
`athena.user_journey/${action}${message ? `: ${message}` : ''}`,
|
|
32
|
+
payload,
|
|
33
|
+
error as Error,
|
|
34
|
+
);
|
|
35
|
+
};
|
package/src/error.ts
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { datadogLogs } from '@datadog/browser-logs';
|
|
2
|
+
import { isLoggerInitialized } from './logger';
|
|
3
|
+
|
|
4
|
+
type LogErrorParams = {
|
|
5
|
+
action: string;
|
|
6
|
+
error: unknown;
|
|
7
|
+
walletAddress?: string;
|
|
8
|
+
// Optional! If not provided, will try to extract message from Error
|
|
9
|
+
message?: string;
|
|
10
|
+
metadata?: Record<string, unknown>;
|
|
11
|
+
};
|
|
12
|
+
|
|
13
|
+
export const error = ({
|
|
14
|
+
action,
|
|
15
|
+
message,
|
|
16
|
+
metadata,
|
|
17
|
+
walletAddress,
|
|
18
|
+
error,
|
|
19
|
+
}: LogErrorParams) => {
|
|
20
|
+
if (!isLoggerInitialized()) {
|
|
21
|
+
console.warn('Logger not initialized');
|
|
22
|
+
return;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
datadogLogs.logger.error(
|
|
26
|
+
`athena.error/${action}${message ? `: ${message}` : ''}`,
|
|
27
|
+
{ ...metadata, ...(walletAddress && { user: { walletAddress } }) },
|
|
28
|
+
error as Error,
|
|
29
|
+
);
|
|
30
|
+
};
|
package/src/index.ts
CHANGED
|
@@ -1 +1,13 @@
|
|
|
1
|
-
|
|
1
|
+
import { action } from './action';
|
|
2
|
+
import { error } from './error';
|
|
3
|
+
import { initialize } from './logger';
|
|
4
|
+
|
|
5
|
+
export const Athena = {
|
|
6
|
+
initialize,
|
|
7
|
+
UserJourney: {
|
|
8
|
+
action,
|
|
9
|
+
},
|
|
10
|
+
Error: {
|
|
11
|
+
error,
|
|
12
|
+
},
|
|
13
|
+
};
|
package/src/logger.ts
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import { datadogLogs } from '@datadog/browser-logs';
|
|
2
|
+
|
|
3
|
+
let initialized = false;
|
|
4
|
+
let allowLogging = false;
|
|
5
|
+
|
|
6
|
+
type InitializeParams = {
|
|
7
|
+
clientToken: string;
|
|
8
|
+
environment: string;
|
|
9
|
+
service: string;
|
|
10
|
+
version: string;
|
|
11
|
+
};
|
|
12
|
+
|
|
13
|
+
export const initialize = ({
|
|
14
|
+
clientToken,
|
|
15
|
+
environment,
|
|
16
|
+
service,
|
|
17
|
+
version,
|
|
18
|
+
}: InitializeParams) => {
|
|
19
|
+
const isLocalhost = environment === 'localhost';
|
|
20
|
+
if (!environment || !clientToken || !service || !version) {
|
|
21
|
+
initialized = false;
|
|
22
|
+
allowLogging = false;
|
|
23
|
+
return;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
if (isLocalhost) {
|
|
27
|
+
initialized = true;
|
|
28
|
+
allowLogging = false;
|
|
29
|
+
return;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
try {
|
|
33
|
+
datadogLogs.init({
|
|
34
|
+
clientToken,
|
|
35
|
+
env: environment,
|
|
36
|
+
service,
|
|
37
|
+
sessionSampleRate: 100,
|
|
38
|
+
site: 'datadoghq.eu',
|
|
39
|
+
forwardConsoleLogs: ['error'],
|
|
40
|
+
forwardErrorsToLogs: true,
|
|
41
|
+
version,
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
initialized = true;
|
|
45
|
+
allowLogging = true;
|
|
46
|
+
} catch (err) {
|
|
47
|
+
initialized = false;
|
|
48
|
+
allowLogging = false;
|
|
49
|
+
}
|
|
50
|
+
};
|
|
51
|
+
|
|
52
|
+
export const isLoggerInitialized = () => initialized;
|
|
53
|
+
export const isLoggingAllowed = () => allowLogging;
|