@obzerver/node 0.0.0-stage → 0.3.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.
Files changed (54) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +92 -2
  3. package/dist/agent-types.d.ts +28 -0
  4. package/dist/agent-types.js +6 -0
  5. package/dist/agent-types.js.map +1 -0
  6. package/dist/agent.d.ts +90 -0
  7. package/dist/agent.js +578 -0
  8. package/dist/agent.js.map +1 -0
  9. package/dist/context.d.ts +86 -0
  10. package/dist/context.js +136 -0
  11. package/dist/context.js.map +1 -0
  12. package/dist/errors.d.ts +18 -0
  13. package/dist/errors.js +108 -0
  14. package/dist/errors.js.map +1 -0
  15. package/dist/index.d.ts +76 -0
  16. package/dist/index.js +110 -0
  17. package/dist/index.js.map +1 -0
  18. package/dist/instrument/console.d.ts +11 -0
  19. package/dist/instrument/console.js +68 -0
  20. package/dist/instrument/console.js.map +1 -0
  21. package/dist/instrument/db.d.ts +7 -0
  22. package/dist/instrument/db.js +155 -0
  23. package/dist/instrument/db.js.map +1 -0
  24. package/dist/instrument/express.d.ts +3 -0
  25. package/dist/instrument/express.js +133 -0
  26. package/dist/instrument/express.js.map +1 -0
  27. package/dist/instrument/fastify.d.ts +35 -0
  28. package/dist/instrument/fastify.js +88 -0
  29. package/dist/instrument/fastify.js.map +1 -0
  30. package/dist/instrument/http.d.ts +10 -0
  31. package/dist/instrument/http.js +149 -0
  32. package/dist/instrument/http.js.map +1 -0
  33. package/dist/instrument/jobs.d.ts +15 -0
  34. package/dist/instrument/jobs.js +90 -0
  35. package/dist/instrument/jobs.js.map +1 -0
  36. package/dist/options.d.ts +89 -0
  37. package/dist/options.js +3 -0
  38. package/dist/options.js.map +1 -0
  39. package/dist/protocol.d.ts +146 -0
  40. package/dist/protocol.js +4 -0
  41. package/dist/protocol.js.map +1 -0
  42. package/dist/redact.d.ts +12 -0
  43. package/dist/redact.js +54 -0
  44. package/dist/redact.js.map +1 -0
  45. package/dist/register.d.ts +1 -0
  46. package/dist/register.js +9 -0
  47. package/dist/register.js.map +1 -0
  48. package/dist/runtime.d.ts +37 -0
  49. package/dist/runtime.js +142 -0
  50. package/dist/runtime.js.map +1 -0
  51. package/dist/transport.d.ts +32 -0
  52. package/dist/transport.js +122 -0
  53. package/dist/transport.js.map +1 -0
  54. package/package.json +51 -4
