@takeshape/logger 7.90.0

package/README.md

@@ -0,0 +1,5 @@
+# @takeshape/logger
+
+## Summary
+
+Logging utility.

package/es/index.js

@@ -0,0 +1 @@
+export { default, loggerWithContext, Logger, TimberMetadata } from './logger';

package/es/logger.js

@@ -0,0 +1,97 @@
+import merge from 'lodash/merge';
+import { captureException, setUser, setTag } from '@sentry/node';
+
+// eslint-disable-next-line @typescript-eslint/no-empty-function
+const noop = () => {};
+
+export function getLogFn(level) {
+  if (process.env.NODE_ENV === 'test') {
+    return noop;
+  }
+
+  if (process.env.IS_OFFLINE) {
+    const prettyjson = require('prettyjson'); // eslint-disable-line @typescript-eslint/no-var-requires
+
+
+    return (message, metadata) => {
+      console[level](message);
+
+      if (metadata) {
+        console[level](prettyjson.render(metadata), '\n');
+      }
+    };
+  }
+
+  return (message, metadata) => {
+    const args = [message];
+
+    if (metadata) {
+      const {
+        error,
+        ...rest
+      } = metadata;
+
+      if (error) {
+        captureException(error);
+        args.push(error);
+      }
+
+      if (Object.keys(rest).length) {
+        args.push(JSON.stringify(rest, null, 2));
+      }
+    }
+
+    console[level].apply(null, args);
+  };
+}
+
+function createLogger() {
+  return {
+    info: getLogFn('info'),
+    warn: getLogFn('warn'),
+    error: getLogFn('error')
+  };
+}
+
+export default createLogger();
+
+function setSentryTags(context) {
+  var _context$custom, _context$custom$proje, _context$user;
+
+  if ((_context$custom = context.custom) !== null && _context$custom !== void 0 && (_context$custom$proje = _context$custom.project) !== null && _context$custom$proje !== void 0 && _context$custom$proje.id) {
+    var _context$custom2, _context$custom2$proj;
+
+    setTag('projectId', (_context$custom2 = context.custom) === null || _context$custom2 === void 0 ? void 0 : (_context$custom2$proj = _context$custom2.project) === null || _context$custom2$proj === void 0 ? void 0 : _context$custom2$proj.id);
+  }
+
+  if ((_context$user = context.user) !== null && _context$user !== void 0 && _context$user.id) {
+    setUser({
+      id: context.user.id
+    });
+  }
+}
+
+export function loggerWithContext(fnContext) {
+  let context = fnContext;
+  setSentryTags(context);
+
+  const decorate = logFn => (message, metadata) => {
+    logFn(message, {
+      context,
+      ...metadata
+    });
+  };
+
+  return {
+    info: decorate(getLogFn('info')),
+    warn: decorate(getLogFn('warn')),
+    error: decorate(getLogFn('error')),
+
+    updateContext(update) {
+      setSentryTags(update);
+      context = merge(context, update);
+    },
+
+    context
+  };
+}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export { default, loggerWithContext, Logger, TimberMetadata } from './logger';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAE,iBAAiB,EAAE,MAAM,EAAE,cAAc,EAAC,MAAM,UAAU,CAAC"}

package/lib/index.js

@@ -0,0 +1,35 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function () {
+    return _logger.default;
+  }
+});
+Object.defineProperty(exports, "loggerWithContext", {
+  enumerable: true,
+  get: function () {
+    return _logger.loggerWithContext;
+  }
+});
+Object.defineProperty(exports, "Logger", {
+  enumerable: true,
+  get: function () {
+    return _logger.Logger;
+  }
+});
+Object.defineProperty(exports, "TimberMetadata", {
+  enumerable: true,
+  get: function () {
+    return _logger.TimberMetadata;
+  }
+});
+
+var _logger = _interopRequireWildcard(require("./logger"));
+
+function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
+
+function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }

package/lib/logger.d.ts

@@ -0,0 +1,17 @@
+import { TimberContext, TimberLogEntry } from './types';
+export interface TimberMetadata extends Partial<TimberLogEntry> {
+    error?: Error;
+}
+export declare type LogFn = (message: string, metadata?: TimberMetadata) => void;
+export interface Logger {
+    info: LogFn;
+    error: LogFn;
+    warn: LogFn;
+    updateContext: (context: TimberContext) => void;
+    context: TimberContext;
+}
+export declare function getLogFn(level: 'info' | 'warn' | 'error'): LogFn;
+declare const _default: Record<string, LogFn>;
+export default _default;
+export declare function loggerWithContext(fnContext: TimberContext): Logger;
+//# sourceMappingURL=logger.d.ts.map

