@flareapp/node 0.1.1 → 0.2.0

package/README.md

@@ -1,8 +1,9 @@
 # @flareapp/node
 
 Node.js SDK for [flareapp.io](https://flareapp.io). Capture uncaught
-exceptions, unhandled rejections, and explicit `flare.report(err)` calls in
-your Node servers. Per-request context isolation via AsyncLocalStorage.
+exceptions, unhandled rejections, explicit `flare.report(err)` calls, and
+structured logs in your Node servers. Per-request context isolation via
+AsyncLocalStorage.
 
 > **Status: unstable (0.x).** This package is pre-1.0 and its API may change
 > between minor releases. Pin an exact version in production
@@ -28,6 +29,23 @@ flare.light('your-flare-api-key');
 That's it. Crashes and unhandled rejections are reported automatically (the
 default behavior is to report, flush, and exit with code 1).
 
+## Logging
+
+Beyond errors, the SDK can send structured logs. Logs are opt-in: enable them
+with `enableLogs`, then call any of the eight syslog levels (`debug`, `info`,
+`notice`, `warning`, `error`, `critical`, `alert`, `emergency`).
+
+```ts
+flare.configure({ enableLogs: true });
+
+flare.logger.info('Order processed', { orderId: order.id, total: order.total });
+```
+
+Logs are buffered and batched, and flushed on `beforeExit`. A log recorded
+inside a `runWithContext` scope carries that request's context. `beforeExit`
+does not fire on `SIGTERM` or `process.exit()`, so call `flare.flush()` during
+graceful shutdown to drain buffered logs.
+
 ## Per-request context
 
 In an HTTP server, wrap each request handler with `runWithContext` so the

package/dist/index.cjs

@@ -354,6 +354,14 @@ function makeNodeContextCollector(provider, getOptions) {
 	};
 }
 