@@ -0,0 +1,32 @@
1
+ import type { IngestPayload, QueueItems, QueueKind } from './protocol';
2
+ export interface TransportOptions {
3
+ endpoint: string;
4
+ appKey: string;
5
+ flushInterval?: number;
6
+ maxTracesPerBatch?: number;
7
+ maxQueue?: number;
8
+ }
9
+ export type Queues = {
10
+ [K in QueueKind]: QueueItems[K][];
11
+ };
12
+ export declare class Transport {
13
+ private readonly log;
14
+ readonly endpoint: string;
15
+ private readonly appKey;
16
+ private readonly maxTracesPerBatch;
17
+ private readonly maxQueue;
18
+ private readonly timer;
19
+ meta: Pick<IngestPayload, 'sdk' | 'service'> | null;
20
+ readonly q: Queues;
21
+ private dropped;
22
+ private sending;
23
+ private failures;
24
+ constructor(opts: TransportOptions, log: (msg: string) => void);
25
+ push<K extends QueueKind>(kind: K, item: QueueItems[K]): void;
26
+ size(): number;
27
+ private takeBatch;
28
+ private requeue;
29
+ flush(): Promise<void>;
30
+ private post;
31
+ close(): Promise<void>;
32
+ }
@@ -0,0 +1,122 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Transport = void 0;
4
+ const http = require("node:http");
5
+ const https = require("node:https");
6
+ const zlib = require("node:zlib");
7
+ // Captured before any instrumentation patches http/https, so SDK traffic is never traced.
8
+ const rawHttpRequest = http.request;
9
+ const rawHttpsRequest = https.request;
10
+ const KINDS = ['traces', 'errors', 'logs', 'runtime', 'metrics'];
11
+ class Transport {
12
+ log;
13
+ endpoint;
14
+ appKey;
15
+ maxTracesPerBatch;
16
+ maxQueue;
17
+ timer;
18
+ meta = null;
19
+ q = { traces: [], errors: [], logs: [], runtime: [], metrics: [] };
20
+ dropped = 0;
21
+ sending = false;
22
+ failures = 0;
23
+ constructor(opts, log) {
24
+ this.log = log;
25
+ this.endpoint = opts.endpoint.replace(/\/+$/, '');
26
+ this.appKey = opts.appKey;
27
+ this.maxTracesPerBatch = opts.maxTracesPerBatch || 1000;
28
+ this.maxQueue = opts.maxQueue || 20000;
29
+ this.timer = setInterval(() => { this.flush().catch(() => { }); }, Math.max(1000, opts.flushInterval || 5000));
30
+ this.timer.unref();
31
+ }
32
+ push(kind, item) {
33
+ const list = this.q[kind];
34
+ if (list.length >= this.maxQueue) {
35
+ list.shift();
36
+ this.dropped++;
37
+ }
38
+ list.push(item);
39
+ }
40
+ size() { return KINDS.reduce((n, k) => n + this.q[k].length, 0); }
41
+ takeBatch() {
42
+ return {
43
+ traces: this.q.traces.splice(0, this.maxTracesPerBatch),
44
+ errors: this.q.errors.splice(0, 2000),
45
+ logs: this.q.logs.splice(0, 5000),
46
+ runtime: this.q.runtime.splice(0, 500),
47
+ metrics: this.q.metrics.splice(0, 5000),
48
+ };
49
+ }
50
+ requeue(b) {
51
+ for (const k of KINDS) {
52
+ const list = this.q[k];
53
+ list.unshift(...b[k].slice(0, Math.max(0, this.maxQueue - list.length)));
54
+ }
55
+ }
56
+ async flush() {
57
+ if (this.sending || this.size() === 0 || !this.meta)
58
+ return;
59
+ this.sending = true;
60
+ try {
61
+ while (this.size() > 0) {
62
+ const batch = this.takeBatch();
63
+ const payload = { ...this.meta, sentAt: Date.now(), dropped: this.dropped, ...batch };
64
+ this.dropped = 0;
65
+ try {
66
+ await this.post(payload);
67
+ this.failures = 0;
68
+ }
69
+ catch (err) {
70
+ this.failures++;
71
+ if (this.failures === 1 || this.failures % 20 === 0)
72
+ this.log(`could not reach collector at ${this.endpoint}: ${err.message}`);
73
+ if (this.failures < 10)
74
+ this.requeue(batch);
75
+ break;
76
+ }
77
+ }
78
+ }
79
+ finally {
80
+ this.sending = false;
81
+ }
82
+ }
83
+ post(payload) {
84
+ return new Promise((resolve, reject) => {
85
+ const body = zlib.gzipSync(JSON.stringify(payload));
86
+ const url = new URL(`${this.endpoint}/v1/ingest`);
87
+ const request = url.protocol === 'https:' ? rawHttpsRequest : rawHttpRequest;
88
+ const req = request(url, {
89
+ method: 'POST',
90
+ headers: {
91
+ 'content-type': 'application/json',
92
+ 'content-encoding': 'gzip',
93
+ 'content-length': body.length,
94
+ 'x-obzerver-key': this.appKey || '',
95
+ 'x-obzerver-internal': '1',
96
+ },
97
+ timeout: 10000,
98
+ }, (res) => {
99
+ let text = '';
100
+ res.on('data', (c) => { if (text.length < 2000)
101
+ text += c; });
102
+ res.on('end', () => {
103
+ const code = res.statusCode ?? 0;
104
+ if (code >= 200 && code < 300)
105
+ resolve();
106
+ else if (code === 401) {
107
+ this.log('collector rejected the app key (401). Check OBZERVER_KEY.');
108
+ resolve();
109
+ }
110
+ else
111
+ reject(new Error(`HTTP ${code} ${text.slice(0, 200)}`));
112
+ });
113
+ });
114
+ req.on('timeout', () => req.destroy(new Error('timeout')));
115
+ req.on('error', reject);
116
+ req.end(body);
117
+ });
118
+ }
119
+ close() { clearInterval(this.timer); return this.flush(); }
120
+ }
121
+ exports.Transport = Transport;
122
+ //# sourceMappingURL=transport.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"transport.js","sourceRoot":"","sources":["../src/transport.ts"],"names":[],"mappings":";;;AAAA,kCAAkC;AAClC,oCAAoC;AACpC,kCAAkC;AAGlC,0FAA0F;AAC1F,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC;AACpC,MAAM,eAAe,GAAG,KAAK,CAAC,OAAO,CAAC;AAYtC,MAAM,KAAK,GAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;AAE9E,MAAa,SAAS;IAYiC;IAX5C,QAAQ,CAAS;IACT,MAAM,CAAS;IACf,iBAAiB,CAAS;IAC1B,QAAQ,CAAS;IACjB,KAAK,CAAiB;IACvC,IAAI,GAAkD,IAAI,CAAC;IAClD,CAAC,GAAW,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IAC5E,OAAO,GAAG,CAAC,CAAC;IACZ,OAAO,GAAG,KAAK,CAAC;IAChB,QAAQ,GAAG,CAAC,CAAC;IAErB,YAAY,IAAsB,EAAmB,GAA0B;QAA1B,QAAG,GAAH,GAAG,CAAuB;QAC7E,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC;QACxD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC;QACvC,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,CAAC,CAAC;QAC9G,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;IAED,IAAI,CAAsB,IAAO,EAAE,IAAmB;QACpD,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAoB,CAAC;QAC7C,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QAAC,CAAC;QACnE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,KAAa,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAElE,SAAS;QACf,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,iBAAiB,CAAC;YACvD,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC;YACrC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC;YACjC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC;YACtC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC;SACxC,CAAC;IACJ,CAAC;IAEO,OAAO,CAAC,CAAS;QACvB,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;YACtB,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAc,CAAC;YACpC,IAAI,CAAC,OAAO,CAAC,GAAI,CAAC,CAAC,CAAC,CAAe,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC1F,CAAC;IACH,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI;YAAE,OAAO;QAC5D,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;gBACvB,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;gBAC/B,MAAM,OAAO,GAAkB,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,KAAK,EAAE,CAAC;gBACrG,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;gBACjB,IAAI,CAAC;oBACH,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBACzB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACpB,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAChB,IAAI,IAAI,CAAC,QAAQ,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,GAAG,EAAE,KAAK,CAAC;wBAAE,IAAI,CAAC,GAAG,CAAC,gCAAgC,IAAI,CAAC,QAAQ,KAAM,GAAa,CAAC,OAAO,EAAE,CAAC,CAAC;oBAC1I,IAAI,IAAI,CAAC,QAAQ,GAAG,EAAE;wBAAE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;oBAC5C,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACvB,CAAC;IACH,CAAC;IAEO,IAAI,CAAC,OAAsB;QACjC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;YACpD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,YAAY,CAAC,CAAC;YAClD,MAAM,OAAO,GAAG,GAAG,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,cAAc,CAAC;YAC7E,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE;gBACvB,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;oBAClC,kBAAkB,EAAE,MAAM;oBAC1B,gBAAgB,EAAE,IAAI,CAAC,MAAM;oBAC7B,gBAAgB,EAAE,IAAI,CAAC,MAAM,IAAI,EAAE;oBACnC,qBAAqB,EAAE,GAAG;iBAC3B;gBACD,OAAO,EAAE,KAAK;aACf,EAAE,CAAC,GAAG,EAAE,EAAE;gBACT,IAAI,IAAI,GAAG,EAAE,CAAC;gBACd,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAS,EAAE,EAAE,GAAG,IAAI,IAAI,CAAC,MAAM,GAAG,IAAI;oBAAE,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACtE,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;oBACjB,MAAM,IAAI,GAAG,GAAG,CAAC,UAAU,IAAI,CAAC,CAAC;oBACjC,IAAI,IAAI,IAAI,GAAG,IAAI,IAAI,GAAG,GAAG;wBAAE,OAAO,EAAE,CAAC;yBACpC,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;wBAAC,IAAI,CAAC,GAAG,CAAC,2DAA2D,CAAC,CAAC;wBAAC,OAAO,EAAE,CAAC;oBAAC,CAAC;;wBACvG,MAAM,CAAC,IAAI,KAAK,CAAC,QAAQ,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC/D,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YACH,GAAG,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAC3D,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YACxB,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,KAAoB,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;CAC3E;AArGD,8BAqGC"}
package/package.json CHANGED
@@ -1,6 +1,53 @@
1
1
  {
2
2
  "name": "@obzerver/node",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.3.2",
4
+ "description": "Zero-config observability SDK for Express and Fastify",
5
+ "main": "dist/index.js",
6
+ "types": "dist/index.d.ts",
7
+ "exports": {
8
+ ".": {
9
+ "types": "./dist/index.d.ts",
10
+ "default": "./dist/index.js"
11
+ },
12
+ "./register": {
13
+ "types": "./dist/register.d.ts",
14
+ "default": "./dist/register.js"
15
+ },
16
+ "./protocol": {
17
+ "types": "./dist/protocol.d.ts",
18
+ "default": "./dist/protocol.js"
19
+ },
20
+ "./package.json": "./package.json"
21
+ },
22
+ "files": [
23
+ "dist",
24
+ "README.md",
25
+ "LICENSE"
26
+ ],
27
+ "scripts": {
28
+ "build": "tsc -p .",
29
+ "test": "node --test --test-force-exit test/sdk.test.mts test/jobs.test.mts",
30
+ "prepublishOnly": "npm run build && npm test"
31
+ },
32
+ "keywords": [
33
+ "express",
34
+ "fastify",
35
+ "observability",
36
+ "tracing",
37
+ "apm",
38
+ "errors",
39
+ "logs"
40
+ ],
41
+ "license": "MIT",
42
+ "engines": {
43
+ "node": ">=18.19"
44
+ },
45
+ "devDependencies": {
46
+ "bullmq": "^5.81.5",
47
+ "cron": "^4.4.0",
48
+ "node-cron": "^4.6.0"
49
+ },
50
+ "publishConfig": {
51
+ "access": "public"
52
+ }
53
+ }