@kamranbiglari/pino-logger 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,161 @@
+# @kamranbiglari/pino-logger
+
+Opinionated Pino wrapper for structured JSON logging across Node.js/TypeScript services.
+
+## Install
+
+```bash
+npm install @kamranbiglari/pino-logger
+npm install -D pino-pretty  # dev only
+```
+
+The package is published to both **npm** and **GitHub Packages**.
+To install from GitHub Packages instead, add `.npmrc` to your repo root:
+
+```
+@kamranbiglari:registry=https://npm.pkg.github.com
+```
+
+## Usage
+
+```typescript
+import { createLogger } from '@kamranbiglari/pino-logger';
+
+const logger = createLogger({ service: 'my-service' });
+
+logger.info({ userId }, 'user logged in');
+logger.warn({ retries }, 'upstream slow');
+logger.error({ err }, 'request failed');
+logger.alert({ breach_type: 'unauthorized' }, 'security breach detected');
+logger.fatal({ err }, 'cannot continue'); // logs then exits with code 1
+```
+
+All messages are prefixed with the log level: `[INFO] user logged in`, `[ERROR] request failed`, etc.
+This enables log parser engines to alert on specific levels via message pattern matching.
+
+## Log Levels
+
+| Level | Numeric | Description |
+|---|---|---|
+| `trace` | 10 | Internal state, hot-path detail |
+| `debug` | 20 | Development-time detail |
+| `info` | 30 | Normal operations (default) |
+| `warn` | 40 | Degraded but recoverable |
+| `error` | 50 | Failures requiring attention |
+| `fatal` | 60 | Unrecoverable — kills process |
+| `alert` | 70 | Highest severity — immediate operator attention, does NOT kill process |
+
+## Environment Variables
+
+| Variable | Values | Default | Description |
+|---|---|---|---|
+| `LOG_LEVEL` | `trace` `debug` `info` `warn` `error` `fatal` `alert` | `info` | Minimum log level |
+| `LOG_VERBOSE` | `true` `false` | `false` | Force trace level |
+| `NODE_ENV` | `development` `production` | `production` | Enables pino-pretty in dev |
+
+## Child loggers
+
+```typescript
+const reqLogger = logger.child({ req_id: 'abc-123', user_id: 'u_456' });
+reqLogger.info({ path: '/v1/rates' }, 'request received'); // includes req_id and user_id
+```
+
+## AsyncLocalStorage Context
+
+Automatically propagate context fields through the async call stack without passing the logger around:
+
+```typescript
+import { createLogger, withContext } from '@kamranbiglari/pino-logger';
+
+const logger = createLogger({ service: 'my-api' });
+
+// In middleware:
+app.use((req, res, next) => {
+  withContext({ req_id: req.id, user_id: req.userId }, next);
+});
+
+// Anywhere downstream — no need to pass logger:
+logger.info('processing order'); // automatically includes req_id, user_id
+```
+
+## Request Duration Tracking
+
+```typescript
+const timer = logger.startTimer();
+await processRequest();
+timer.done({ req_id }, 'request processed');
+// => { "duration_ms": 42.17, "req_id": "abc", "msg": "[INFO] request processed" }
+
+// Or just get elapsed time:
+const elapsed = timer.elapsed(); // ms
+```
+
+## Structured Metrics
+
+```typescript
+logger.metric({
+  metric_name: 'http_request_duration',
+  metric_value: 42,
+  metric_unit: 'ms',
+  method: 'GET',
+  path: '/v1/rates',
+});
+// => { "metric_type": "metric", "metric_name": "http_request_duration", "metric_value": 42, ... }
+```
+
+## Log Sampling
+
+For high-throughput trace/debug logs, sample every Nth log while counting every call:
+
+```typescript
+const logger = createLogger({
+  service: 'my-api',
+  sample: { trace: 100, debug: 10 },
+});
+
+// Every 100th trace log is emitted. Each emitted log includes:
+// - sampled_count: number of logs since last emission (100)
+// - sampled_total: running total of all calls at this level
+// No logs are lost — you always know the exact count.
+```
+
+On shutdown, remaining counters are flushed as summary log lines.
+
+## Graceful Shutdown
+
+```typescript
+process.on('SIGTERM', async () => {
+  logger.info('shutting down');
+  await logger.shutdown(); // flushes sample counters + async transport buffers
+  process.exit(0);
+});
+```
+
+## Field Naming Conventions
+
+| Field | Convention | Example |
+|---|---|---|
+| Service name | kebab-case | `windy-gateway`, `fx-api` |
+| Field names | snake_case | `req_id`, `latency_ms`, `status_code` |
+| Error object | always `err` | `{ err: new Error(...) }` |
+| IDs | suffix `_id` | `req_id`, `user_id`, `order_id` |
+| Durations | suffix `_ms` | `latency_ms`, `ttl_ms` |
+| Message | short stable string | `'rate fetch failed'` |
+
+## Publishing
+
+```bash
+npm version patch   # or minor / major
+git push origin main --tags
+```
+
+GitHub Actions runs: **typecheck** → **test** → **build** → **publish to npm + GitHub Packages** (in parallel).
+
+### Required secrets
+
+| Secret | Registry | How to get |
+|---|---|---|
+| `GITHUB_TOKEN` | GitHub Packages | Auto-provided by GitHub Actions |
+| `NPM_TOKEN` | npm | npmjs.com → Access Tokens → Classic Token (Automation) |
+
+Add `NPM_TOKEN` in repo Settings → Secrets and variables → Actions.

