@loglayer/transport-google-cloud-logging 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Theo Gravity
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,100 @@
+# Google Cloud Logging Transport for LogLayer
+
+[![NPM Version](https://img.shields.io/npm/v/%40loglayer%2Ftransport-google-cloud-logging)](https://www.npmjs.com/package/@loglayer/transport-google-cloud-logging)
+[![NPM Downloads](https://img.shields.io/npm/dm/%40loglayer%2Ftransport-google-cloud-logging)](https://www.npmjs.com/package/@loglayer/transport-google-cloud-logging)
+[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
+
+Implements the [Google Cloud Logging library](https://www.npmjs.com/package/@google-cloud/logging) for use with [LogLayer](https://loglayer.dev).
+
+This transport sends logs to [Google Cloud Logging](https://cloud.google.com/logging) (formerly known as Stackdriver Logging).
+
+## Installation
+
+```bash
+npm install @loglayer/transport-google-cloud-logging @google-cloud/logging serialize-error
+```
+
+## Notes
+
+This transport uses `log.entry(metadata, data)` as described in the library documentation.
+
+- The `metadata` portion is not the data from `withMetadata()` or `withContext()`. See the `rootLevelData` option
+  for this transport on how to modify this value.
+- The `data` portion is actually the `jsonPayload` is what the transport uses for all LogLayer data.
+- The message data is stored in `jsonPayload.message`
+
+For more information, see [Structured Logging](https://cloud.google.com/logging/docs/structured-logging), specifically
+[LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry).
+
+## Usage
+
+```typescript
+import { LogLayer } from "loglayer";
+import { GoogleCloudLoggingTransport } from "@loglayer/transport-google-cloud-logging";
+import { Logging } from '@google-cloud/logging';
+import { serializeError } from "serialize-error";
+
+// Create the logging client
+const logging = new Logging({ projectId: "GOOGLE_CLOUD_PLATFORM_PROJECT_ID" });
+const log = logging.log('my-log');
+
+// Create LogLayer instance with the transport
+const logger = new LogLayer({
+  errorSerializer: serializeError,
+  transport: new GoogleCloudLoggingTransport({
+    logger: log,
+  })
+});
+
+// The logs will include the default metadata
+logger.info("Hello from Cloud Run!");
+```
+
+## Configuration Options
+
+### `rootLevelData`
+
+The root level data to include for all log entries. 
+This is not the same as using `withContext()`, which would be included as part of the `jsonPayload`.
+
+The `rootLevelData` option accepts any valid [Google Cloud LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) 
+fields except for `severity`, `timestamp`, and `jsonPayload` which are managed by the transport.
+
+```typescript
+const logger = new LogLayer({
+  transport: new GoogleCloudLoggingTransport({
+    logger: log,
+    rootLevelData: {
+      resource: {
+        type: "cloud_run_revision",
+        labels: {
+          project_id: "my-project",
+          service_name: "my-service",
+          revision_name: "my-revision",
+        },
+      },
+      labels: {
+        environment: "production",
+        version: "1.0.0",
+      },
+    },
+  }),
+});
+```
+
+## Log Level Mapping
+
+LogLayer log levels are mapped to Google Cloud Logging severity levels as follows:
+
+| LogLayer Level | Google Cloud Logging Severity |
+|---------------|------------------------------|
+| `fatal` | `CRITICAL` |
+| `error` | `ERROR` |
+| `warn` | `WARNING` |
+| `info` | `INFO` |
+| `debug` | `DEBUG` |
+| `trace` | `DEBUG` |
+
+## Documentation
+
+For more details, visit [https://loglayer.dev/transports/google-cloud-logging](https://loglayer.dev/transports/google-cloud-logging)

package/dist/index.cjs

@@ -0,0 +1,49 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/GoogleCloudLoggingTransport.ts
+var _transport = require('@loglayer/transport');
+var GoogleCloudLoggingTransport = class extends _transport.BaseTransport {
+  
+  constructor(config) {
+    super(config);
+    this.rootLevelData = config.rootLevelData || {};
+  }
+  mapLogLevel(level) {
+    switch (level) {
+      case _transport.LogLevel.fatal:
+        return "CRITICAL";
+      case _transport.LogLevel.error:
+        return "ERROR";
+      case _transport.LogLevel.warn:
+        return "WARNING";
+      case _transport.LogLevel.info:
+        return "INFO";
+      case _transport.LogLevel.debug:
+        return "DEBUG";
+      case _transport.LogLevel.trace:
+        return "DEBUG";
+      default:
+        return "DEFAULT";
+    }
+  }
+  shipToLogger({ data, hasData, logLevel, messages }) {
+    const entry = this.logger.entry(
+      {
+        ...this.rootLevelData,
+        severity: this.mapLogLevel(logLevel),
+        timestamp: /* @__PURE__ */ new Date()
+      },
+      {
+        ...data && hasData ? data : {},
+        message: messages.join(" ")
+      }
+    );
+    this.logger.write(entry);
+    if (data && hasData) {
+      return [data, messages];
+    }
+    return [messages];
+  }
+};
+
+
+exports.GoogleCloudLoggingTransport = GoogleCloudLoggingTransport;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["/home/runner/work/loglayer/loglayer/packages/transports/google-cloud-logging/dist/index.cjs","../src/GoogleCloudLoggingTransport.ts"],"names":[],"mappings":"AAAA;ACEA,gDAAwC;AAYjC,IAAM,4BAAA,EAAN,MAAA,QAA0C,yBAAmB;AAAA,EAC1D;AAAA,EAER,WAAA,CAAY,MAAA,EAA2C;AACrD,IAAA,KAAA,CAAM,MAAM,CAAA;AACZ,IAAA,IAAA,CAAK,cAAA,EAAgB,MAAA,CAAO,cAAA,GAAiB,CAAC,CAAA;AAAA,EAChD;AAAA,EAEQ,WAAA,CAAY,KAAA,EAAyB;AAC3C,IAAA,OAAA,CAAQ,KAAA,EAAO;AAAA,MACb,KAAK,mBAAA,CAAS,KAAA;AACZ,QAAA,OAAO,UAAA;AAAA,MACT,KAAK,mBAAA,CAAS,KAAA;AACZ,QAAA,OAAO,OAAA;AAAA,MACT,KAAK,mBAAA,CAAS,IAAA;AACZ,QAAA,OAAO,SAAA;AAAA,MACT,KAAK,mBAAA,CAAS,IAAA;AACZ,QAAA,OAAO,MAAA;AAAA,MACT,KAAK,mBAAA,CAAS,KAAA;AACZ,QAAA,OAAO,OAAA;AAAA,MACT,KAAK,mBAAA,CAAS,KAAA;AACZ,QAAA,OAAO,OAAA;AAAA,MACT,OAAA;AACE,QAAA,OAAO,SAAA;AAAA,IACX;AAAA,EACF;AAAA,EAEA,YAAA,CAAa,EAAE,IAAA,EAAM,OAAA,EAAS,QAAA,EAAU,SAAS,CAAA,EAAmC;AAClF,IAAA,MAAM,MAAA,EAAQ,IAAA,CAAK,MAAA,CAAO,KAAA;AAAA,MACxB;AAAA,QACE,GAAG,IAAA,CAAK,aAAA;AAAA,QACR,QAAA,EAAU,IAAA,CAAK,WAAA,CAAY,QAAQ,CAAA;AAAA,QACnC,SAAA,kBAAW,IAAI,IAAA,CAAK;AAAA,MACtB,CAAA;AAAA,MACA;AAAA,QACE,GAAI,KAAA,GAAQ,QAAA,EAAU,KAAA,EAAO,CAAC,CAAA;AAAA,QAC9B,OAAA,EAAS,QAAA,CAAS,IAAA,CAAK,GAAG;AAAA,MAC5B;AAAA,IACF,CAAA;AAEA,IAAA,IAAA,CAAK,MAAA,CAAO,KAAA,CAAM,KAAK,CAAA;AAEvB,IAAA,GAAA,CAAI,KAAA,GAAQ,OAAA,EAAS;AACnB,MAAA,OAAO,CAAC,IAAA,EAAM,QAAQ,CAAA;AAAA,IACxB;AAEA,IAAA,OAAO,CAAC,QAAQ,CAAA;AAAA,EAClB;AACF,CAAA;ADjBA;AACE;AACF,kEAAC","file":"/home/runner/work/loglayer/loglayer/packages/transports/google-cloud-logging/dist/index.cjs","sourcesContent":[null,"import type { Log } from \"@google-cloud/logging\";\nimport type { LogEntry } from \"@google-cloud/logging/build/src/entry.js\";\nimport { BaseTransport, LogLevel } from \"@loglayer/transport\";\nimport type { LogLayerTransportConfig, LogLayerTransportParams } from \"@loglayer/transport\";\n\nexport interface GoogleCloudLoggingTransportConfig extends LogLayerTransportConfig<Log> {\n  /**\n   * The root level data to include for all log entries.\n   * \"severity\", \"timestamp\" and \"jsonPayload\" are already populated by the transport.\n   * @see https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry\n   */\n  rootLevelData?: Omit<LogEntry, \"severity\" | \"timestamp\" | \"jsonPayload\">;\n}\n\nexport class GoogleCloudLoggingTransport extends BaseTransport<Log> {\n  private rootLevelData: Omit<LogEntry, \"severity\" | \"timestamp\" | \"jsonPayload\">;\n\n  constructor(config: GoogleCloudLoggingTransportConfig) {\n    super(config);\n    this.rootLevelData = config.rootLevelData || {};\n  }\n\n  private mapLogLevel(level: LogLevel): string {\n    switch (level) {\n      case LogLevel.fatal:\n        return \"CRITICAL\";\n      case LogLevel.error:\n        return \"ERROR\";\n      case LogLevel.warn:\n        return \"WARNING\";\n      case LogLevel.info:\n        return \"INFO\";\n      case LogLevel.debug:\n        return \"DEBUG\";\n      case LogLevel.trace:\n        return \"DEBUG\";\n      default:\n        return \"DEFAULT\";\n    }\n  }\n\n  shipToLogger({ data, hasData, logLevel, messages }: LogLayerTransportParams): any[] {\n    const entry = this.logger.entry(\n      {\n        ...this.rootLevelData,\n        severity: this.mapLogLevel(logLevel),\n        timestamp: new Date(),\n      },\n      {\n        ...(data && hasData ? data : {}),\n        message: messages.join(\" \"),\n      },\n    );\n\n    this.logger.write(entry);\n\n    if (data && hasData) {\n      return [data, messages];\n    }\n\n    return [messages];\n  }\n}\n"]}

package/dist/index.d.cts

@@ -0,0 +1,20 @@
+import { Log } from '@google-cloud/logging';
+import { LogEntry } from '@google-cloud/logging/build/src/entry.js';
+import { LogLayerTransportConfig, BaseTransport, LogLayerTransportParams } from '@loglayer/transport';
+
+interface GoogleCloudLoggingTransportConfig extends LogLayerTransportConfig<Log> {
+    /**
+     * The root level data to include for all log entries.
+     * "severity", "timestamp" and "jsonPayload" are already populated by the transport.
+     * @see https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry
+     */
+    rootLevelData?: Omit<LogEntry, "severity" | "timestamp" | "jsonPayload">;
+}
+declare class GoogleCloudLoggingTransport extends BaseTransport<Log> {
+    private rootLevelData;
+    constructor(config: GoogleCloudLoggingTransportConfig);
+    private mapLogLevel;
+    shipToLogger({ data, hasData, logLevel, messages }: LogLayerTransportParams): any[];
+}
+
+export { GoogleCloudLoggingTransport, type GoogleCloudLoggingTransportConfig };

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+import { Log } from '@google-cloud/logging';
+import { LogEntry } from '@google-cloud/logging/build/src/entry.js';
+import { LogLayerTransportConfig, BaseTransport, LogLayerTransportParams } from '@loglayer/transport';
+
+interface GoogleCloudLoggingTransportConfig extends LogLayerTransportConfig<Log> {
+    /**
+     * The root level data to include for all log entries.
+     * "severity", "timestamp" and "jsonPayload" are already populated by the transport.
+     * @see https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry
+     */
+    rootLevelData?: Omit<LogEntry, "severity" | "timestamp" | "jsonPayload">;
+}
+declare class GoogleCloudLoggingTransport extends BaseTransport<Log> {
+    private rootLevelData;
+    constructor(config: GoogleCloudLoggingTransportConfig);
+    private mapLogLevel;
+    shipToLogger({ data, hasData, logLevel, messages }: LogLayerTransportParams): any[];
+}
+
+export { GoogleCloudLoggingTransport, type GoogleCloudLoggingTransportConfig };

package/dist/index.js

@@ -0,0 +1,49 @@
+// src/GoogleCloudLoggingTransport.ts
+import { BaseTransport, LogLevel } from "@loglayer/transport";
+var GoogleCloudLoggingTransport = class extends BaseTransport {
+  rootLevelData;
+  constructor(config) {
+    super(config);
+    this.rootLevelData = config.rootLevelData || {};
+  }
+  mapLogLevel(level) {
+    switch (level) {
+      case LogLevel.fatal:
+        return "CRITICAL";
+      case LogLevel.error:
+        return "ERROR";
+      case LogLevel.warn:
+        return "WARNING";
+      case LogLevel.info:
+        return "INFO";
+      case LogLevel.debug:
+        return "DEBUG";
+      case LogLevel.trace:
+        return "DEBUG";
+      default:
+        return "DEFAULT";
+    }
+  }
+  shipToLogger({ data, hasData, logLevel, messages }) {
+    const entry = this.logger.entry(
+      {
+        ...this.rootLevelData,
+        severity: this.mapLogLevel(logLevel),
+        timestamp: /* @__PURE__ */ new Date()
+      },
+      {
+        ...data && hasData ? data : {},
+        message: messages.join(" ")
+      }
+    );
+    this.logger.write(entry);
+    if (data && hasData) {
+      return [data, messages];
+    }
+    return [messages];
+  }
+};
+export {
+  GoogleCloudLoggingTransport
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/GoogleCloudLoggingTransport.ts"],"sourcesContent":["import type { Log } from \"@google-cloud/logging\";\nimport type { LogEntry } from \"@google-cloud/logging/build/src/entry.js\";\nimport { BaseTransport, LogLevel } from \"@loglayer/transport\";\nimport type { LogLayerTransportConfig, LogLayerTransportParams } from \"@loglayer/transport\";\n\nexport interface GoogleCloudLoggingTransportConfig extends LogLayerTransportConfig<Log> {\n  /**\n   * The root level data to include for all log entries.\n   * \"severity\", \"timestamp\" and \"jsonPayload\" are already populated by the transport.\n   * @see https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry\n   */\n  rootLevelData?: Omit<LogEntry, \"severity\" | \"timestamp\" | \"jsonPayload\">;\n}\n\nexport class GoogleCloudLoggingTransport extends BaseTransport<Log> {\n  private rootLevelData: Omit<LogEntry, \"severity\" | \"timestamp\" | \"jsonPayload\">;\n\n  constructor(config: GoogleCloudLoggingTransportConfig) {\n    super(config);\n    this.rootLevelData = config.rootLevelData || {};\n  }\n\n  private mapLogLevel(level: LogLevel): string {\n    switch (level) {\n      case LogLevel.fatal:\n        return \"CRITICAL\";\n      case LogLevel.error:\n        return \"ERROR\";\n      case LogLevel.warn:\n        return \"WARNING\";\n      case LogLevel.info:\n        return \"INFO\";\n      case LogLevel.debug:\n        return \"DEBUG\";\n      case LogLevel.trace:\n        return \"DEBUG\";\n      default:\n        return \"DEFAULT\";\n    }\n  }\n\n  shipToLogger({ data, hasData, logLevel, messages }: LogLayerTransportParams): any[] {\n    const entry = this.logger.entry(\n      {\n        ...this.rootLevelData,\n        severity: this.mapLogLevel(logLevel),\n        timestamp: new Date(),\n      },\n      {\n        ...(data && hasData ? data : {}),\n        message: messages.join(\" \"),\n      },\n    );\n\n    this.logger.write(entry);\n\n    if (data && hasData) {\n      return [data, messages];\n    }\n\n    return [messages];\n  }\n}\n"],"mappings":";AAEA,SAAS,eAAe,gBAAgB;AAYjC,IAAM,8BAAN,cAA0C,cAAmB;AAAA,EAC1D;AAAA,EAER,YAAY,QAA2C;AACrD,UAAM,MAAM;AACZ,SAAK,gBAAgB,OAAO,iBAAiB,CAAC;AAAA,EAChD;AAAA,EAEQ,YAAY,OAAyB;AAC3C,YAAQ,OAAO;AAAA,MACb,KAAK,SAAS;AACZ,eAAO;AAAA,MACT,KAAK,SAAS;AACZ,eAAO;AAAA,MACT,KAAK,SAAS;AACZ,eAAO;AAAA,MACT,KAAK,SAAS;AACZ,eAAO;AAAA,MACT,KAAK,SAAS;AACZ,eAAO;AAAA,MACT,KAAK,SAAS;AACZ,eAAO;AAAA,MACT;AACE,eAAO;AAAA,IACX;AAAA,EACF;AAAA,EAEA,aAAa,EAAE,MAAM,SAAS,UAAU,SAAS,GAAmC;AAClF,UAAM,QAAQ,KAAK,OAAO;AAAA,MACxB;AAAA,QACE,GAAG,KAAK;AAAA,QACR,UAAU,KAAK,YAAY,QAAQ;AAAA,QACnC,WAAW,oBAAI,KAAK;AAAA,MACtB;AAAA,MACA;AAAA,QACE,GAAI,QAAQ,UAAU,OAAO,CAAC;AAAA,QAC9B,SAAS,SAAS,KAAK,GAAG;AAAA,MAC5B;AAAA,IACF;AAEA,SAAK,OAAO,MAAM,KAAK;AAEvB,QAAI,QAAQ,SAAS;AACnB,aAAO,CAAC,MAAM,QAAQ;AAAA,IACxB;AAEA,WAAO,CAAC,QAAQ;AAAA,EAClB;AACF;","names":[]}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@loglayer/transport-google-cloud-logging",
+  "description": "Google Cloud Logging (Stackdriver) transport for loglayer.",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "exports": {
+    "import": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "require": {
+      "types": "./dist/index.d.cts",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "license": "MIT",
+  "repository": "loglayer/loglayer.git",
+  "author": "Theo Gravity <theo@suteki.nu>",
+  "keywords": [
+    "logging",
+    "log",
+    "loglayer",
+    "stackdriver",
+    "google",
+    "cloud",
+    "transport"
+  ],
+  "dependencies": {
+    "@loglayer/transport": "1.1.4"
+  },
+  "devDependencies": {
+    "hash-runner": "2.0.1",
+    "@types/node": "22.10.4",
+    "serialize-error": "11.0.3",
+    "tsup": "8.3.5",
+    "typescript": "5.7.2",
+    "vitest": "2.1.8",
+    "tsx": "4.19.2",
+    "loglayer": "5.0.12",
+    "@internal/tsconfig": "1.0.0"
+  },
+  "peerDependencies": {
+    "@google-cloud/logging": "*"
+  },
+  "bugs": "https://github.com/loglayer/loglayer/issues",
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "dist"
+  ],
+  "homepage": "https://loglayer.dev",
+  "scripts": {
+    "build": "tsup src/index.ts",
+    "test": "vitest --run",
+    "build:dev": "hash-runner",
+    "clean": "rm -rf .turbo node_modules dist",
+    "lint": "biome check --write --unsafe src && biome format src --write && biome lint src --fix",
+    "verify-types": "tsc --noEmit",
+    "livetest": "tsx src/__tests__/livetest.ts"
+  }
+}