package/lib/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,aAAa,EAAE,cAAc,EAAC,MAAM,SAAS,CAAC;AAGtD,MAAM,WAAW,cAAe,SAAQ,OAAO,CAAC,cAAc,CAAC;IAC7D,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AACD,oBAAY,KAAK,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,KAAK,IAAI,CAAC;AAEzE,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,KAAK,CAAC;IACZ,KAAK,EAAE,KAAK,CAAC;IACb,IAAI,EAAE,KAAK,CAAC;IACZ,aAAa,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,IAAI,CAAC;IAChD,OAAO,EAAE,aAAa,CAAC;CACxB;AAKD,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CA+BhE;;AAUD,wBAA8B;AAW9B,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,aAAa,GAAG,MAAM,CAkBlE"}

package/lib/logger.js

@@ -0,0 +1,111 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getLogFn = getLogFn;
+exports.loggerWithContext = loggerWithContext;
+exports.default = void 0;
+
+var _merge = _interopRequireDefault(require("lodash/merge"));
+
+var _node = require("@sentry/node");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// eslint-disable-next-line @typescript-eslint/no-empty-function
+const noop = () => {};
+
+function getLogFn(level) {
+  if (process.env.NODE_ENV === 'test') {
+    return noop;
+  }
+
+  if (process.env.IS_OFFLINE) {
+    const prettyjson = require('prettyjson'); // eslint-disable-line @typescript-eslint/no-var-requires
+
+
+    return (message, metadata) => {
+      console[level](message);
+
+      if (metadata) {
+        console[level](prettyjson.render(metadata), '\n');
+      }
+    };
+  }
+
+  return (message, metadata) => {
+    const args = [message];
+
+    if (metadata) {
+      const {
+        error,
+        ...rest
+      } = metadata;
+
+      if (error) {
+        (0, _node.captureException)(error);
+        args.push(error);
+      }
+
+      if (Object.keys(rest).length) {
+        args.push(JSON.stringify(rest, null, 2));
+      }
+    }
+
+    console[level].apply(null, args);
+  };
+}
+
+function createLogger() {
+  return {
+    info: getLogFn('info'),
+    warn: getLogFn('warn'),
+    error: getLogFn('error')
+  };
+}
+
+var _default = createLogger();
+
+exports.default = _default;
+
+function setSentryTags(context) {
+  var _context$custom, _context$custom$proje, _context$user;
+
+  if ((_context$custom = context.custom) !== null && _context$custom !== void 0 && (_context$custom$proje = _context$custom.project) !== null && _context$custom$proje !== void 0 && _context$custom$proje.id) {
+    var _context$custom2, _context$custom2$proj;
+
+    (0, _node.setTag)('projectId', (_context$custom2 = context.custom) === null || _context$custom2 === void 0 ? void 0 : (_context$custom2$proj = _context$custom2.project) === null || _context$custom2$proj === void 0 ? void 0 : _context$custom2$proj.id);
+  }
+
+  if ((_context$user = context.user) !== null && _context$user !== void 0 && _context$user.id) {
+    (0, _node.setUser)({
+      id: context.user.id
+    });
+  }
+}
+
+function loggerWithContext(fnContext) {
+  let context = fnContext;
+  setSentryTags(context);
+
+  const decorate = logFn => (message, metadata) => {
+    logFn(message, {
+      context,
+      ...metadata
+    });
+  };
+
+  return {
+    info: decorate(getLogFn('info')),
+    warn: decorate(getLogFn('warn')),
+    error: decorate(getLogFn('error')),
+
+    updateContext(update) {
+      setSentryTags(update);
+      context = (0, _merge.default)(context, update);
+    },
+
+    context
+  };
+}

package/lib/types.d.ts