package/dist/index.d.mts

@@ -0,0 +1,228 @@
+import pino from 'pino';
+
+declare const LOG_LEVELS: readonly ["trace", "debug", "info", "warn", "error", "fatal", "alert"];
+type LogLevel = (typeof LOG_LEVELS)[number];
+/**
+ * Fields merged into every log line emitted by this service.
+ * All fields follow snake_case naming convention.
+ */
+interface BaseLogFields {
+    /** Service identifier in kebab-case. e.g. 'windy-gateway', 'fx-api' */
+    service: string;
+    /** App version — recommended: process.env.npm_package_version */
+    version?: string;
+    /** Runtime environment — recommended: process.env.NODE_ENV */
+    env?: string;
+}
+/**
+ * Options for createLogger — extends BaseLogFields with sampling config.
+ */
+interface CreateLoggerOptions extends BaseLogFields {
+    /**
+     * Sample rates per level. e.g. { trace: 100 } emits every 100th trace log.
+     * Skipped logs are counted — the emitted log includes `sampled_count` and
+     * `sampled_total` fields so no data is lost.
+     * Levels not listed here (and warn/error/fatal/alert) always emit every log.
+     */
+    sample?: Partial<Record<LogLevel, number>>;
+}
+/**
+ * Fields to include when logging an HTTP request context.
+ * Bind these via logger.child() at request start.
+ */
+interface RequestContext {
+    req_id: string;
+    method?: string;
+    path?: string;
+    user_id?: string;
+}
+/**
+ * Fields to include when logging an error.
+ * Always pass the raw Error object as `err` — Pino serialises it automatically.
+ */
+interface ErrorContext {
+    err: Error | unknown;
+    req_id?: string;
+    [key: string]: unknown;
+}
+/**
+ * Fields for structured metric logging.
+ */
+interface MetricFields {
+    /** Metric identifier in snake_case. e.g. 'http_request_duration_ms' */
+    metric_name: string;
+    /** Numeric value of the metric */
+    metric_value: number;
+    /** Unit of measurement. e.g. 'ms', 'bytes', 'count' */
+    metric_unit?: string;
+    [key: string]: unknown;
+}
+/**
+ * Timer returned by startTimer().
+ */
+interface Timer {
+    /** Returns elapsed time in milliseconds */
+    elapsed(): number;
+    /** Logs at info level with duration_ms field */
+    done(msg: string): void;
+    done(obj: Record<string, unknown>, msg: string): void;
+}
+
+type PinoInstance = pino.Logger<'alert'>;
+interface SampleState {
+    since_last_emit: number;
+    total: number;
+}
+/**
+ * Opinionated Pino wrapper with:
+ * - LOG_LEVEL / LOG_VERBOSE env var control
+ * - Level prefix in messages: "[INFO] msg" for log parser alerting
+ * - Full Error serialisation (message, stack, code) via `err` field
+ * - alert() — highest severity level (above fatal), does NOT kill process
+ * - fatal() kills the process with exit code 1
+ * - child() returns PinoLogger (not raw Pino instance)
+ * - AsyncLocalStorage context propagation (withContext)
+ * - Request duration tracking (startTimer)
+ * - Structured metric logging (metric)
+ * - Log sampling with counting (no data loss)
+ * - Graceful async shutdown
+ * - pino-pretty in development (NODE_ENV=development)
+ * - Sensitive field redaction
+ */
+declare class PinoLogger {
+    private readonly _pino;
+    private readonly _sample;
+    private readonly _sampleState;
+    constructor(pinoInstance: PinoInstance, sample?: Partial<Record<LogLevel, number>>, sampleState?: Map<string, SampleState>);
+    /**
+     * Internal log dispatch. Handles sampling, async context merge,
+     * and level prefix injection. Optimised for the common fast path
+     * (no context, no sampling) to avoid object allocation.
+     */
+    private _log;
+    trace(obj: Record<string, unknown>, msg: string): void;
+    trace(msg: string): void;
+    debug(obj: Record<string, unknown>, msg: string): void;
+    debug(msg: string): void;
+    info(obj: Record<string, unknown>, msg: string): void;
+    info(msg: string): void;
+    warn(obj: Record<string, unknown>, msg: string): void;
+    warn(msg: string): void;
+    error(obj: Record<string, unknown>, msg: string): void;
+    error(msg: string): void;
+    /**
+     * Logs at FATAL level then kills the process with exit code 1.
+     * Flushes sample counters and log buffer before exiting.
+     */
+    fatal(obj: Record<string, unknown>, msg: string): never;
+    fatal(msg: string): never;
+    /**
+     * Logs at ALERT level — highest severity, above fatal.
+     * Use for conditions requiring immediate operator attention:
+     * - Security breaches detected
+     * - Data corruption detected
+     * - Critical SLA violations
+     *
+     * Unlike fatal(), alert() does NOT kill the process.
+     * The service continues running so it can handle other requests.
+     *
+     * @example
+     * logger.alert({ breach_type: 'unauthorized_access', ip }, 'security breach detected');
+     */
+    alert(obj: Record<string, unknown>, msg: string): void;
+    alert(msg: string): void;
+    /**
+     * Creates a child logger with additional bound fields.
+     * Shares sample counters with the parent for consistent global sampling.
+     */
+    child(bindings: Record<string, unknown>): PinoLogger;
+    /**
+     * Starts a high-resolution timer. Returns a Timer object with:
+     * - elapsed(): returns ms elapsed so far
+     * - done(msg) / done(obj, msg): logs at info level with duration_ms
+     *
+     * @example
+     * const timer = logger.startTimer();
+     * await processRequest();
+     * timer.done({ req_id }, 'request processed'); // includes duration_ms
+     */
+    startTimer(): Timer;
+    /**
+     * Emits a structured metric log at info level.
+     * All metric logs include `metric_type: "metric"` for easy filtering
+     * in your log parser / aggregator.
+     *
+     * @example
+     * logger.metric({ metric_name: 'http_request_duration', metric_value: 42, metric_unit: 'ms' });
+     * logger.metric({ metric_name: 'queue_depth', metric_value: 150, metric_unit: 'count', queue: 'orders' });
+     */
+    metric(fields: MetricFields): void;
+    /**
+     * Flushes any remaining sample counters as summary log lines.
+     * Called automatically by fatal() and shutdown().
+     * Call manually if you need to ensure all counts are emitted.
+     */
+    flushSampleCounts(): void;
+    /**
+     * Gracefully shuts down the logger:
+     * 1. Flushes any remaining sample counters
+     * 2. Flushes the Pino write buffer (important for async transports)
+     *
+     * Call this on SIGTERM / SIGINT before process exit.
+     *
+     * @example
+     * process.on('SIGTERM', async () => {
+     *   logger.info('shutting down');
+     *   await logger.shutdown();
+     *   process.exit(0);
+     * });
+     */
+    shutdown(): Promise<void>;
+    isLevelEnabled(level: LogLevel): boolean;
+    /**
+     * Exposes the raw Pino Logger instance.
+     * Use for integrations that require it directly (e.g. pino-http).
+     */
+    get instance(): PinoInstance;
+}
+/**
+ * Creates a configured PinoLogger instance.
+ *
+ * Reads from environment:
+ *   LOG_LEVEL   — trace|debug|info|warn|error|fatal|alert  (default: info)
+ *   LOG_VERBOSE — true|false  forces trace level            (default: false)
+ *   NODE_ENV    — development enables pino-pretty           (default: production)
+ *
+ * @example
+ * const logger = createLogger({
+ *   service: 'windy-gateway',
+ *   version: process.env.npm_package_version,
+ *   env: process.env.NODE_ENV,
+ *   sample: { trace: 100, debug: 10 }, // emit every 100th trace, every 10th debug
+ * });
+ */
+declare function createLogger(fields: CreateLoggerOptions): PinoLogger;
+
+/**
+ * Runs a function with context fields that are automatically merged
+ * into every log call within that async scope.
+ *
+ * Contexts nest — inner calls inherit and can override outer fields.
+ *
+ * @example
+ * // In middleware:
+ * app.use((req, res, next) => {
+ *   withContext({ req_id: req.id, user_id: req.userId }, next);
+ * });
+ *
+ * // Anywhere in the call stack — no need to pass logger around:
+ * logger.info('processing'); // automatically includes req_id, user_id
+ */
+declare function withContext<T>(context: Record<string, unknown>, fn: () => T): T;
+/**
+ * Returns the current async context, or undefined if none is active.
+ * Used internally by PinoLogger to auto-merge context into log calls.
+ */
+declare function getContext(): Record<string, unknown> | undefined;
+
+export { type BaseLogFields, type CreateLoggerOptions, type ErrorContext, LOG_LEVELS, type LogLevel, type MetricFields, PinoLogger, type RequestContext, type Timer, createLogger, getContext, withContext };