@loggerjs/elastic 0.0.1
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/LICENSE +21 -0
- package/README.md +22 -0
- package/dist/index.cjs +99 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.ts +32 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +96 -0
- package/dist/index.js.map +1 -0
- package/package.json +52 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 loggerjs contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# @loggerjs/elastic
|
|
2
|
+
|
|
3
|
+
Elasticsearch and Elastic Cloud `_bulk` transport for loggerjs.
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
import { createLogger } from "@loggerjs/core";
|
|
7
|
+
import { elasticTransport } from "@loggerjs/elastic";
|
|
8
|
+
|
|
9
|
+
const logger = createLogger({
|
|
10
|
+
transports: [
|
|
11
|
+
elasticTransport({
|
|
12
|
+
url: "https://elastic.example.com",
|
|
13
|
+
index: "loggerjs-logs",
|
|
14
|
+
apiKey: process.env.ELASTIC_API_KEY,
|
|
15
|
+
}),
|
|
16
|
+
],
|
|
17
|
+
});
|
|
18
|
+
|
|
19
|
+
logger.info("indexed");
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Subpaths expose `transport`.
|
package/dist/index.cjs
ADDED
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
|
+
let _loggerjs_core = require("@loggerjs/core");
|
|
3
|
+
//#region src/index.ts
|
|
4
|
+
function compact(value) {
|
|
5
|
+
for (const key of Object.keys(value)) if (value[key] === void 0) delete value[key];
|
|
6
|
+
return value;
|
|
7
|
+
}
|
|
8
|
+
function defaultBulkUrl(url, refresh) {
|
|
9
|
+
const base = url.endsWith("/_bulk") ? url : `${url.replace(/\/+$/, "")}/_bulk`;
|
|
10
|
+
if (refresh === void 0) return base;
|
|
11
|
+
return `${base}${base.includes("?") ? "&" : "?"}refresh=${encodeURIComponent(String(refresh))}`;
|
|
12
|
+
}
|
|
13
|
+
function selectedIndex(event, index) {
|
|
14
|
+
return typeof index === "function" ? index(event) : index;
|
|
15
|
+
}
|
|
16
|
+
function selectedPipeline(event, pipeline) {
|
|
17
|
+
return typeof pipeline === "function" ? pipeline(event) : pipeline;
|
|
18
|
+
}
|
|
19
|
+
function toElasticDocument(event) {
|
|
20
|
+
return compact({
|
|
21
|
+
"@timestamp": new Date(event.time).toISOString(),
|
|
22
|
+
message: event.message,
|
|
23
|
+
log: {
|
|
24
|
+
level: event.levelName,
|
|
25
|
+
logger: event.logger
|
|
26
|
+
},
|
|
27
|
+
event: {
|
|
28
|
+
action: event.type,
|
|
29
|
+
sequence: event.seq
|
|
30
|
+
},
|
|
31
|
+
labels: event.tags,
|
|
32
|
+
data: event.data,
|
|
33
|
+
error: event.error,
|
|
34
|
+
trace: event.trace,
|
|
35
|
+
context: event.context,
|
|
36
|
+
loggerjs: {
|
|
37
|
+
id: event.id,
|
|
38
|
+
level: event.level,
|
|
39
|
+
source: event.source
|
|
40
|
+
}
|
|
41
|
+
});
|
|
42
|
+
}
|
|
43
|
+
function createElasticBulkPayload(events, options = {}) {
|
|
44
|
+
const lines = [];
|
|
45
|
+
const opType = options.opType ?? "index";
|
|
46
|
+
const document = options.document ?? toElasticDocument;
|
|
47
|
+
for (const event of events) {
|
|
48
|
+
const metadata = compact({
|
|
49
|
+
_index: selectedIndex(event, options.index),
|
|
50
|
+
_id: options.id?.(event),
|
|
51
|
+
pipeline: selectedPipeline(event, options.pipeline)
|
|
52
|
+
});
|
|
53
|
+
const action = opType === "create" ? { create: metadata } : { index: metadata };
|
|
54
|
+
lines.push(JSON.stringify(action));
|
|
55
|
+
lines.push(JSON.stringify(document(event)));
|
|
56
|
+
}
|
|
57
|
+
return lines.length > 0 ? `${lines.join("\n")}\n` : "";
|
|
58
|
+
}
|
|
59
|
+
function elasticTransport(options) {
|
|
60
|
+
const fetchFn = options.fetchFn ?? globalThis.fetch?.bind(globalThis);
|
|
61
|
+
const transportName = options.name ?? "elastic";
|
|
62
|
+
const url = defaultBulkUrl(options.url, options.refresh);
|
|
63
|
+
const checkBulkErrors = options.checkBulkErrors ?? true;
|
|
64
|
+
const send = async (events) => {
|
|
65
|
+
if (events.length === 0) return;
|
|
66
|
+
if (!fetchFn) throw new Error("fetch is not available for elasticTransport");
|
|
67
|
+
const headers = {
|
|
68
|
+
"content-type": "application/x-ndjson",
|
|
69
|
+
...options.headers
|
|
70
|
+
};
|
|
71
|
+
if (options.apiKey) headers.authorization = `ApiKey ${options.apiKey}`;
|
|
72
|
+
const response = await fetchFn(url, {
|
|
73
|
+
method: "POST",
|
|
74
|
+
headers,
|
|
75
|
+
body: createElasticBulkPayload(events, options)
|
|
76
|
+
});
|
|
77
|
+
if (!response.ok) throw new Error(`elasticTransport failed with status ${response.status}`);
|
|
78
|
+
if (checkBulkErrors) {
|
|
79
|
+
if ((await response.json().catch(() => void 0))?.errors) throw new Error("elasticTransport bulk response contains item errors");
|
|
80
|
+
}
|
|
81
|
+
};
|
|
82
|
+
return {
|
|
83
|
+
name: transportName,
|
|
84
|
+
minLevel: options.minLevel,
|
|
85
|
+
log(event) {
|
|
86
|
+
if (options.minLevel !== void 0 && event.level < (0, _loggerjs_core.toLevelValue)(options.minLevel)) return;
|
|
87
|
+
return send([event]);
|
|
88
|
+
},
|
|
89
|
+
logBatch(events) {
|
|
90
|
+
return send([...options.minLevel === void 0 ? events : events.filter((event) => event.level >= (0, _loggerjs_core.toLevelValue)(options.minLevel))]);
|
|
91
|
+
}
|
|
92
|
+
};
|
|
93
|
+
}
|
|
94
|
+
//#endregion
|
|
95
|
+
exports.createElasticBulkPayload = createElasticBulkPayload;
|
|
96
|
+
exports.elasticTransport = elasticTransport;
|
|
97
|
+
exports.toElasticDocument = toElasticDocument;
|
|
98
|
+
|
|
99
|
+
//# sourceMappingURL=index.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.cjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { toLevelValue, type LogEvent, type LoggerLevel, type Transport } from \"@loggerjs/core\";\n\nexport type ElasticIndexSelector = string | ((event: LogEvent) => string);\nexport type ElasticOpType = \"create\" | \"index\";\n\nexport interface ElasticTransportOptions {\n url: string;\n name?: string;\n minLevel?: LoggerLevel;\n index?: ElasticIndexSelector;\n opType?: ElasticOpType;\n pipeline?: string | ((event: LogEvent) => string | undefined);\n id?: (event: LogEvent) => string | undefined;\n headers?: Record<string, string>;\n apiKey?: string;\n refresh?: boolean | \"wait_for\";\n checkBulkErrors?: boolean;\n document?: (event: LogEvent) => Record<string, unknown>;\n fetchFn?: typeof fetch;\n}\n\nexport interface ElasticBulkActionMetadata {\n _index?: string;\n _id?: string;\n pipeline?: string;\n}\n\nexport type ElasticBulkAction =\n | { create: ElasticBulkActionMetadata }\n | { index: ElasticBulkActionMetadata };\n\nfunction compact<T extends Record<string, unknown>>(value: T): T {\n for (const key of Object.keys(value)) {\n if (value[key] === undefined) delete value[key];\n }\n return value;\n}\n\nfunction defaultBulkUrl(url: string, refresh: ElasticTransportOptions[\"refresh\"]): string {\n const base = url.endsWith(\"/_bulk\") ? url : `${url.replace(/\\/+$/, \"\")}/_bulk`;\n if (refresh === undefined) return base;\n const separator = base.includes(\"?\") ? \"&\" : \"?\";\n return `${base}${separator}refresh=${encodeURIComponent(String(refresh))}`;\n}\n\nfunction selectedIndex(event: LogEvent, index: ElasticIndexSelector | undefined) {\n return typeof index === \"function\" ? index(event) : index;\n}\n\nfunction selectedPipeline(event: LogEvent, pipeline: ElasticTransportOptions[\"pipeline\"]) {\n return typeof pipeline === \"function\" ? pipeline(event) : pipeline;\n}\n\nexport function toElasticDocument(event: LogEvent): Record<string, unknown> {\n return compact({\n \"@timestamp\": new Date(event.time).toISOString(),\n message: event.message,\n log: {\n level: event.levelName,\n logger: event.logger,\n },\n event: {\n action: event.type,\n sequence: event.seq,\n },\n labels: event.tags,\n data: event.data,\n error: event.error,\n trace: event.trace,\n context: event.context,\n loggerjs: {\n id: event.id,\n level: event.level,\n source: event.source,\n },\n });\n}\n\nexport function createElasticBulkPayload(\n events: readonly LogEvent[],\n options: Pick<ElasticTransportOptions, \"document\" | \"id\" | \"index\" | \"opType\" | \"pipeline\"> = {},\n): string {\n const lines: string[] = [];\n const opType = options.opType ?? \"index\";\n const document = options.document ?? toElasticDocument;\n\n for (const event of events) {\n const metadata = compact({\n _index: selectedIndex(event, options.index),\n _id: options.id?.(event),\n pipeline: selectedPipeline(event, options.pipeline),\n });\n const action: ElasticBulkAction =\n opType === \"create\" ? { create: metadata } : { index: metadata };\n lines.push(JSON.stringify(action));\n lines.push(JSON.stringify(document(event)));\n }\n\n return lines.length > 0 ? `${lines.join(\"\\n\")}\\n` : \"\";\n}\n\nexport function elasticTransport(options: ElasticTransportOptions): Transport {\n const fetchFn = options.fetchFn ?? globalThis.fetch?.bind(globalThis);\n const transportName = options.name ?? \"elastic\";\n const url = defaultBulkUrl(options.url, options.refresh);\n const checkBulkErrors = options.checkBulkErrors ?? true;\n\n const send = async (events: LogEvent[]) => {\n if (events.length === 0) return;\n if (!fetchFn) throw new Error(\"fetch is not available for elasticTransport\");\n const headers: Record<string, string> = {\n \"content-type\": \"application/x-ndjson\",\n ...options.headers,\n };\n if (options.apiKey) headers.authorization = `ApiKey ${options.apiKey}`;\n\n const response = await fetchFn(url, {\n method: \"POST\",\n headers,\n body: createElasticBulkPayload(events, options),\n });\n if (!response.ok) throw new Error(`elasticTransport failed with status ${response.status}`);\n\n if (checkBulkErrors) {\n const result = (await response.json().catch(() => undefined)) as\n | { errors?: boolean }\n | undefined;\n if (result?.errors) throw new Error(\"elasticTransport bulk response contains item errors\");\n }\n };\n\n return {\n name: transportName,\n minLevel: options.minLevel,\n log(event) {\n if (options.minLevel !== undefined && event.level < toLevelValue(options.minLevel)) return;\n return send([event]);\n },\n logBatch(events) {\n const selected =\n options.minLevel === undefined\n ? events\n : events.filter((event) => event.level >= toLevelValue(options.minLevel));\n return send([...selected]);\n },\n };\n}\n"],"mappings":";;;AA+BA,SAAS,QAA2C,OAAa;CAC/D,KAAK,MAAM,OAAO,OAAO,KAAK,KAAK,GACjC,IAAI,MAAM,SAAS,KAAA,GAAW,OAAO,MAAM;CAE7C,OAAO;AACT;AAEA,SAAS,eAAe,KAAa,SAAqD;CACxF,MAAM,OAAO,IAAI,SAAS,QAAQ,IAAI,MAAM,GAAG,IAAI,QAAQ,QAAQ,EAAE,EAAE;CACvE,IAAI,YAAY,KAAA,GAAW,OAAO;CAElC,OAAO,GAAG,OADQ,KAAK,SAAS,GAAG,IAAI,MAAM,IAClB,UAAU,mBAAmB,OAAO,OAAO,CAAC;AACzE;AAEA,SAAS,cAAc,OAAiB,OAAyC;CAC/E,OAAO,OAAO,UAAU,aAAa,MAAM,KAAK,IAAI;AACtD;AAEA,SAAS,iBAAiB,OAAiB,UAA+C;CACxF,OAAO,OAAO,aAAa,aAAa,SAAS,KAAK,IAAI;AAC5D;AAEA,SAAgB,kBAAkB,OAA0C;CAC1E,OAAO,QAAQ;EACb,cAAc,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,YAAY;EAC/C,SAAS,MAAM;EACf,KAAK;GACH,OAAO,MAAM;GACb,QAAQ,MAAM;EAChB;EACA,OAAO;GACL,QAAQ,MAAM;GACd,UAAU,MAAM;EAClB;EACA,QAAQ,MAAM;EACd,MAAM,MAAM;EACZ,OAAO,MAAM;EACb,OAAO,MAAM;EACb,SAAS,MAAM;EACf,UAAU;GACR,IAAI,MAAM;GACV,OAAO,MAAM;GACb,QAAQ,MAAM;EAChB;CACF,CAAC;AACH;AAEA,SAAgB,yBACd,QACA,UAA8F,CAAC,GACvF;CACR,MAAM,QAAkB,CAAC;CACzB,MAAM,SAAS,QAAQ,UAAU;CACjC,MAAM,WAAW,QAAQ,YAAY;CAErC,KAAK,MAAM,SAAS,QAAQ;EAC1B,MAAM,WAAW,QAAQ;GACvB,QAAQ,cAAc,OAAO,QAAQ,KAAK;GAC1C,KAAK,QAAQ,KAAK,KAAK;GACvB,UAAU,iBAAiB,OAAO,QAAQ,QAAQ;EACpD,CAAC;EACD,MAAM,SACJ,WAAW,WAAW,EAAE,QAAQ,SAAS,IAAI,EAAE,OAAO,SAAS;EACjE,MAAM,KAAK,KAAK,UAAU,MAAM,CAAC;EACjC,MAAM,KAAK,KAAK,UAAU,SAAS,KAAK,CAAC,CAAC;CAC5C;CAEA,OAAO,MAAM,SAAS,IAAI,GAAG,MAAM,KAAK,IAAI,EAAE,MAAM;AACtD;AAEA,SAAgB,iBAAiB,SAA6C;CAC5E,MAAM,UAAU,QAAQ,WAAW,WAAW,OAAO,KAAK,UAAU;CACpE,MAAM,gBAAgB,QAAQ,QAAQ;CACtC,MAAM,MAAM,eAAe,QAAQ,KAAK,QAAQ,OAAO;CACvD,MAAM,kBAAkB,QAAQ,mBAAmB;CAEnD,MAAM,OAAO,OAAO,WAAuB;EACzC,IAAI,OAAO,WAAW,GAAG;EACzB,IAAI,CAAC,SAAS,MAAM,IAAI,MAAM,6CAA6C;EAC3E,MAAM,UAAkC;GACtC,gBAAgB;GAChB,GAAG,QAAQ;EACb;EACA,IAAI,QAAQ,QAAQ,QAAQ,gBAAgB,UAAU,QAAQ;EAE9D,MAAM,WAAW,MAAM,QAAQ,KAAK;GAClC,QAAQ;GACR;GACA,MAAM,yBAAyB,QAAQ,OAAO;EAChD,CAAC;EACD,IAAI,CAAC,SAAS,IAAI,MAAM,IAAI,MAAM,uCAAuC,SAAS,QAAQ;EAE1F,IAAI;QAIE,MAHkB,SAAS,KAAK,CAAC,CAAC,YAAY,KAAA,CAAS,EAAA,EAG/C,QAAQ,MAAM,IAAI,MAAM,qDAAqD;EAAA;CAE7F;CAEA,OAAO;EACL,MAAM;EACN,UAAU,QAAQ;EAClB,IAAI,OAAO;GACT,IAAI,QAAQ,aAAa,KAAA,KAAa,MAAM,SAAA,GAAA,eAAA,aAAA,CAAqB,QAAQ,QAAQ,GAAG;GACpF,OAAO,KAAK,CAAC,KAAK,CAAC;EACrB;EACA,SAAS,QAAQ;GAKf,OAAO,KAAK,CAAC,GAHX,QAAQ,aAAa,KAAA,IACjB,SACA,OAAO,QAAQ,UAAU,MAAM,UAAA,GAAA,eAAA,aAAA,CAAsB,QAAQ,QAAQ,CAAC,CACpD,CAAC;EAC3B;CACF;AACF"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { type LogEvent, type LoggerLevel, type Transport } from "@loggerjs/core";
|
|
2
|
+
export type ElasticIndexSelector = string | ((event: LogEvent) => string);
|
|
3
|
+
export type ElasticOpType = "create" | "index";
|
|
4
|
+
export interface ElasticTransportOptions {
|
|
5
|
+
url: string;
|
|
6
|
+
name?: string;
|
|
7
|
+
minLevel?: LoggerLevel;
|
|
8
|
+
index?: ElasticIndexSelector;
|
|
9
|
+
opType?: ElasticOpType;
|
|
10
|
+
pipeline?: string | ((event: LogEvent) => string | undefined);
|
|
11
|
+
id?: (event: LogEvent) => string | undefined;
|
|
12
|
+
headers?: Record<string, string>;
|
|
13
|
+
apiKey?: string;
|
|
14
|
+
refresh?: boolean | "wait_for";
|
|
15
|
+
checkBulkErrors?: boolean;
|
|
16
|
+
document?: (event: LogEvent) => Record<string, unknown>;
|
|
17
|
+
fetchFn?: typeof fetch;
|
|
18
|
+
}
|
|
19
|
+
export interface ElasticBulkActionMetadata {
|
|
20
|
+
_index?: string;
|
|
21
|
+
_id?: string;
|
|
22
|
+
pipeline?: string;
|
|
23
|
+
}
|
|
24
|
+
export type ElasticBulkAction = {
|
|
25
|
+
create: ElasticBulkActionMetadata;
|
|
26
|
+
} | {
|
|
27
|
+
index: ElasticBulkActionMetadata;
|
|
28
|
+
};
|
|
29
|
+
export declare function toElasticDocument(event: LogEvent): Record<string, unknown>;
|
|
30
|
+
export declare function createElasticBulkPayload(events: readonly LogEvent[], options?: Pick<ElasticTransportOptions, "document" | "id" | "index" | "opType" | "pipeline">): string;
|
|
31
|
+
export declare function elasticTransport(options: ElasticTransportOptions): Transport;
|
|
32
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,QAAQ,EAAE,KAAK,WAAW,EAAE,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE/F,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,QAAQ,KAAK,MAAM,CAAC,CAAC;AAC1E,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE/C,MAAM,WAAW,uBAAuB;IACtC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,WAAW,CAAC;IACvB,KAAK,CAAC,EAAE,oBAAoB,CAAC;IAC7B,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,QAAQ,KAAK,MAAM,GAAG,SAAS,CAAC,CAAC;IAC9D,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,MAAM,GAAG,SAAS,CAAC;IAC7C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,GAAG,UAAU,CAAC;IAC/B,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxD,OAAO,CAAC,EAAE,OAAO,KAAK,CAAC;CACxB;AAED,MAAM,WAAW,yBAAyB;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,iBAAiB,GACzB;IAAE,MAAM,EAAE,yBAAyB,CAAA;CAAE,GACrC;IAAE,KAAK,EAAE,yBAAyB,CAAA;CAAE,CAAC;AAwBzC,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAuB1E;AAED,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,SAAS,QAAQ,EAAE,EAC3B,OAAO,GAAE,IAAI,CAAC,uBAAuB,EAAE,UAAU,GAAG,IAAI,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAM,GAC/F,MAAM,CAkBR;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,SAAS,CA6C5E"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
import { toLevelValue } from "@loggerjs/core";
|
|
2
|
+
//#region src/index.ts
|
|
3
|
+
function compact(value) {
|
|
4
|
+
for (const key of Object.keys(value)) if (value[key] === void 0) delete value[key];
|
|
5
|
+
return value;
|
|
6
|
+
}
|
|
7
|
+
function defaultBulkUrl(url, refresh) {
|
|
8
|
+
const base = url.endsWith("/_bulk") ? url : `${url.replace(/\/+$/, "")}/_bulk`;
|
|
9
|
+
if (refresh === void 0) return base;
|
|
10
|
+
return `${base}${base.includes("?") ? "&" : "?"}refresh=${encodeURIComponent(String(refresh))}`;
|
|
11
|
+
}
|
|
12
|
+
function selectedIndex(event, index) {
|
|
13
|
+
return typeof index === "function" ? index(event) : index;
|
|
14
|
+
}
|
|
15
|
+
function selectedPipeline(event, pipeline) {
|
|
16
|
+
return typeof pipeline === "function" ? pipeline(event) : pipeline;
|
|
17
|
+
}
|
|
18
|
+
function toElasticDocument(event) {
|
|
19
|
+
return compact({
|
|
20
|
+
"@timestamp": new Date(event.time).toISOString(),
|
|
21
|
+
message: event.message,
|
|
22
|
+
log: {
|
|
23
|
+
level: event.levelName,
|
|
24
|
+
logger: event.logger
|
|
25
|
+
},
|
|
26
|
+
event: {
|
|
27
|
+
action: event.type,
|
|
28
|
+
sequence: event.seq
|
|
29
|
+
},
|
|
30
|
+
labels: event.tags,
|
|
31
|
+
data: event.data,
|
|
32
|
+
error: event.error,
|
|
33
|
+
trace: event.trace,
|
|
34
|
+
context: event.context,
|
|
35
|
+
loggerjs: {
|
|
36
|
+
id: event.id,
|
|
37
|
+
level: event.level,
|
|
38
|
+
source: event.source
|
|
39
|
+
}
|
|
40
|
+
});
|
|
41
|
+
}
|
|
42
|
+
function createElasticBulkPayload(events, options = {}) {
|
|
43
|
+
const lines = [];
|
|
44
|
+
const opType = options.opType ?? "index";
|
|
45
|
+
const document = options.document ?? toElasticDocument;
|
|
46
|
+
for (const event of events) {
|
|
47
|
+
const metadata = compact({
|
|
48
|
+
_index: selectedIndex(event, options.index),
|
|
49
|
+
_id: options.id?.(event),
|
|
50
|
+
pipeline: selectedPipeline(event, options.pipeline)
|
|
51
|
+
});
|
|
52
|
+
const action = opType === "create" ? { create: metadata } : { index: metadata };
|
|
53
|
+
lines.push(JSON.stringify(action));
|
|
54
|
+
lines.push(JSON.stringify(document(event)));
|
|
55
|
+
}
|
|
56
|
+
return lines.length > 0 ? `${lines.join("\n")}\n` : "";
|
|
57
|
+
}
|
|
58
|
+
function elasticTransport(options) {
|
|
59
|
+
const fetchFn = options.fetchFn ?? globalThis.fetch?.bind(globalThis);
|
|
60
|
+
const transportName = options.name ?? "elastic";
|
|
61
|
+
const url = defaultBulkUrl(options.url, options.refresh);
|
|
62
|
+
const checkBulkErrors = options.checkBulkErrors ?? true;
|
|
63
|
+
const send = async (events) => {
|
|
64
|
+
if (events.length === 0) return;
|
|
65
|
+
if (!fetchFn) throw new Error("fetch is not available for elasticTransport");
|
|
66
|
+
const headers = {
|
|
67
|
+
"content-type": "application/x-ndjson",
|
|
68
|
+
...options.headers
|
|
69
|
+
};
|
|
70
|
+
if (options.apiKey) headers.authorization = `ApiKey ${options.apiKey}`;
|
|
71
|
+
const response = await fetchFn(url, {
|
|
72
|
+
method: "POST",
|
|
73
|
+
headers,
|
|
74
|
+
body: createElasticBulkPayload(events, options)
|
|
75
|
+
});
|
|
76
|
+
if (!response.ok) throw new Error(`elasticTransport failed with status ${response.status}`);
|
|
77
|
+
if (checkBulkErrors) {
|
|
78
|
+
if ((await response.json().catch(() => void 0))?.errors) throw new Error("elasticTransport bulk response contains item errors");
|
|
79
|
+
}
|
|
80
|
+
};
|
|
81
|
+
return {
|
|
82
|
+
name: transportName,
|
|
83
|
+
minLevel: options.minLevel,
|
|
84
|
+
log(event) {
|
|
85
|
+
if (options.minLevel !== void 0 && event.level < toLevelValue(options.minLevel)) return;
|
|
86
|
+
return send([event]);
|
|
87
|
+
},
|
|
88
|
+
logBatch(events) {
|
|
89
|
+
return send([...options.minLevel === void 0 ? events : events.filter((event) => event.level >= toLevelValue(options.minLevel))]);
|
|
90
|
+
}
|
|
91
|
+
};
|
|
92
|
+
}
|
|
93
|
+
//#endregion
|
|
94
|
+
export { createElasticBulkPayload, elasticTransport, toElasticDocument };
|
|
95
|
+
|
|
96
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { toLevelValue, type LogEvent, type LoggerLevel, type Transport } from \"@loggerjs/core\";\n\nexport type ElasticIndexSelector = string | ((event: LogEvent) => string);\nexport type ElasticOpType = \"create\" | \"index\";\n\nexport interface ElasticTransportOptions {\n url: string;\n name?: string;\n minLevel?: LoggerLevel;\n index?: ElasticIndexSelector;\n opType?: ElasticOpType;\n pipeline?: string | ((event: LogEvent) => string | undefined);\n id?: (event: LogEvent) => string | undefined;\n headers?: Record<string, string>;\n apiKey?: string;\n refresh?: boolean | \"wait_for\";\n checkBulkErrors?: boolean;\n document?: (event: LogEvent) => Record<string, unknown>;\n fetchFn?: typeof fetch;\n}\n\nexport interface ElasticBulkActionMetadata {\n _index?: string;\n _id?: string;\n pipeline?: string;\n}\n\nexport type ElasticBulkAction =\n | { create: ElasticBulkActionMetadata }\n | { index: ElasticBulkActionMetadata };\n\nfunction compact<T extends Record<string, unknown>>(value: T): T {\n for (const key of Object.keys(value)) {\n if (value[key] === undefined) delete value[key];\n }\n return value;\n}\n\nfunction defaultBulkUrl(url: string, refresh: ElasticTransportOptions[\"refresh\"]): string {\n const base = url.endsWith(\"/_bulk\") ? url : `${url.replace(/\\/+$/, \"\")}/_bulk`;\n if (refresh === undefined) return base;\n const separator = base.includes(\"?\") ? \"&\" : \"?\";\n return `${base}${separator}refresh=${encodeURIComponent(String(refresh))}`;\n}\n\nfunction selectedIndex(event: LogEvent, index: ElasticIndexSelector | undefined) {\n return typeof index === \"function\" ? index(event) : index;\n}\n\nfunction selectedPipeline(event: LogEvent, pipeline: ElasticTransportOptions[\"pipeline\"]) {\n return typeof pipeline === \"function\" ? pipeline(event) : pipeline;\n}\n\nexport function toElasticDocument(event: LogEvent): Record<string, unknown> {\n return compact({\n \"@timestamp\": new Date(event.time).toISOString(),\n message: event.message,\n log: {\n level: event.levelName,\n logger: event.logger,\n },\n event: {\n action: event.type,\n sequence: event.seq,\n },\n labels: event.tags,\n data: event.data,\n error: event.error,\n trace: event.trace,\n context: event.context,\n loggerjs: {\n id: event.id,\n level: event.level,\n source: event.source,\n },\n });\n}\n\nexport function createElasticBulkPayload(\n events: readonly LogEvent[],\n options: Pick<ElasticTransportOptions, \"document\" | \"id\" | \"index\" | \"opType\" | \"pipeline\"> = {},\n): string {\n const lines: string[] = [];\n const opType = options.opType ?? \"index\";\n const document = options.document ?? toElasticDocument;\n\n for (const event of events) {\n const metadata = compact({\n _index: selectedIndex(event, options.index),\n _id: options.id?.(event),\n pipeline: selectedPipeline(event, options.pipeline),\n });\n const action: ElasticBulkAction =\n opType === \"create\" ? { create: metadata } : { index: metadata };\n lines.push(JSON.stringify(action));\n lines.push(JSON.stringify(document(event)));\n }\n\n return lines.length > 0 ? `${lines.join(\"\\n\")}\\n` : \"\";\n}\n\nexport function elasticTransport(options: ElasticTransportOptions): Transport {\n const fetchFn = options.fetchFn ?? globalThis.fetch?.bind(globalThis);\n const transportName = options.name ?? \"elastic\";\n const url = defaultBulkUrl(options.url, options.refresh);\n const checkBulkErrors = options.checkBulkErrors ?? true;\n\n const send = async (events: LogEvent[]) => {\n if (events.length === 0) return;\n if (!fetchFn) throw new Error(\"fetch is not available for elasticTransport\");\n const headers: Record<string, string> = {\n \"content-type\": \"application/x-ndjson\",\n ...options.headers,\n };\n if (options.apiKey) headers.authorization = `ApiKey ${options.apiKey}`;\n\n const response = await fetchFn(url, {\n method: \"POST\",\n headers,\n body: createElasticBulkPayload(events, options),\n });\n if (!response.ok) throw new Error(`elasticTransport failed with status ${response.status}`);\n\n if (checkBulkErrors) {\n const result = (await response.json().catch(() => undefined)) as\n | { errors?: boolean }\n | undefined;\n if (result?.errors) throw new Error(\"elasticTransport bulk response contains item errors\");\n }\n };\n\n return {\n name: transportName,\n minLevel: options.minLevel,\n log(event) {\n if (options.minLevel !== undefined && event.level < toLevelValue(options.minLevel)) return;\n return send([event]);\n },\n logBatch(events) {\n const selected =\n options.minLevel === undefined\n ? events\n : events.filter((event) => event.level >= toLevelValue(options.minLevel));\n return send([...selected]);\n },\n };\n}\n"],"mappings":";;AA+BA,SAAS,QAA2C,OAAa;CAC/D,KAAK,MAAM,OAAO,OAAO,KAAK,KAAK,GACjC,IAAI,MAAM,SAAS,KAAA,GAAW,OAAO,MAAM;CAE7C,OAAO;AACT;AAEA,SAAS,eAAe,KAAa,SAAqD;CACxF,MAAM,OAAO,IAAI,SAAS,QAAQ,IAAI,MAAM,GAAG,IAAI,QAAQ,QAAQ,EAAE,EAAE;CACvE,IAAI,YAAY,KAAA,GAAW,OAAO;CAElC,OAAO,GAAG,OADQ,KAAK,SAAS,GAAG,IAAI,MAAM,IAClB,UAAU,mBAAmB,OAAO,OAAO,CAAC;AACzE;AAEA,SAAS,cAAc,OAAiB,OAAyC;CAC/E,OAAO,OAAO,UAAU,aAAa,MAAM,KAAK,IAAI;AACtD;AAEA,SAAS,iBAAiB,OAAiB,UAA+C;CACxF,OAAO,OAAO,aAAa,aAAa,SAAS,KAAK,IAAI;AAC5D;AAEA,SAAgB,kBAAkB,OAA0C;CAC1E,OAAO,QAAQ;EACb,cAAc,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,YAAY;EAC/C,SAAS,MAAM;EACf,KAAK;GACH,OAAO,MAAM;GACb,QAAQ,MAAM;EAChB;EACA,OAAO;GACL,QAAQ,MAAM;GACd,UAAU,MAAM;EAClB;EACA,QAAQ,MAAM;EACd,MAAM,MAAM;EACZ,OAAO,MAAM;EACb,OAAO,MAAM;EACb,SAAS,MAAM;EACf,UAAU;GACR,IAAI,MAAM;GACV,OAAO,MAAM;GACb,QAAQ,MAAM;EAChB;CACF,CAAC;AACH;AAEA,SAAgB,yBACd,QACA,UAA8F,CAAC,GACvF;CACR,MAAM,QAAkB,CAAC;CACzB,MAAM,SAAS,QAAQ,UAAU;CACjC,MAAM,WAAW,QAAQ,YAAY;CAErC,KAAK,MAAM,SAAS,QAAQ;EAC1B,MAAM,WAAW,QAAQ;GACvB,QAAQ,cAAc,OAAO,QAAQ,KAAK;GAC1C,KAAK,QAAQ,KAAK,KAAK;GACvB,UAAU,iBAAiB,OAAO,QAAQ,QAAQ;EACpD,CAAC;EACD,MAAM,SACJ,WAAW,WAAW,EAAE,QAAQ,SAAS,IAAI,EAAE,OAAO,SAAS;EACjE,MAAM,KAAK,KAAK,UAAU,MAAM,CAAC;EACjC,MAAM,KAAK,KAAK,UAAU,SAAS,KAAK,CAAC,CAAC;CAC5C;CAEA,OAAO,MAAM,SAAS,IAAI,GAAG,MAAM,KAAK,IAAI,EAAE,MAAM;AACtD;AAEA,SAAgB,iBAAiB,SAA6C;CAC5E,MAAM,UAAU,QAAQ,WAAW,WAAW,OAAO,KAAK,UAAU;CACpE,MAAM,gBAAgB,QAAQ,QAAQ;CACtC,MAAM,MAAM,eAAe,QAAQ,KAAK,QAAQ,OAAO;CACvD,MAAM,kBAAkB,QAAQ,mBAAmB;CAEnD,MAAM,OAAO,OAAO,WAAuB;EACzC,IAAI,OAAO,WAAW,GAAG;EACzB,IAAI,CAAC,SAAS,MAAM,IAAI,MAAM,6CAA6C;EAC3E,MAAM,UAAkC;GACtC,gBAAgB;GAChB,GAAG,QAAQ;EACb;EACA,IAAI,QAAQ,QAAQ,QAAQ,gBAAgB,UAAU,QAAQ;EAE9D,MAAM,WAAW,MAAM,QAAQ,KAAK;GAClC,QAAQ;GACR;GACA,MAAM,yBAAyB,QAAQ,OAAO;EAChD,CAAC;EACD,IAAI,CAAC,SAAS,IAAI,MAAM,IAAI,MAAM,uCAAuC,SAAS,QAAQ;EAE1F,IAAI;QAIE,MAHkB,SAAS,KAAK,CAAC,CAAC,YAAY,KAAA,CAAS,EAAA,EAG/C,QAAQ,MAAM,IAAI,MAAM,qDAAqD;EAAA;CAE7F;CAEA,OAAO;EACL,MAAM;EACN,UAAU,QAAQ;EAClB,IAAI,OAAO;GACT,IAAI,QAAQ,aAAa,KAAA,KAAa,MAAM,QAAQ,aAAa,QAAQ,QAAQ,GAAG;GACpF,OAAO,KAAK,CAAC,KAAK,CAAC;EACrB;EACA,SAAS,QAAQ;GAKf,OAAO,KAAK,CAAC,GAHX,QAAQ,aAAa,KAAA,IACjB,SACA,OAAO,QAAQ,UAAU,MAAM,SAAS,aAAa,QAAQ,QAAQ,CAAC,CACpD,CAAC;EAC3B;CACF;AACF"}
|
package/package.json
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@loggerjs/elastic",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "Elasticsearch bulk transport for loggerjs.",
|
|
5
|
+
"homepage": "https://github.com/jskits/loggerjs/tree/main/packages/elastic#readme",
|
|
6
|
+
"bugs": {
|
|
7
|
+
"url": "https://github.com/jskits/loggerjs/issues"
|
|
8
|
+
},
|
|
9
|
+
"license": "MIT",
|
|
10
|
+
"repository": {
|
|
11
|
+
"type": "git",
|
|
12
|
+
"url": "git+https://github.com/jskits/loggerjs.git",
|
|
13
|
+
"directory": "packages/elastic"
|
|
14
|
+
},
|
|
15
|
+
"files": [
|
|
16
|
+
"dist",
|
|
17
|
+
"README.md",
|
|
18
|
+
"LICENSE"
|
|
19
|
+
],
|
|
20
|
+
"type": "module",
|
|
21
|
+
"sideEffects": false,
|
|
22
|
+
"main": "./dist/index.cjs",
|
|
23
|
+
"module": "./dist/index.js",
|
|
24
|
+
"types": "./dist/index.d.ts",
|
|
25
|
+
"exports": {
|
|
26
|
+
".": {
|
|
27
|
+
"types": "./dist/index.d.ts",
|
|
28
|
+
"import": "./dist/index.js",
|
|
29
|
+
"require": "./dist/index.cjs"
|
|
30
|
+
},
|
|
31
|
+
"./transport": {
|
|
32
|
+
"types": "./dist/index.d.ts",
|
|
33
|
+
"import": "./dist/index.js",
|
|
34
|
+
"require": "./dist/index.cjs"
|
|
35
|
+
}
|
|
36
|
+
},
|
|
37
|
+
"publishConfig": {
|
|
38
|
+
"access": "public",
|
|
39
|
+
"provenance": true
|
|
40
|
+
},
|
|
41
|
+
"dependencies": {
|
|
42
|
+
"@loggerjs/core": "0.0.1"
|
|
43
|
+
},
|
|
44
|
+
"scripts": {
|
|
45
|
+
"build": "pnpm run clean && pnpm run build:js && pnpm run build:types",
|
|
46
|
+
"build:js": "rolldown -c ../../rolldown.config.mjs",
|
|
47
|
+
"build:types": "tsc -p tsconfig.build.json && node ../../scripts/fix-dts-extensions.mjs dist",
|
|
48
|
+
"typecheck": "tsc --noEmit -p tsconfig.json",
|
|
49
|
+
"test": "vitest run --passWithNoTests",
|
|
50
|
+
"clean": "rm -rf dist"
|
|
51
|
+
}
|
|
52
|
+
}
|