@@ -0,0 +1,624 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * The duration, in fractional milliseconds, that it took to complete this event.
+ */
+export declare type TimeMs = number;
+/**
+ * The target host of the HTTP request. This may not be the same as the real hostname of the server.
+ */
+export declare type HttpHost = string;
+/**
+ * The HTTP method for the request.
+ */
+export declare type HttpMethod = 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE';
+/**
+ * The path of the HTTP request.
+ */
+export declare type HttpPath = string;
+/**
+ * The IP address of the computer that issued the request.
+ */
+export declare type HttpRemoteAddr = string;
+/**
+ * An ID that uniquely identifies the request and can be used to trace requests.
+ */
+export declare type HttpRequestId = string;
+/**
+ * The body of the HTTP request / response.
+ */
+export declare type HttpBody = string;
+/**
+ * The value of the Content-Length header representing the size of the request in decimal number of octets.
+ */
+export declare type HttpContentLength = number;
+/**
+ * The direction of the HTTP request and response (incoming or outgoing).
+ */
+export declare type HttpDirection = 'incoming' | 'outgoing';
+/**
+ * An encoded JSON string representing *all* HTTP headers. This is used for request inspection without the overhead of creating and indexing fields for every header.
+ */
+export declare type HttpHeadersJson = string;
+/**
+ * The target port of the HTTP request. This may be different than the port the server is listening on.
+ */
+export declare type HttpPort = number;
+/**
+ * The query parameters present on the URL.
+ */
+export declare type HttpQueryString = string;
+/**
+ * The HTTP request scheme.
+ */
+export declare type HttpScheme = 'http' | 'https';
+/**
+ * A short label / name for the service you are sending the request to, ex: elasticsearch
+ */
+export declare type HttpServiceName = string;
+/**
+ * The status as defined by the HTTP status codes.
+ */
+export declare type HttpStatus = number;
+export interface TimberErrorBacktrace {
+    /**
+     * Application name, if applicable. For example, erlang / elixir have multiple apps within the same umbrella project.
+     */
+    app_name?: string;
+    /**
+     * The line file path.
+     */
+    file: string;
+    /**
+     * The calling function name.
+     */
+    function: string;
+    /**
+     * The calling line number.
+     */
+    line: number;
+}
+export interface TimberError {
+    /**
+     * An optional array of lines, representing the call stack, leading up to the error.
+     */
+    backtrace?: TimberErrorBacktrace[];
+    /**
+     * Optional message describing the error.
+     */
+    message?: string;
+    /**
+     * A JSON encoded string representing additional metadata. This provides insight without the overhead of creating and indexing fields.
+     */
+    metadata_json?: string;
+    /**
+     * Required name of the error.
+     */
+    name: string;
+}
+export interface TimberContext {
+    /**
+     * An open ended object where custom context is supplied.
+     */
+    custom?: Record<string, Record<string, any>>;
+    /**
+     * Context about the HTTP request currently being processed (if any)
+     */
+    http?: {
+        host?: HttpHost;
+        method: HttpMethod;
+        path?: HttpPath;
+        remote_addr?: HttpRemoteAddr;
+        request_id?: HttpRequestId;
+    };
+    /**
+     * Represents a task or job execution, typically for background tasks or jobs.
+     */
+    job?: {
+        /**
+         * The attempt number, if applicable.
+         */
+        attempt?: number;
+        /**
+         * A unique identifier for the job or task.
+         */
+        id?: string;
+        /**
+         * The name of the queue being processes, if applicable.
+         */
+        queue_name?: string;
+    };
+    /**
+     * Represents an organization in the platform being logged. The interpretation of "organization" is left to the consumer.
+     */
+    organization?: {
+        /**
+         * A unique identifier for the organization
+         */
+        id?: string;
+        /**
+         * A display name for the organization
+         */
+        name?: string;
+    };
+    /**
+     * Contextual information about the hosting platform (AWS, Google Cloud, Heroku, etc) the application is hosted.
+     */
+    platform?: {
+        /**
+         * Contextual information for the Heroku platform.
+         */
+        heroku?: {
+            /**
+             * The dyno type for the process (web, worker, router, etc)
+             */
+            dyno_type: string;
+            /**
+             * The dyno ID for the process.
+             */
+            dyno_id?: number;
+            /**
+             * The source of the log message. For example, Heroku can send log messages for the web.1 dyno from both within the app and Heroku itself.
+             */
+            source: 'app' | 'heroku';
+            [k: string]: any;
+        };
+        /**
+         * Information about the Amazon EC2 instance
+         */
+        aws_ec2?: {
+            /**
+             * Amazon Machine Image (AMI) identifier that the instance was launched from
+             */
+            ami_id: string;
+            /**
+             * Hostname of the instance assigned by AWS. The operating system may report a different hostname based on configuration.
+             */
+            hostname?: string;
+            /**
+             * The unique identifier for the EC2 instance
+             */
+            instance_id: string;
+            /**
+             * The instance type of the EC2 image (for example, `t2.small`)
+             */
+            instance_type: string;
+            /**
+             * Public hostname assigned by AWS to the EC2 instance. The operating system may report a different hostname based on configuration.
+             */
+            public_hostname?: string;
+            [k: string]: any;
+        };
+        /**
+         * Contextual information about the Pod running on the Kubernetes platform
+         */
+        kubernetes?: {
+            /**
+             * The unique identifier for the Docker container running inside the Kubernetes Pod
+             */
+            container_name: string;
+            /**
+             * The collection of key value pairs found in the Kubernetes Pod metadata field Labels
+             */
+            labels?: Record<string, any>;
+            /**
+             * The Kubernetes namespace in which the Pod is running
+             */
+            namespace: string;
+            /**
+             * The name of the Kubernetes Pod in which the Docker container is running
+             */
+            pod_name: string;
+            /**
+             * The Kubernetes Resource that is top level owner of the Pod as found through the ownerReferences metadata. This is primarily but not always a Contoller
+             */
+            root_owner?: {
+                /**
+                 * The kind or type of Kubernetes resource
+                 */
+                kind?: string;
+                /**
+                 * The unique name of the Kubernetes resource
+                 */
+                name?: string;
+                [k: string]: any;
+            };
+            [k: string]: any;
+        };
+    };
+    /**
+     * Contextual information on the current release
+     */
+    release?: {
+        /**
+         * The git commit sha for the deploy
+         */
+        commit_hash?: string;
+        /**
+         * When the release was created, ISO8601 date time.
+         */
+        created_at?: string;
+        /**
+         * Deploy version, can be an unique string. Ex: 1.1.2 or a43fdw
+         */
+        version?: string;
+    };
+    /**
+     * Represents the language runtime details.
+     */
+    runtime?: {
+        /**
+         * The current application name
+         */
+        application?: string;
+        /**
+         * The current class name, if applicable.
+         */
+        class_name?: string;
+        /**
+         * The current file path from the root of the project.
+         */
+        file?: string;
+        /**
+         * The current function name, if applicable.
+         */
+        function?: string;
+        /**
+         * The current line number with in the file.
+         */
+        line?: number;
+        /**
+         * The current module name, if applicable.
+         */
+        module_name?: string;
+        /**
+         * The logical process ID as defined by the current language, if applicable.
+         */
+        vm_pid?: string;
+    };
+    /**
+     * The user's current session. A session is a way to track a user without the need for authentication. For example, a browser session is generally maintained through a cookie and assigned a unique ID.
+     */
+    session?: {
+        /**
+         * The unique ID of this session.
+         */
+        id?: string;
+    };
+    /**
+     * Context about the source of the log
+     */
+    source?: {
+        /**
+         * The name of the file the log was read from (e.g., "nodejs.log")
+         */
+        file_name?: string;
+    };
+    /**
+     * Host and system level details tha the log was generated on.
+     */
+    system?: {
+        /**
+         * The system's hostname.
+         */
+        hostname?: string;
+        /**
+         * The system's IP address (v4 or v6).
+         */
+        ip?: string;
+        /**
+         * The originating process ID as defined by the `pid` command in Unix.
+         */
+        pid?: number;
+        /**
+         * The originating process name.
+         */
+        process_name?: string;
+    };
+    /**
+     * Represents a user in the platform being logged. The interpretation of "user" is left to the consumer.
+     */
+    user?: {
+        /**
+         * An email address for the user. This need not be unique to the user. Note that no validation is performed on this field.
+         */
+        email?: string;
+        /**
+         * A unique identifier for the user.
+         */
+        id?: string;
+        /**
+         * Additional custom metadata you'd like to add to the user.
+         */
+        meta?: Record<string, any>;
+        /**
+         * A display name for the user.
+         */
+        name?: string;
+        /**
+         * The type of user. Used in systems where there are multiple user types. This helps to denote users in the case of polymorphism.
+         */
+        type?: string;
+    };
+}
+export interface TimberEvent {
+    /**
+     * Represents the joining of a multi-plexed websocket channel.
+     */
+    channel_join?: {
+        /**
+         * The name of the channel being joined.
+         */
+        channel: string;
+        /**
+         * The name of the channel topic being joined.
+         */
+        topic: string;
+        /**
+         * A JSON encoded string representing additional metadata. This provides insight without the overhead of creating and indexing fields.
+         */
+        metadata_json?: string;
+    };
+    /**
+     * Represents the receiption of an event on a multi-plexed websocket channel.
+     */
+    channel_receive?: {
+        /**
+         * The name of the channel being joined.
+         */
+        channel: string;
+        /**
+         * The name of the channel topic being joined.
+         */
+        topic: string;
+        /**
+         * The name of the event being received.
+         */
+        event: string;
+        /**
+         * A JSON encoded string representing additional metadata. This provides insight without the overhead of creating and indexing fields.
+         */
+        metadata_json?: string;
+    };
+    /**
+     * Represents the calling of a controller, typically logged immediately after the request is routed.
+     */
+    controller_call?: {
+        /**
+         * The name of the controller being called.
+         */
+        controller: string;
+        /**
+         * The name of the controller action being called.
+         */
+        action: string;
+        /**
+         * An encoded JSON string representing the parsed parameters being sent to the controller. This provides additional insight without the overhead of creating and indexing fields for every paramter.
+         */
+        params_json?: string;
+    };
+    /**
+     * An open ended object used for custom event data. Only a single root key is allowed, this represents the event type and avoids type collisions in the context of the entire schema.
+     */
+    custom?: Record<string, Record<string, any>>;
+    /**
+     * Represents an error or exception.
+     */
+    error?: TimberError;
+    /**
+     * Represents a HTTP request, both incoming and outgoing. Note the direction field.
+     */
+    http_request?: {
+        body?: HttpBody;
+        content_length?: HttpContentLength;
+        direction?: HttpDirection;
+        headers?: HttpHeaders;
+        headers_json?: HttpHeadersJson;
+        host?: HttpHost;
+        method: HttpMethod;
+        path?: HttpPath;
+        port?: HttpPort;
+        query_string?: HttpQueryString;
+        request_id?: HttpRequestId;
+        scheme?: HttpScheme;
+        service_name?: HttpServiceName;
+    };
+    /**
+     * Represents a HTTP response event, both outgoing and incoming. Note the direction field.
+     */
+    http_response?: {
+        body?: HttpBody;
+        content_length?: HttpContentLength;
+        direction?: HttpDirection;
+        headers?: HttpHeaders;
+        headers_json?: HttpHeadersJson;
+        request_id?: HttpRequestId;
+        service_name?: HttpServiceName;
+        status: HttpStatus;
+        time_ms?: TimeMs;
+        /**
+         * The request being responded to. This couples the request data with the response event avoiding the need for joins or external data dependencies. In many cases the data must be coupled with this event because it is represented as a single event (nginx, apache web server, and other reverse proxy servers).
+         */
+        request?: {
+            host?: HttpHost;
+            method?: HttpMethod;
+            path?: HttpPath;
+            scheme?: HttpScheme;
+            [k: string]: any;
+        };
+    };
+    /**
+     * Represents a resource usage sample for a target server, application, or both.
+     */
+    resource_sample?: {
+        /**
+         * A sample of the current server processor usage.
+         */
+        cpu?: {
+            /**
+             * The load average for the processor in the last 1 minute. This reflects the number of CPU tasks that are in the ready queue (i.e. waiting to be processed).
+             */
+            load_avg_1m: number;
+            /**
+             * The load average for the processor in the last 5 minutes. This reflects the number of CPU tasks that are in the ready queue (i.e. waiting to be processed).
+             */
+            load_avg_5m?: number;
+            /**
+             * The load average for the processor in the last 10 minutes. This reflects the number of CPU tasks that are in the ready queue (i.e. waiting to be processed).
+             */
+            load_avg_15m?: number;
+        };
+        /**
+         * A sample of cache statistics and state.
+         */
+        cache?: {
+            /**
+             * The number of active connections established with the database.
+             */
+            active_connections?: number;
+            /**
+             * The ratio of successful reads out of all read operations.
+             */
+            index_cache_hit_rate?: number;
+            /**
+             * The number of evicted keys.
+             */
+            evicted_keys?: number;
+        };
+        /**
+         * A sample of database statistics and state.
+         */
+        database?: {
+            /**
+             * The number of bytes contained in the database. This includes all table and index data on disk, including database bloat.
+             */
+            db_size?: number;
+            /**
+             * The number of tables in the database
+             */
+            tables?: number;
+            /**
+             * The number of active connections established with the database.
+             */
+            active_connections?: number;
+            /**
+             * The current transaction ID, which can be used to track writes over time.
+             */
+            current_transaction?: string;
+            /**
+             * Ratio of queries that used an index (instead of only sequential scans), rounded to five decimal points.
+             */
+            index_cache_hit_rate?: number;
+            /**
+             * Ratio of table lookups served from shared buffer cache, rounded to five decimal points.
+             */
+            table_cache_hit_rate?: number;
+            /**
+             * Number of connections waiting on a lock to be acquired.
+             */
+            waiting_connections?: number;
+        };
+        /**
+         * A sample of a server's disk usage.
+         */
+        disk?: {
+            /**
+             * Number of read operations in I/O sizes of 16KB blocks.
+             */
+            read_iops: number;
+            /**
+             * Number of write operations in I/O sizes of 16KB blocks.
+             */
+            write_iops: number;
+        };
+        /**
+         * A sample of a server's memory usage.
+         */
+        memory?: {
+            /**
+             * The portion of the memory used for disk cache.
+             */
+            cache_mb?: number;
+            /**
+             * The amount of free memory availabe in megabytes.
+             */
+            free_mb?: number;
+            /**
+             * The cumulative total of the pages read from disk. Sudden high variations on this number can indicate short duration spikes in swap usage. The other memory related metrics are point in time snapshots and can miss short spikes.
+             */
+            pgpgin?: number;
+            /**
+             * The cumulative total of the pages written to disk. Sudden high variations on this number can indicate short duration spikes in swap usage. The other memory related metrics are point in time snapshots and can miss short spikes.
+             */
+            pgpgout?: number;
+            /**
+             * The portion of the memory being used by the target application oin megabytes.
+             */
+            rss_mb?: number;
+            /**
+             * The portion of the memory stored on disk. Swap usually indicates a shortage of memory in megabytes.
+             */
+            swap_mb?: number;
+            /**
+             * The sum of the rss, cache, and swap that equals the total memory being used in megabytes.
+             */
+            total_mb: number;
+        };
+        [k: string]: any;
+    };
+    /**
+     * An outgoing SQL query sent from the application.
+     */
+    sql_query?: {
+        /**
+         * The actual SQL statement sent.
+         */
+        sql: string;
+        time_ms: TimeMs;
+    };
+    /**
+     * Rendering a template to be sent to the client via the HTTP response.
+     */
+    template_render?: {
+        /**
+         * The unique name of the template. This generally includes the path.
+         */
+        name: string;
+        time_ms: TimeMs;
+    };
+}
+export interface TimberLogEntry {
+    /**
+     * The IOS8601 formatted datetime when the log was generated.
+     */
+    dt: string;
+    /**
+     * The descriptive level of the log in string format. The available options adhere to the Syslog 5424 specification.
+     */
+    level?: 'debug' | 'info' | 'notice' | 'warn' | 'error' | 'critical' | 'alert' | 'emergency';
+    /**
+     * The numerical severity of the message represented by an integer between 0 and 7. The available options adhere to the Syslog 5424 specification.
+     */
+    severity?: number;
+    /**
+     * The raw log event message, formatting stripped.
+     */
+    message: string;
+    time_ms?: TimeMs;
+    /**
+     * Contextual metadata about the environment the event takes place in
+     */
+    context?: TimberContext;
+    /**
+     * A controlled representation of the event this log line represents.
+     */
+    event?: TimberEvent;
+}
+/**
+ * An object representing *select* HTTP headers that need to be searched or graphed.
+ */
+export declare type HttpHeaders = Record<string, any>;
+//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AACA;;;;GAIG;AAEH;;GAEG;AACH,oBAAY,MAAM,GAAG,MAAM,CAAC;AAC5B;;GAEG;AACH,oBAAY,QAAQ,GAAG,MAAM,CAAC;AAC9B;;GAEG;AACH,oBAAY,UAAU,GAAG,SAAS,GAAG,QAAQ,GAAG,KAAK,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,CAAC;AAChH;;GAEG;AACH,oBAAY,QAAQ,GAAG,MAAM,CAAC;AAC9B;;GAEG;AACH,oBAAY,cAAc,GAAG,MAAM,CAAC;AACpC;;GAEG;AACH,oBAAY,aAAa,GAAG,MAAM,CAAC;AACnC;;GAEG;AACH,oBAAY,QAAQ,GAAG,MAAM,CAAC;AAC9B;;GAEG;AACH,oBAAY,iBAAiB,GAAG,MAAM,CAAC;AACvC;;GAEG;AACH,oBAAY,aAAa,GAAG,UAAU,GAAG,UAAU,CAAC;AACpD;;GAEG;AACH,oBAAY,eAAe,GAAG,MAAM,CAAC;AACrC;;GAEG;AACH,oBAAY,QAAQ,GAAG,MAAM,CAAC;AAC9B;;GAEG;AACH,oBAAY,eAAe,GAAG,MAAM,CAAC;AACrC;;GAEG;AACH,oBAAY,UAAU,GAAG,MAAM,GAAG,OAAO,CAAC;AAC1C;;GAEG;AACH,oBAAY,eAAe,GAAG,MAAM,CAAC;AACrC;;GAEG;AACH,oBAAY,UAAU,GAAG,MAAM,CAAC;AAEhC,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;IAC7C;;OAEG;IACH,IAAI,CAAC,EAAE;QACL,IAAI,CAAC,EAAE,QAAQ,CAAC;QAChB,MAAM,EAAE,UAAU,CAAC;QACnB,IAAI,CAAC,EAAE,QAAQ,CAAC;QAChB,WAAW,CAAC,EAAE,cAAc,CAAC;QAC7B,UAAU,CAAC,EAAE,aAAa,CAAC;KAC5B,CAAC;IACF;;OAEG;IACH,GAAG,CAAC,EAAE;QACJ;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF;;OAEG;IACH,YAAY,CAAC,EAAE;QACb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACF;;OAEG;IACH,QAAQ,CAAC,EAAE;QACT;;WAEG;QACH,MAAM,CAAC,EAAE;YACP;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAClB;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB;;eAEG;YACH,MAAM,EAAE,KAAK,GAAG,QAAQ,CAAC;YACzB,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;SAClB,CAAC;QACF;;WAEG;QACH,OAAO,CAAC,EAAE;YACR;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YACf;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YACpB;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YACtB;;eAEG;YACH,eAAe,CAAC,EAAE,MAAM,CAAC;YACzB,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;SAClB,CAAC;QACF;;WAEG;QACH,UAAU,CAAC,EAAE;YACX;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC;YACvB;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YAC7B;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAClB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YACjB;;eAEG;YACH,UAAU,CAAC,EAAE;gBACX;;mBAEG;gBACH,IAAI,CAAC,EAAE,MAAM,CAAC;gBACd;;mBAEG;gBACH,IAAI,CAAC,EAAE,MAAM,CAAC;gBACd,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;aAClB,CAAC;YACF,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;SAClB,CAAC;KACH,CAAC;IACF;;OAEG;IACH,OAAO,CAAC,EAAE;QACR;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF;;OAEG;IACH,OAAO,CAAC,EAAE;QACR;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF;;OAEG;IACH,OAAO,CAAC,EAAE;QACR;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;KACb,CAAC;IACF;;OAEG;IACH,MAAM,CAAC,EAAE;QACP;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF;;OAEG;IACH,MAAM,CAAC,EAAE;QACP;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;IACF;;OAEG;IACH,IAAI,CAAC,EAAE;QACL;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC3B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,YAAY,CAAC,EAAE;QACb;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAChB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IACF;;OAEG;IACH,eAAe,CAAC,EAAE;QAChB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAChB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IACF;;OAEG;IACH,eAAe,CAAC,EAAE;QAChB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QACnB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QACf;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IACF;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;IAC7C;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE;QACb,IAAI,CAAC,EAAE,QAAQ,CAAC;QAChB,cAAc,CAAC,EAAE,iBAAiB,CAAC;QACnC,SAAS,CAAC,EAAE,aAAa,CAAC;QAC1B,OAAO,CAAC,EAAE,WAAW,CAAC;QACtB,YAAY,CAAC,EAAE,eAAe,CAAC;QAC/B,IAAI,CAAC,EAAE,QAAQ,CAAC;QAChB,MAAM,EAAE,UAAU,CAAC;QACnB,IAAI,CAAC,EAAE,QAAQ,CAAC;QAChB,IAAI,CAAC,EAAE,QAAQ,CAAC;QAChB,YAAY,CAAC,EAAE,eAAe,CAAC;QAC/B,UAAU,CAAC,EAAE,aAAa,CAAC;QAC3B,MAAM,CAAC,EAAE,UAAU,CAAC;QACpB,YAAY,CAAC,EAAE,eAAe,CAAC;KAChC,CAAC;IACF;;OAEG;IACH,aAAa,CAAC,EAAE;QACd,IAAI,CAAC,EAAE,QAAQ,CAAC;QAChB,cAAc,CAAC,EAAE,iBAAiB,CAAC;QACnC,SAAS,CAAC,EAAE,aAAa,CAAC;QAC1B,OAAO,CAAC,EAAE,WAAW,CAAC;QACtB,YAAY,CAAC,EAAE,eAAe,CAAC;QAC/B,UAAU,CAAC,EAAE,aAAa,CAAC;QAC3B,YAAY,CAAC,EAAE,eAAe,CAAC;QAC/B,MAAM,EAAE,UAAU,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;WAEG;QACH,OAAO,CAAC,EAAE;YACR,IAAI,CAAC,EAAE,QAAQ,CAAC;YAChB,MAAM,CAAC,EAAE,UAAU,CAAC;YACpB,IAAI,CAAC,EAAE,QAAQ,CAAC;YAChB,MAAM,CAAC,EAAE,UAAU,CAAC;YACpB,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;SAClB,CAAC;KACH,CAAC;IACF;;OAEG;IACH,eAAe,CAAC,EAAE;QAChB;;WAEG;QACH,GAAG,CAAC,EAAE;YACJ;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YACpB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB,CAAC;QACF;;WAEG;QACH,KAAK,CAAC,EAAE;YACN;;eAEG;YACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;YAC5B;;eAEG;YACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;YAC9B;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB,CAAC;QACF;;WAEG;QACH,QAAQ,CAAC,EAAE;YACT;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB;;eAEG;YACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;YAC5B;;eAEG;YACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAC7B;;eAEG;YACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;YAC9B;;eAEG;YACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;YAC9B;;eAEG;YACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;SAC9B,CAAC;QACF;;WAEG;QACH,IAAI,CAAC,EAAE;YACL;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAClB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACpB,CAAC;QACF;;WAEG;QACH,MAAM,CAAC,EAAE;YACP;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;SAClB,CAAC;QACF,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;KAClB,CAAC;IACF;;OAEG;IACH,SAAS,CAAC,EAAE;QACV;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF;;OAEG;IACH,eAAe,CAAC,EAAE;QAChB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,OAAO,GAAG,WAAW,CAAC;IAC5F;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AACD;;GAEG;AACH,oBAAY,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC"}

