@loglayer/transport-betterstack 1.0.0 → 1.0.2
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/dist/index.cjs +74 -73
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +29 -26
- package/dist/index.d.ts +29 -26
- package/dist/index.js +56 -52
- package/dist/index.js.map +1 -1
- package/package.json +9 -9
package/dist/index.cjs
CHANGED
|
@@ -1,83 +1,84 @@
|
|
|
1
|
-
|
|
1
|
+
//#region rolldown:runtime
|
|
2
|
+
var __create = Object.create;
|
|
2
3
|
var __defProp = Object.defineProperty;
|
|
3
4
|
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
5
|
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
6
|
+
var __getProtoOf = Object.getPrototypeOf;
|
|
5
7
|
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
-
var __export = (target, all) => {
|
|
7
|
-
for (var name in all)
|
|
8
|
-
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
-
};
|
|
10
8
|
var __copyProps = (to, from, except, desc) => {
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
9
|
+
if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
|
|
10
|
+
key = keys[i];
|
|
11
|
+
if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
|
|
12
|
+
get: ((k) => from[k]).bind(null, key),
|
|
13
|
+
enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
|
|
14
|
+
});
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
17
|
};
|
|
18
|
-
var
|
|
18
|
+
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
|
|
19
|
+
value: mod,
|
|
20
|
+
enumerable: true
|
|
21
|
+
}) : target, mod));
|
|
19
22
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
BetterStackTransport: () => BetterStackTransport
|
|
24
|
-
});
|
|
25
|
-
module.exports = __toCommonJS(index_exports);
|
|
23
|
+
//#endregion
|
|
24
|
+
let __loglayer_transport_http = require("@loglayer/transport-http");
|
|
25
|
+
__loglayer_transport_http = __toESM(__loglayer_transport_http);
|
|
26
26
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
27
|
+
//#region src/BetterStackTransport.ts
|
|
28
|
+
/**
|
|
29
|
+
* Better Stack transport for sending logs to Better Stack's log management platform.
|
|
30
|
+
*
|
|
31
|
+
* This transport extends the HTTP transport and configures it specifically for Better Stack's API.
|
|
32
|
+
* It handles authentication, payload formatting, and batch sending according to Better Stack's requirements.
|
|
33
|
+
*
|
|
34
|
+
* Features:
|
|
35
|
+
* - Automatic authentication with source token
|
|
36
|
+
* - Proper payload formatting for Better Stack API
|
|
37
|
+
* - Support for custom timestamps
|
|
38
|
+
* - Batch sending with configurable size and timeout
|
|
39
|
+
* - Error handling and retry logic
|
|
40
|
+
* - Compression support
|
|
41
|
+
*/
|
|
42
|
+
var BetterStackTransport = class extends __loglayer_transport_http.HttpTransport {
|
|
43
|
+
/**
|
|
44
|
+
* Creates a new instance of BetterStackTransport.
|
|
45
|
+
*
|
|
46
|
+
* @param config - Configuration options for the transport
|
|
47
|
+
*/
|
|
48
|
+
constructor(config) {
|
|
49
|
+
const url = config.url;
|
|
50
|
+
const includeTimestamp = config.includeTimestamp ?? true;
|
|
51
|
+
const timestampField = config.timestampField ?? "dt";
|
|
52
|
+
const httpConfig = {
|
|
53
|
+
...config,
|
|
54
|
+
url,
|
|
55
|
+
headers: {
|
|
56
|
+
Authorization: `Bearer ${config.sourceToken}`,
|
|
57
|
+
"Content-Type": "application/json"
|
|
58
|
+
},
|
|
59
|
+
payloadTemplate: (data) => {
|
|
60
|
+
const payload = { message: data.message };
|
|
61
|
+
if (data.logLevel) payload.level = data.logLevel;
|
|
62
|
+
if (data.data) Object.assign(payload, data.data);
|
|
63
|
+
if (includeTimestamp) payload[timestampField] = (/* @__PURE__ */ new Date()).toISOString();
|
|
64
|
+
return JSON.stringify(payload);
|
|
65
|
+
},
|
|
66
|
+
batchMode: "array",
|
|
67
|
+
batchContentType: "application/json",
|
|
68
|
+
enableBatchSend: config.enableBatchSend ?? true,
|
|
69
|
+
batchSize: config.batchSize ?? 100,
|
|
70
|
+
batchSendTimeout: config.batchSendTimeout ?? 5e3,
|
|
71
|
+
compression: config.compression ?? false,
|
|
72
|
+
maxRetries: config.maxRetries ?? 3,
|
|
73
|
+
retryDelay: config.retryDelay ?? 1e3,
|
|
74
|
+
respectRateLimit: config.respectRateLimit ?? true,
|
|
75
|
+
maxLogSize: config.maxLogSize ?? 1048576,
|
|
76
|
+
maxPayloadSize: config.maxPayloadSize ?? 10485760
|
|
77
|
+
};
|
|
78
|
+
super(httpConfig);
|
|
79
|
+
}
|
|
78
80
|
};
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
});
|
|
81
|
+
|
|
82
|
+
//#endregion
|
|
83
|
+
exports.BetterStackTransport = BetterStackTransport;
|
|
83
84
|
//# sourceMappingURL=index.cjs.map
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"
|
|
1
|
+
{"version":3,"file":"index.cjs","names":["HttpTransport","httpConfig: HttpTransportConfig","payload: Record<string, any>"],"sources":["../src/BetterStackTransport.ts"],"sourcesContent":["import type { HttpTransportConfig } from \"@loglayer/transport-http\";\nimport { HttpTransport } from \"@loglayer/transport-http\";\n\n/**\n * Configuration options for the Better Stack transport.\n */\nexport interface BetterStackTransportConfig extends Omit<HttpTransportConfig, \"url\" | \"headers\" | \"payloadTemplate\"> {\n /**\n * Better Stack source token for authentication\n */\n sourceToken: string;\n /**\n * Better Stack ingestion host\n */\n url: string;\n /**\n * Whether to include timestamp in the log payload\n * @default true\n */\n includeTimestamp?: boolean;\n /**\n * Custom field name for the timestamp\n * @default \"dt\"\n */\n timestampField?: string;\n}\n\n/**\n * Better Stack transport for sending logs to Better Stack's log management platform.\n *\n * This transport extends the HTTP transport and configures it specifically for Better Stack's API.\n * It handles authentication, payload formatting, and batch sending according to Better Stack's requirements.\n *\n * Features:\n * - Automatic authentication with source token\n * - Proper payload formatting for Better Stack API\n * - Support for custom timestamps\n * - Batch sending with configurable size and timeout\n * - Error handling and retry logic\n * - Compression support\n */\nexport class BetterStackTransport extends HttpTransport {\n /**\n * Creates a new instance of BetterStackTransport.\n *\n * @param config - Configuration options for the transport\n */\n constructor(config: BetterStackTransportConfig) {\n const url = config.url;\n const includeTimestamp = config.includeTimestamp ?? true;\n const timestampField = config.timestampField ?? \"dt\";\n\n // Configure the HTTP transport with Better Stack specific settings\n const httpConfig: HttpTransportConfig = {\n ...config,\n url: url,\n headers: {\n Authorization: `Bearer ${config.sourceToken}`,\n \"Content-Type\": \"application/json\",\n },\n payloadTemplate: (data) => {\n const payload: Record<string, any> = {\n message: data.message,\n };\n\n // Add log level if available\n if (data.logLevel) {\n payload.level = data.logLevel;\n }\n\n // Add metadata if available\n if (data.data) {\n Object.assign(payload, data.data);\n }\n\n // Add timestamp if enabled\n if (includeTimestamp) {\n payload[timestampField] = new Date().toISOString();\n }\n\n return JSON.stringify(payload);\n },\n // Better Stack specific defaults\n batchMode: \"array\",\n batchContentType: \"application/json\",\n enableBatchSend: config.enableBatchSend ?? true,\n batchSize: config.batchSize ?? 100,\n batchSendTimeout: config.batchSendTimeout ?? 5000,\n compression: config.compression ?? false,\n maxRetries: config.maxRetries ?? 3,\n retryDelay: config.retryDelay ?? 1000,\n respectRateLimit: config.respectRateLimit ?? true,\n maxLogSize: config.maxLogSize ?? 1048576, // 1MB\n maxPayloadSize: config.maxPayloadSize ?? 10485760, // 10MB (Better Stack limit)\n };\n\n super(httpConfig);\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,IAAa,uBAAb,cAA0CA,wCAAc;;;;;;CAMtD,YAAY,QAAoC;EAC9C,MAAM,MAAM,OAAO;EACnB,MAAM,mBAAmB,OAAO,oBAAoB;EACpD,MAAM,iBAAiB,OAAO,kBAAkB;EAGhD,MAAMC,aAAkC;GACtC,GAAG;GACE;GACL,SAAS;IACP,eAAe,UAAU,OAAO;IAChC,gBAAgB;IACjB;GACD,kBAAkB,SAAS;IACzB,MAAMC,UAA+B,EACnC,SAAS,KAAK,SACf;AAGD,QAAI,KAAK,SACP,SAAQ,QAAQ,KAAK;AAIvB,QAAI,KAAK,KACP,QAAO,OAAO,SAAS,KAAK,KAAK;AAInC,QAAI,iBACF,SAAQ,mCAAkB,IAAI,MAAM,EAAC,aAAa;AAGpD,WAAO,KAAK,UAAU,QAAQ;;GAGhC,WAAW;GACX,kBAAkB;GAClB,iBAAiB,OAAO,mBAAmB;GAC3C,WAAW,OAAO,aAAa;GAC/B,kBAAkB,OAAO,oBAAoB;GAC7C,aAAa,OAAO,eAAe;GACnC,YAAY,OAAO,cAAc;GACjC,YAAY,OAAO,cAAc;GACjC,kBAAkB,OAAO,oBAAoB;GAC7C,YAAY,OAAO,cAAc;GACjC,gBAAgB,OAAO,kBAAkB;GAC1C;AAED,QAAM,WAAW"}
|
package/dist/index.d.cts
CHANGED
|
@@ -1,27 +1,29 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { HttpTransport, HttpTransportConfig } from "@loglayer/transport-http";
|
|
2
|
+
|
|
3
|
+
//#region src/BetterStackTransport.d.ts
|
|
2
4
|
|
|
3
5
|
/**
|
|
4
6
|
* Configuration options for the Better Stack transport.
|
|
5
7
|
*/
|
|
6
8
|
interface BetterStackTransportConfig extends Omit<HttpTransportConfig, "url" | "headers" | "payloadTemplate"> {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
9
|
+
/**
|
|
10
|
+
* Better Stack source token for authentication
|
|
11
|
+
*/
|
|
12
|
+
sourceToken: string;
|
|
13
|
+
/**
|
|
14
|
+
* Better Stack ingestion host
|
|
15
|
+
*/
|
|
16
|
+
url: string;
|
|
17
|
+
/**
|
|
18
|
+
* Whether to include timestamp in the log payload
|
|
19
|
+
* @default true
|
|
20
|
+
*/
|
|
21
|
+
includeTimestamp?: boolean;
|
|
22
|
+
/**
|
|
23
|
+
* Custom field name for the timestamp
|
|
24
|
+
* @default "dt"
|
|
25
|
+
*/
|
|
26
|
+
timestampField?: string;
|
|
25
27
|
}
|
|
26
28
|
/**
|
|
27
29
|
* Better Stack transport for sending logs to Better Stack's log management platform.
|
|
@@ -38,12 +40,13 @@ interface BetterStackTransportConfig extends Omit<HttpTransportConfig, "url" | "
|
|
|
38
40
|
* - Compression support
|
|
39
41
|
*/
|
|
40
42
|
declare class BetterStackTransport extends HttpTransport {
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
43
|
+
/**
|
|
44
|
+
* Creates a new instance of BetterStackTransport.
|
|
45
|
+
*
|
|
46
|
+
* @param config - Configuration options for the transport
|
|
47
|
+
*/
|
|
48
|
+
constructor(config: BetterStackTransportConfig);
|
|
47
49
|
}
|
|
48
|
-
|
|
50
|
+
//#endregion
|
|
49
51
|
export { BetterStackTransport, type BetterStackTransportConfig };
|
|
52
|
+
//# sourceMappingURL=index.d.cts.map
|
package/dist/index.d.ts
CHANGED
|
@@ -1,27 +1,29 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { HttpTransport, HttpTransportConfig } from "@loglayer/transport-http";
|
|
2
|
+
|
|
3
|
+
//#region src/BetterStackTransport.d.ts
|
|
2
4
|
|
|
3
5
|
/**
|
|
4
6
|
* Configuration options for the Better Stack transport.
|
|
5
7
|
*/
|
|
6
8
|
interface BetterStackTransportConfig extends Omit<HttpTransportConfig, "url" | "headers" | "payloadTemplate"> {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
9
|
+
/**
|
|
10
|
+
* Better Stack source token for authentication
|
|
11
|
+
*/
|
|
12
|
+
sourceToken: string;
|
|
13
|
+
/**
|
|
14
|
+
* Better Stack ingestion host
|
|
15
|
+
*/
|
|
16
|
+
url: string;
|
|
17
|
+
/**
|
|
18
|
+
* Whether to include timestamp in the log payload
|
|
19
|
+
* @default true
|
|
20
|
+
*/
|
|
21
|
+
includeTimestamp?: boolean;
|
|
22
|
+
/**
|
|
23
|
+
* Custom field name for the timestamp
|
|
24
|
+
* @default "dt"
|
|
25
|
+
*/
|
|
26
|
+
timestampField?: string;
|
|
25
27
|
}
|
|
26
28
|
/**
|
|
27
29
|
* Better Stack transport for sending logs to Better Stack's log management platform.
|
|
@@ -38,12 +40,13 @@ interface BetterStackTransportConfig extends Omit<HttpTransportConfig, "url" | "
|
|
|
38
40
|
* - Compression support
|
|
39
41
|
*/
|
|
40
42
|
declare class BetterStackTransport extends HttpTransport {
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
43
|
+
/**
|
|
44
|
+
* Creates a new instance of BetterStackTransport.
|
|
45
|
+
*
|
|
46
|
+
* @param config - Configuration options for the transport
|
|
47
|
+
*/
|
|
48
|
+
constructor(config: BetterStackTransportConfig);
|
|
47
49
|
}
|
|
48
|
-
|
|
50
|
+
//#endregion
|
|
49
51
|
export { BetterStackTransport, type BetterStackTransportConfig };
|
|
52
|
+
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.js
CHANGED
|
@@ -1,56 +1,60 @@
|
|
|
1
|
-
// src/BetterStackTransport.ts
|
|
2
1
|
import { HttpTransport } from "@loglayer/transport-http";
|
|
2
|
+
|
|
3
|
+
//#region src/BetterStackTransport.ts
|
|
4
|
+
/**
|
|
5
|
+
* Better Stack transport for sending logs to Better Stack's log management platform.
|
|
6
|
+
*
|
|
7
|
+
* This transport extends the HTTP transport and configures it specifically for Better Stack's API.
|
|
8
|
+
* It handles authentication, payload formatting, and batch sending according to Better Stack's requirements.
|
|
9
|
+
*
|
|
10
|
+
* Features:
|
|
11
|
+
* - Automatic authentication with source token
|
|
12
|
+
* - Proper payload formatting for Better Stack API
|
|
13
|
+
* - Support for custom timestamps
|
|
14
|
+
* - Batch sending with configurable size and timeout
|
|
15
|
+
* - Error handling and retry logic
|
|
16
|
+
* - Compression support
|
|
17
|
+
*/
|
|
3
18
|
var BetterStackTransport = class extends HttpTransport {
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
compression: config.compression ?? false,
|
|
42
|
-
maxRetries: config.maxRetries ?? 3,
|
|
43
|
-
retryDelay: config.retryDelay ?? 1e3,
|
|
44
|
-
respectRateLimit: config.respectRateLimit ?? true,
|
|
45
|
-
maxLogSize: config.maxLogSize ?? 1048576,
|
|
46
|
-
// 1MB
|
|
47
|
-
maxPayloadSize: config.maxPayloadSize ?? 10485760
|
|
48
|
-
// 10MB (Better Stack limit)
|
|
49
|
-
};
|
|
50
|
-
super(httpConfig);
|
|
51
|
-
}
|
|
52
|
-
};
|
|
53
|
-
export {
|
|
54
|
-
BetterStackTransport
|
|
19
|
+
/**
|
|
20
|
+
* Creates a new instance of BetterStackTransport.
|
|
21
|
+
*
|
|
22
|
+
* @param config - Configuration options for the transport
|
|
23
|
+
*/
|
|
24
|
+
constructor(config) {
|
|
25
|
+
const url = config.url;
|
|
26
|
+
const includeTimestamp = config.includeTimestamp ?? true;
|
|
27
|
+
const timestampField = config.timestampField ?? "dt";
|
|
28
|
+
const httpConfig = {
|
|
29
|
+
...config,
|
|
30
|
+
url,
|
|
31
|
+
headers: {
|
|
32
|
+
Authorization: `Bearer ${config.sourceToken}`,
|
|
33
|
+
"Content-Type": "application/json"
|
|
34
|
+
},
|
|
35
|
+
payloadTemplate: (data) => {
|
|
36
|
+
const payload = { message: data.message };
|
|
37
|
+
if (data.logLevel) payload.level = data.logLevel;
|
|
38
|
+
if (data.data) Object.assign(payload, data.data);
|
|
39
|
+
if (includeTimestamp) payload[timestampField] = (/* @__PURE__ */ new Date()).toISOString();
|
|
40
|
+
return JSON.stringify(payload);
|
|
41
|
+
},
|
|
42
|
+
batchMode: "array",
|
|
43
|
+
batchContentType: "application/json",
|
|
44
|
+
enableBatchSend: config.enableBatchSend ?? true,
|
|
45
|
+
batchSize: config.batchSize ?? 100,
|
|
46
|
+
batchSendTimeout: config.batchSendTimeout ?? 5e3,
|
|
47
|
+
compression: config.compression ?? false,
|
|
48
|
+
maxRetries: config.maxRetries ?? 3,
|
|
49
|
+
retryDelay: config.retryDelay ?? 1e3,
|
|
50
|
+
respectRateLimit: config.respectRateLimit ?? true,
|
|
51
|
+
maxLogSize: config.maxLogSize ?? 1048576,
|
|
52
|
+
maxPayloadSize: config.maxPayloadSize ?? 10485760
|
|
53
|
+
};
|
|
54
|
+
super(httpConfig);
|
|
55
|
+
}
|
|
55
56
|
};
|
|
57
|
+
|
|
58
|
+
//#endregion
|
|
59
|
+
export { BetterStackTransport };
|
|
56
60
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/BetterStackTransport.ts"],"sourcesContent":["import type { HttpTransportConfig } from \"@loglayer/transport-http\";\nimport { HttpTransport } from \"@loglayer/transport-http\";\n\n/**\n * Configuration options for the Better Stack transport.\n */\nexport interface BetterStackTransportConfig extends Omit<HttpTransportConfig, \"url\" | \"headers\" | \"payloadTemplate\"> {\n /**\n * Better Stack source token for authentication\n */\n sourceToken: string;\n /**\n * Better Stack ingestion host\n */\n url: string;\n /**\n * Whether to include timestamp in the log payload\n * @default true\n */\n includeTimestamp?: boolean;\n /**\n * Custom field name for the timestamp\n * @default \"dt\"\n */\n timestampField?: string;\n}\n\n/**\n * Better Stack transport for sending logs to Better Stack's log management platform.\n *\n * This transport extends the HTTP transport and configures it specifically for Better Stack's API.\n * It handles authentication, payload formatting, and batch sending according to Better Stack's requirements.\n *\n * Features:\n * - Automatic authentication with source token\n * - Proper payload formatting for Better Stack API\n * - Support for custom timestamps\n * - Batch sending with configurable size and timeout\n * - Error handling and retry logic\n * - Compression support\n */\nexport class BetterStackTransport extends HttpTransport {\n /**\n * Creates a new instance of BetterStackTransport.\n *\n * @param config - Configuration options for the transport\n */\n constructor(config: BetterStackTransportConfig) {\n const url = config.url;\n const includeTimestamp = config.includeTimestamp ?? true;\n const timestampField = config.timestampField ?? \"dt\";\n\n // Configure the HTTP transport with Better Stack specific settings\n const httpConfig: HttpTransportConfig = {\n ...config,\n url: url,\n headers: {\n Authorization: `Bearer ${config.sourceToken}`,\n \"Content-Type\": \"application/json\",\n },\n payloadTemplate: (data) => {\n const payload: Record<string, any> = {\n message: data.message,\n };\n\n // Add log level if available\n if (data.logLevel) {\n payload.level = data.logLevel;\n }\n\n // Add metadata if available\n if (data.data) {\n Object.assign(payload, data.data);\n }\n\n // Add timestamp if enabled\n if (includeTimestamp) {\n payload[timestampField] = new Date().toISOString();\n }\n\n return JSON.stringify(payload);\n },\n // Better Stack specific defaults\n batchMode: \"array\",\n batchContentType: \"application/json\",\n enableBatchSend: config.enableBatchSend ?? true,\n batchSize: config.batchSize ?? 100,\n batchSendTimeout: config.batchSendTimeout ?? 5000,\n compression: config.compression ?? false,\n maxRetries: config.maxRetries ?? 3,\n retryDelay: config.retryDelay ?? 1000,\n respectRateLimit: config.respectRateLimit ?? true,\n maxLogSize: config.maxLogSize ?? 1048576, // 1MB\n maxPayloadSize: config.maxPayloadSize ?? 10485760, // 10MB (Better Stack limit)\n };\n\n super(httpConfig);\n }\n}\n"],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","names":["httpConfig: HttpTransportConfig","payload: Record<string, any>"],"sources":["../src/BetterStackTransport.ts"],"sourcesContent":["import type { HttpTransportConfig } from \"@loglayer/transport-http\";\nimport { HttpTransport } from \"@loglayer/transport-http\";\n\n/**\n * Configuration options for the Better Stack transport.\n */\nexport interface BetterStackTransportConfig extends Omit<HttpTransportConfig, \"url\" | \"headers\" | \"payloadTemplate\"> {\n /**\n * Better Stack source token for authentication\n */\n sourceToken: string;\n /**\n * Better Stack ingestion host\n */\n url: string;\n /**\n * Whether to include timestamp in the log payload\n * @default true\n */\n includeTimestamp?: boolean;\n /**\n * Custom field name for the timestamp\n * @default \"dt\"\n */\n timestampField?: string;\n}\n\n/**\n * Better Stack transport for sending logs to Better Stack's log management platform.\n *\n * This transport extends the HTTP transport and configures it specifically for Better Stack's API.\n * It handles authentication, payload formatting, and batch sending according to Better Stack's requirements.\n *\n * Features:\n * - Automatic authentication with source token\n * - Proper payload formatting for Better Stack API\n * - Support for custom timestamps\n * - Batch sending with configurable size and timeout\n * - Error handling and retry logic\n * - Compression support\n */\nexport class BetterStackTransport extends HttpTransport {\n /**\n * Creates a new instance of BetterStackTransport.\n *\n * @param config - Configuration options for the transport\n */\n constructor(config: BetterStackTransportConfig) {\n const url = config.url;\n const includeTimestamp = config.includeTimestamp ?? true;\n const timestampField = config.timestampField ?? \"dt\";\n\n // Configure the HTTP transport with Better Stack specific settings\n const httpConfig: HttpTransportConfig = {\n ...config,\n url: url,\n headers: {\n Authorization: `Bearer ${config.sourceToken}`,\n \"Content-Type\": \"application/json\",\n },\n payloadTemplate: (data) => {\n const payload: Record<string, any> = {\n message: data.message,\n };\n\n // Add log level if available\n if (data.logLevel) {\n payload.level = data.logLevel;\n }\n\n // Add metadata if available\n if (data.data) {\n Object.assign(payload, data.data);\n }\n\n // Add timestamp if enabled\n if (includeTimestamp) {\n payload[timestampField] = new Date().toISOString();\n }\n\n return JSON.stringify(payload);\n },\n // Better Stack specific defaults\n batchMode: \"array\",\n batchContentType: \"application/json\",\n enableBatchSend: config.enableBatchSend ?? true,\n batchSize: config.batchSize ?? 100,\n batchSendTimeout: config.batchSendTimeout ?? 5000,\n compression: config.compression ?? false,\n maxRetries: config.maxRetries ?? 3,\n retryDelay: config.retryDelay ?? 1000,\n respectRateLimit: config.respectRateLimit ?? true,\n maxLogSize: config.maxLogSize ?? 1048576, // 1MB\n maxPayloadSize: config.maxPayloadSize ?? 10485760, // 10MB (Better Stack limit)\n };\n\n super(httpConfig);\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAyCA,IAAa,uBAAb,cAA0C,cAAc;;;;;;CAMtD,YAAY,QAAoC;EAC9C,MAAM,MAAM,OAAO;EACnB,MAAM,mBAAmB,OAAO,oBAAoB;EACpD,MAAM,iBAAiB,OAAO,kBAAkB;EAGhD,MAAMA,aAAkC;GACtC,GAAG;GACE;GACL,SAAS;IACP,eAAe,UAAU,OAAO;IAChC,gBAAgB;IACjB;GACD,kBAAkB,SAAS;IACzB,MAAMC,UAA+B,EACnC,SAAS,KAAK,SACf;AAGD,QAAI,KAAK,SACP,SAAQ,QAAQ,KAAK;AAIvB,QAAI,KAAK,KACP,QAAO,OAAO,SAAS,KAAK,KAAK;AAInC,QAAI,iBACF,SAAQ,mCAAkB,IAAI,MAAM,EAAC,aAAa;AAGpD,WAAO,KAAK,UAAU,QAAQ;;GAGhC,WAAW;GACX,kBAAkB;GAClB,iBAAiB,OAAO,mBAAmB;GAC3C,WAAW,OAAO,aAAa;GAC/B,kBAAkB,OAAO,oBAAoB;GAC7C,aAAa,OAAO,eAAe;GACnC,YAAY,OAAO,cAAc;GACjC,YAAY,OAAO,cAAc;GACjC,kBAAkB,OAAO,oBAAoB;GAC7C,YAAY,OAAO,cAAc;GACjC,gBAAgB,OAAO,kBAAkB;GAC1C;AAED,QAAM,WAAW"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@loglayer/transport-betterstack",
|
|
3
3
|
"description": "Better Stack transport for the LogLayer logging library.",
|
|
4
|
-
"version": "1.0.
|
|
4
|
+
"version": "1.0.2",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
7
7
|
"module": "./dist/index.js",
|
|
@@ -32,19 +32,19 @@
|
|
|
32
32
|
"better stack"
|
|
33
33
|
],
|
|
34
34
|
"dependencies": {
|
|
35
|
-
"@loglayer/transport": "2.3.
|
|
36
|
-
"@loglayer/transport-http": "1.1.
|
|
35
|
+
"@loglayer/transport": "2.3.5",
|
|
36
|
+
"@loglayer/transport-http": "1.1.3"
|
|
37
37
|
},
|
|
38
38
|
"devDependencies": {
|
|
39
|
+
"@types/node": "24.9.2",
|
|
39
40
|
"dotenv": "17.2.3",
|
|
40
|
-
"@types/node": "24.6.1",
|
|
41
41
|
"serialize-error": "12.0.0",
|
|
42
|
+
"tsdown": "0.15.12",
|
|
42
43
|
"tsx": "4.20.6",
|
|
43
|
-
"tsup": "8.5.0",
|
|
44
44
|
"typescript": "5.9.3",
|
|
45
|
-
"vitest": "
|
|
46
|
-
"
|
|
47
|
-
"
|
|
45
|
+
"vitest": "4.0.6",
|
|
46
|
+
"@internal/tsconfig": "2.1.0",
|
|
47
|
+
"loglayer": "7.1.0"
|
|
48
48
|
},
|
|
49
49
|
"bugs": "https://github.com/loglayer/loglayer/issues",
|
|
50
50
|
"engines": {
|
|
@@ -55,7 +55,7 @@
|
|
|
55
55
|
],
|
|
56
56
|
"homepage": "https://loglayer.dev",
|
|
57
57
|
"scripts": {
|
|
58
|
-
"build": "
|
|
58
|
+
"build": "tsdown src/index.ts",
|
|
59
59
|
"test": "vitest --run",
|
|
60
60
|
"clean": "rm -rf .turbo node_modules dist",
|
|
61
61
|
"lint": "biome check --no-errors-on-unmatched --write --unsafe src",
|