feat: add CLI support (#7)

Author: metcoder95

cli.js

@@ -0,0 +1,103 @@
+#!/usr/bin/env node
+'use strict'
+const { pipeline } = require('node:stream')
+const { readFileSync } = require('node:fs')
+const { join } = require('node:path')
+
+const minimist = require('minimist')
+const CloudPine = require('./index')
+
+function parseOptions (argv) {
+  const opts = {
+    logName: argv.name,
+    cloudLoggingOptions: {
+      sync: argv.sync,
+      skipInit: argv['skip-init'],
+      googleCloudOptions: {
+        projectId: argv.projectId,
+        keyFilename: argv.key
+      },
+      resource: {
+        type: argv.resource,
+        labels: {}
+      },
+      defaultLabels: {}
+    }
+  }
+
+  if (argv['resource-labels'] != null) {
+    const plainLabels = Array.isArray(argv['resource-labels'])
+      ? argv['resource-labels']
+      : [argv['resource-labels']]
+
+    for (const label of plainLabels) {
+      const [key, value] = label.split('=')
+      opts.cloudLoggingOptions.resource.labels[key] = value
+    }
+  }
+
+  if (argv.labels != null) {
+    const plainLabels = Array.isArray(argv.labels) ? argv.labels : [argv.labels]
+
+    for (const label of plainLabels) {
+      const [key, value] = label.split('=')
+      opts.cloudLoggingOptions.defaultLabels[key] = value
+    }
+  }
+
+  return opts
+}
+
+async function handler (fgs) {
+  let rs, rj
+  const promise = new Promise(
+    // eslint-ignore-next-line no-return-assign
+    (resolve, reject) => {
+      rs = resolve
+      rj = reject
+    }
+  )
+
+  if (fgs.version) {
+    const { version } = JSON.parse(
+      readFileSync(join(__dirname, 'package.json'), 'utf-8')
+    )
+    console.log(`cloud-pine@v${version}`)
+
+    rs()
+  } else if (fgs.help) {
+    console.log(readFileSync(join(__dirname, 'help.txt'), 'utf-8'))
+
+    rs()
+  } else {
+    const options = parseOptions(fgs)
+
+    pipeline(process.stdin, await CloudPine(options), err => {
+      if (err) rj(err)
+    })
+  }
+
+  return promise
+}
+
+const flags = minimist(process.argv.slice(2), {
+  alias: {
+    name: 'n',
+    version: 'v',
+    help: 'h',
+    sync: 's',
+    projectId: 'p',
+    key: 'k',
+    labels: 'l',
+    resource: 'r',
+    'resource-labels': 'rs',
+    'skip-init': 'i'
+  },
+  boolean: ['skip-init', 'sync'],
+  default: {
+    sync: true,
+    'skip-init': false
+  }
+})
+
+handler(flags).then(null, console.error)

help.txt

@@ -0,0 +1,21 @@
+  Cloud Pine
+
+  Forward pino logs to  Google Cloud Logging:
+
+     cat log | cloud-pine --projectid someprojectid -l something=else -l service=http
+
+  Flags
+  -h  | --help              Display Help
+  -v  | --version           Display Version
+  -n  | --name              Log Name. Default to Cloud_Pine
+  -s  | --sync              Cloud Logging Mode. Sync will print to stdout meanwhile async will
+                            forward logs to Cloud Logging
+  -p  | --projectid         Google Cloud Project ID. Default to automatic detected resource or
+                            GOOGLE_APPLICATION_CREDENTIALS
+  -k  | --key               Path to key file
+  -l  | --labels            Custom labels to be attached to the logging labels. Should be in the format label=value.
+                            Can be used one or more times.
+  -r  | --resource          Monitoring Resource type. Default to global or Monitored Resource detected.
+  -rs  | --resource-labels   Monitoring Resource#Labels that will be attached to the resource by default. Follows same pattern as --labels.
+  -i  | --skip-init         Skips identification of monitored resource, which will infer things like project-ide. and Monitored Resource
+                            settings. Default to false.

lib/cloud-logging.js

@@ -11,6 +11,7 @@ class CloudLogging {
       options.defaultLabels
     )
     this._log = null
+    this._skipInit = options.skipInit ?? false
     // Indicates whether the logs will be forward to stdout or
     // through networking to GCP
     this._sync = options.sync ?? false
@@ -32,8 +33,10 @@ class CloudLogging {
   }
 
   async init () {
-    await this.logging.setProjectId()
-    await this.logging.setDetectedResource()
+    if (this._skipInit === false) {
+      await this.logging.setProjectId()
+      await this.logging.setDetectedResource()
+    }
 
     const labels = Object.assign(
       {},

package.json

@@ -49,6 +49,7 @@
   },
   "dependencies": {
     "@google-cloud/logging": "^10.1.1",
+    "minimist": "^1.2.6",
     "split2": "^4.1.0"
   },
   "tsd": {

test/unit/cloud_logging.test.js

@@ -52,7 +52,7 @@ tap.test('CloudLogging#sync', root => {
   })
 
   root.test('#init', nested => {
-    nested.plan(2)
+    nested.plan(3)
 
     nested.test(
       'Should initialize the log instance with resources',
@@ -173,6 +173,68 @@ tap.test('CloudLogging#sync', root => {
         t.same(instance.resource, expectedDetectedResource)
       }
     )
+
+    nested.test(
+      'Should be skip if skipInit flag is set',
+      async t => {
+        const logName = 'test'
+        const projectId = 'test-project'
+        const detectedResource = {
+          labels: {
+            projectId,
+            instanceId: '12345678901234',
+            zone: 'us-central1-a'
+          }
+        }
+        const defaultOptions = {
+          googleCloudOptions: {
+            projectId,
+            keyFilename: '/path/to/keyfile.json'
+          },
+          sync: true,
+          skipInit: true
+        }
+
+        class LoggingMock extends BaseLoggingMock {
+          constructor (options) {
+            t.same(options, defaultOptions.googleCloudOptions)
+            super()
+          }
+
+          setProjectId () {
+            t.fail('setProjectId should not be called')
+            return Promise.resolve()
+          }
+
+          setDetectedResource () {
+            t.fail('setDetectedResource should not be called')
+            this.detectedResource = detectedResource
+            return Promise.resolve()
+          }
+
+          logSync (name) {
+            t.equal(name, logName)
+            return new BaseLogMock(name)
+          }
+        }
+
+        const expectedDetectedResource = Object.assign(
+          { type: 'global' },
+          detectedResource
+        )
+        const { CloudLogging } = t.mock('../../lib/cloud-logging', {
+          '@google-cloud/logging': { Logging: LoggingMock }
+        })
+
+        t.plan(4)
+
+        const instance = new CloudLogging(logName, defaultOptions)
+
+        await instance.init()
+        t.ok(instance.sync)
+        t.notSame(instance.resource, expectedDetectedResource)
+      }
+    )
   })
 
   root.test('#parseLine', nested => {
@@ -676,7 +738,7 @@ tap.test('CloudLogging#async', root => {
   })
 
   root.test('#init', nested => {
-    nested.plan(2)
+    nested.plan(3)
 
     nested.test(
       'Should initialize the log instance with resources',
@@ -793,6 +855,67 @@ tap.test('CloudLogging#async', root => {
         t.same(instance.resource, expectedDetectedResource)
       }
     )
+
+    nested.test(
+      'Should be skip if skipInit flag is set',
+      async t => {
+        const logName = 'test'
+        const projectId = 'test-project'
+        const detectedResource = {
+          labels: {
+            projectId,
+            instanceId: '12345678901234',
+            zone: 'us-central1-a'
+          }
+        }
+        const defaultOptions = {
+          googleCloudOptions: {
+            projectId,
+            keyFilename: '/path/to/keyfile.json'
+          },
+          skipInit: true
+        }
+
+        class LoggingMock extends BaseLoggingMock {
+          constructor (options) {
+            t.same(options, defaultOptions.googleCloudOptions)
+            super()
+          }
+
+          setProjectId () {
+            t.fail('setProjectId should not be called')
+            return Promise.resolve()
+          }
+
+          setDetectedResource () {
+            t.fail('setDetectedResource should not be called')
+            this.detectedResource = detectedResource
+            return Promise.resolve()
+          }
+
+          log (name) {
+            t.equal(name, logName)
+            return new BaseLogMock(name)
+          }
+        }
+
+        const expectedDetectedResource = Object.assign(
+          { type: 'global' },
+          detectedResource
+        )
+        const { CloudLogging } = t.mock('../../lib/cloud-logging', {
+          '@google-cloud/logging': { Logging: LoggingMock }
+        })
+
+        t.plan(4)
+
+        const instance = new CloudLogging(logName, defaultOptions)
+
+        await instance.init()
+        t.notOk(instance.sync)
+        t.notSame(instance.resource, expectedDetectedResource)
+      }
+    )
   })
 
   root.test('#parseLine', nested => {