package/lib/types.js

@@ -0,0 +1 @@
+"use strict";

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@takeshape/logger",
+  "version": "7.90.0",
+  "description": "Logging utility.",
+  "homepage": "https://www.takeshape.io",
+  "repository": {
+    "type": "git",
+    "url": "github.com:takeshape/takeshape.git"
+  },
+  "author": "asprouse",
+  "license": "UNLICENSED",
+  "engines": {
+    "node": ">=12"
+  },
+  "main": "lib/index.js",
+  "module": "es/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib",
+    "es"
+  ],
+  "scripts": {
+    "lint": "eslint . --ext .js,.ts",
+    "lint:code:ci": "eslint . --ext .js,.ts --format junit -o \"${HOME}/test-results/${npm_package_name#*\\/}/eslint-results.xml\"",
+    "test": "jest",
+    "test-changed": "pnpm run test -- --changedSince=master",
+    "test:ci": "JEST_JUNIT_OUTPUT_DIR=\"${HOME}/test-results/${npm_package_name#*\\/}\" JEST_JUNIT_OUTPUT_NAME=jest-results.xml jest --ci --reporters=default --reporters=jest-junit",
+    "typecheck": "tsc --noEmit",
+    "clean": "rimraf lib es build *.tsbuildinfo",
+    "prepublishOnly": "pnpm lint && pnpm test && pnpm clean && pnpm build",
+    "build": "pnpm clean && pnpm build:types && pnpm build:js && pnpm build:es && pnpm build:copy",
+    "build:types": "tsc --emitDeclarationOnly --project tsconfig.build.json",
+    "build:js": "cross-env BABEL_MODULES=commonjs babel src --out-dir lib --extensions \".js,.ts\" --ignore '**/__tests__'",
+    "build:es": "cross-env BABEL_MODULES=es babel src --out-dir es --extensions \".js,.ts\" --ignore '**/__tests__'",
+    "build:copy": "cp -rf build/src/* lib/",
+    "will-it-blend": "pnpm typecheck && pnpm lint -- --quiet && pnpm test -- --silent --coverage false"
+  },
+  "dependencies": {
+    "@sentry/node": "^5.27.2",
+    "lodash": "^4.17.20",
+    "prettyjson": "^1.2.1"
+  }
+}