+//#endregion
+//#region src/logging/NodeFlushScheduler.ts
+var NodeFlushScheduler = class {
+	register(flush) {
+		process.on("beforeExit", () => flush());
+	}
+};
+
 //#endregion
 //#region src/process/fatal.ts
 function buildFatalCallbacks(flare, getOpts, exit = process.exit.bind(process)) {
@@ -613,7 +621,7 @@ function isLocalFileUrl(url) {
 //#endregion
 //#region src/Flare.ts
 const NODE_SDK_NAME = "@flareapp/node";
-const NODE_SDK_VERSION = typeof process !== "undefined" && true ? "0.1.1" : "?";
+const NODE_SDK_VERSION = typeof process !== "undefined" && true ? "0.2.0" : "?";
 /**
 * Strip the `g` and `y` flags from a user-supplied regex.
 *
@@ -668,7 +676,7 @@ var NodeFlare = class extends _flareapp_core.Flare {
 	constructor() {
 		const scopeProvider = new AsyncLocalStorageScopeProvider();
 		const collector = makeNodeContextCollector(scopeProvider, () => this.nodeOptions);
-		super(new _flareapp_core.Api(), collector, new DiskFileReader(), scopeProvider);
+		super(new _flareapp_core.Api(), collector, new DiskFileReader(), scopeProvider, new NodeFlushScheduler());
 		this.nodeScopeProvider = scopeProvider;
 		this.setSdkInfo({
 			name: NODE_SDK_NAME,
@@ -799,6 +807,12 @@ Object.defineProperty(exports, 'GlobalScopeProvider', {
     return _flareapp_core.GlobalScopeProvider;
   }
 });
+Object.defineProperty(exports, 'Logger', {
+  enumerable: true,
+  get: function () {
+    return _flareapp_core.Logger;
+  }
+});
 exports.NodeFlare = NodeFlare;
 exports.NodeScope = NodeScope;
 Object.defineProperty(exports, 'NullFileReader', {

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { AttributeValue, Attributes, Config, ContextCollector, DEFAULT_URL_DENYLIST, EntryPointHandler, FileReader, Flare, Flare as Flare$1, Framework, GlobalScopeProvider, Glow, MessageLevel, NullFileReader, OverriddenGrouping, Report, Scope, Scope as Scope$1, ScopeProvider, SdkInfo, SpanEvent, StackFrame, convertToError, redactUrlQuery, resolveDenylist } from "@flareapp/core";
+import { AttributeValue, Attributes, Config, ContextCollector, DEFAULT_URL_DENYLIST, EntryPointHandler, FileReader, Flare, Flare as Flare$1, FlushFn, FlushScheduler, Framework, GlobalScopeProvider, Glow, Logger, MessageLevel, NullFileReader, OverriddenGrouping, Report, Scope, Scope as Scope$1, ScopeProvider, SdkInfo, SpanEvent, StackFrame, convertToError, redactUrlQuery, resolveDenylist } from "@flareapp/core";
 
 //#region src/types.d.ts
 type RequestContext = {
@@ -135,4 +135,4 @@ declare class NodeFlare extends Flare$1 {
 //#region src/index.d.ts
 declare const flare: NodeFlare;
 //#endregion
-export { type AttributeValue, type Attributes, type Config, type ContextCollector, DEFAULT_URL_DENYLIST, type EntryPointHandler, type FatalMode, type FileReader, Flare, type Framework, GlobalScopeProvider, type Glow, type MessageLevel, NodeFlare, type NodeOptions, NodeScope, NullFileReader, type OverriddenGrouping, type Report, type RequestContext, Scope, type ScopeProvider, type SdkInfo, type SpanEvent, type StackFrame, type User, convertToError, flare, redactUrlQuery, resolveDenylist };
+export { type AttributeValue, type Attributes, type Config, type ContextCollector, DEFAULT_URL_DENYLIST, type EntryPointHandler, type FatalMode, type FileReader, Flare, type FlushFn, type FlushScheduler, type Framework, GlobalScopeProvider, type Glow, Logger, type MessageLevel, NodeFlare, type NodeOptions, NodeScope, NullFileReader, type OverriddenGrouping, type Report, type RequestContext, Scope, type ScopeProvider, type SdkInfo, type SpanEvent, type StackFrame, type User, convertToError, flare, redactUrlQuery, resolveDenylist };

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { AttributeValue, Attributes, Config, ContextCollector, DEFAULT_URL_DENYLIST, EntryPointHandler, FileReader, Flare, Flare as Flare$1, Framework, GlobalScopeProvider, Glow, MessageLevel, NullFileReader, OverriddenGrouping, Report, Scope, Scope as Scope$1, ScopeProvider, SdkInfo, SpanEvent, StackFrame, convertToError, redactUrlQuery, resolveDenylist } from "@flareapp/core";
+import { AttributeValue, Attributes, Config, ContextCollector, DEFAULT_URL_DENYLIST, EntryPointHandler, FileReader, Flare, Flare as Flare$1, FlushFn, FlushScheduler, Framework, GlobalScopeProvider, Glow, Logger, MessageLevel, NullFileReader, OverriddenGrouping, Report, Scope, Scope as Scope$1, ScopeProvider, SdkInfo, SpanEvent, StackFrame, convertToError, redactUrlQuery, resolveDenylist } from "@flareapp/core";
 
 //#region src/types.d.ts
 type RequestContext = {
@@ -135,4 +135,4 @@ declare class NodeFlare extends Flare$1 {
 //#region src/index.d.ts
 declare const flare: NodeFlare;
 //#endregion
-export { type AttributeValue, type Attributes, type Config, type ContextCollector, DEFAULT_URL_DENYLIST, type EntryPointHandler, type FatalMode, type FileReader, Flare, type Framework, GlobalScopeProvider, type Glow, type MessageLevel, NodeFlare, type NodeOptions, NodeScope, NullFileReader, type OverriddenGrouping, type Report, type RequestContext, Scope, type ScopeProvider, type SdkInfo, type SpanEvent, type StackFrame, type User, convertToError, flare, redactUrlQuery, resolveDenylist };
+export { type AttributeValue, type Attributes, type Config, type ContextCollector, DEFAULT_URL_DENYLIST, type EntryPointHandler, type FatalMode, type FileReader, Flare, type FlushFn, type FlushScheduler, type Framework, GlobalScopeProvider, type Glow, Logger, type MessageLevel, NodeFlare, type NodeOptions, NodeScope, NullFileReader, type OverriddenGrouping, type Report, type RequestContext, Scope, type ScopeProvider, type SdkInfo, type SpanEvent, type StackFrame, type User, convertToError, flare, redactUrlQuery, resolveDenylist };

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { Api, DEFAULT_URL_DENYLIST, DEFAULT_URL_DENYLIST as DEFAULT_URL_DENYLIST$1, Flare, Flare as Flare$1, GlobalScopeProvider, NullFileReader, Scope, Scope as Scope$1, convertToError, redactUrlQuery, redactUrlQuery as redactUrlQuery$1, resolveDenylist } from "@flareapp/core";
+import { Api, DEFAULT_URL_DENYLIST, DEFAULT_URL_DENYLIST as DEFAULT_URL_DENYLIST$1, Flare, Flare as Flare$1, GlobalScopeProvider, Logger, NullFileReader, Scope, Scope as Scope$1, convertToError, redactUrlQuery, redactUrlQuery as redactUrlQuery$1, resolveDenylist } from "@flareapp/core";
 import os from "node:os";
 import { AsyncLocalStorage } from "node:async_hooks";
 import { readFile } from "node:fs/promises";
@@ -325,6 +325,14 @@ function makeNodeContextCollector(provider, getOptions) {
 	};
 }
 
+//#endregion
+//#region src/logging/NodeFlushScheduler.ts
+var NodeFlushScheduler = class {
+	register(flush) {
+		process.on("beforeExit", () => flush());
+	}
+};
+
 //#endregion
 //#region src/process/fatal.ts
 function buildFatalCallbacks(flare, getOpts, exit = process.exit.bind(process)) {
@@ -584,7 +592,7 @@ function isLocalFileUrl(url) {
 //#endregion
 //#region src/Flare.ts
 const NODE_SDK_NAME = "@flareapp/node";
-const NODE_SDK_VERSION = typeof process !== "undefined" && true ? "0.1.1" : "?";
+const NODE_SDK_VERSION = typeof process !== "undefined" && true ? "0.2.0" : "?";
 /**
 * Strip the `g` and `y` flags from a user-supplied regex.
 *
@@ -639,7 +647,7 @@ var NodeFlare = class extends Flare$1 {
 	constructor() {
 		const scopeProvider = new AsyncLocalStorageScopeProvider();
 		const collector = makeNodeContextCollector(scopeProvider, () => this.nodeOptions);
-		super(new Api(), collector, new DiskFileReader(), scopeProvider);
+		super(new Api(), collector, new DiskFileReader(), scopeProvider, new NodeFlushScheduler());
 		this.nodeScopeProvider = scopeProvider;
 		this.setSdkInfo({
 			name: NODE_SDK_NAME,
@@ -752,4 +760,4 @@ var NodeFlare = class extends Flare$1 {
 const flare = new NodeFlare();
 
 //#endregion
-export { DEFAULT_URL_DENYLIST, Flare, GlobalScopeProvider, NodeFlare, NodeScope, NullFileReader, Scope, convertToError, flare, redactUrlQuery, resolveDenylist };
+export { DEFAULT_URL_DENYLIST, Flare, GlobalScopeProvider, Logger, NodeFlare, NodeScope, NullFileReader, Scope, convertToError, flare, redactUrlQuery, resolveDenylist };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@flareapp/node",
-    "version": "0.1.1",
+    "version": "0.2.0",
     "description": "Node.js SDK for flareapp.io",
     "homepage": "https://flareapp.io",
     "bugs": {
@@ -44,7 +44,7 @@
         "release": "release-it"
     },
     "dependencies": {
-        "@flareapp/core": "2.2.1"
+        "@flareapp/core": "2.3.0"
     },
     "devDependencies": {
         "tsdown": "^0.20.3",