feat(logflare): adding optional logflare integration (#183)

Author: fenos

.env.sample

@@ -18,3 +18,7 @@ X_FORWARDED_HOST_REGEXP=
 POSTGREST_URL_SUFFIX=/rest/v1
 ADMIN_API_KEYS=apikey
 ENCRYPTION_KEY=encryptionkey
+
+LOGFLARE_ENABLED=false
+LOGFLARE_API_KEY=api_key
+LOGFLARE_SOURCE_TOKEN=source_token

.gitignore

@@ -7,3 +7,4 @@ dist/
 static/api.json
 data/
 bin/
+.idea/

package-lock.json

@@ -42,6 +42,7 @@
     "pg": "^8.7.3",
     "pg-listen": "^1.7.0",
     "pino": "^8.2.0",
+    "pino-logflare": "^0.3.12",
     "postgres-migrations": "^5.3.0",
     "prom-client": "^14.0.1"
   },

package.json

@@ -0,0 +1 @@
+export * from './logger'

src/monitoring/index.ts

@@ -0,0 +1,24 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+
+const dotenv = require('dotenv')
+const { createWriteStream: createLogFlareWriteStream } = require('pino-logflare')
+
+export default function () {
+  dotenv.config()
+
+  const logflareApiKey = process.env.LOGFLARE_API_KEY
+  const logflareSourceToken = process.env.LOGFLARE_SOURCE_TOKEN
+
+  if (!logflareApiKey) {
+    throw new Error('must provide a logflare api key')
+  }
+
+  if (!logflareSourceToken) {
+    throw new Error('must provider a logflare source token')
+  }
+
+  return createLogFlareWriteStream({
+    apiKey: logflareApiKey,
+    sourceToken: logflareSourceToken,
+  })
+}

src/monitoring/logflare.ts

@@ -0,0 +1,32 @@
+import pino from 'pino'
+import { getConfig } from '../utils/config'
+
+export const logger = pino({
+  transport: buildTransport(),
+  formatters: {
+    level(label) {
+      return { level: label }
+    },
+  },
+  timestamp: pino.stdTimeFunctions.isoTime,
+})
+
+export function buildTransport(): pino.TransportSingleOptions | undefined {
+  const { logflareApiKey, logflareSourceToken, logflareEnabled } = getConfig()
+
+  if (!logflareEnabled) {
+    return undefined
+  }
+
+  if (!logflareApiKey) {
+    throw new Error('must provide a logflare api key')
+  }
+
+  if (!logflareSourceToken) {
+    throw new Error('must provider a logflare source token')
+  }
+
+  return {
+    target: './logflare',
+  }
+}

src/monitoring/logger.ts

@@ -1,21 +1,12 @@
 import { FastifyInstance } from 'fastify'
 import { IncomingMessage, Server, ServerResponse } from 'http'
-import pino from 'pino'
 
 import build from './app'
 import buildAdmin from './admin-app'
 import { getConfig } from './utils/config'
 import { runMultitenantMigrations, runMigrations } from './utils/migrate'
 import { listenForTenantUpdate } from './utils/tenant'
-
-const logger = pino({
-  formatters: {
-    level(label) {
-      return { level: label }
-    },
-  },
-  timestamp: pino.stdTimeFunctions.isoTime,
-})
+import { logger } from './monitoring'
 
 const exposeDocs = true
 

src/server.ts

@@ -22,6 +22,9 @@ type StorageConfigType = {
   tenantId: string
   urlLengthLimit: number
   xForwardedHostRegExp?: string
+  logflareEnabled?: boolean
+  logflareApiKey?: string
+  logflareSourceToken?: string
 }
 
 function getOptionalConfigFromEnv(key: string): string | undefined {
@@ -69,5 +72,8 @@ export function getConfig(): StorageConfigType {
       '',
     urlLengthLimit: Number(getOptionalConfigFromEnv('URL_LENGTH_LIMIT')) || 7_500,
     xForwardedHostRegExp: getOptionalConfigFromEnv('X_FORWARDED_HOST_REGEXP'),
+    logflareEnabled: getOptionalConfigFromEnv('LOGFLARE_ENABLED') === 'true',
+    logflareApiKey: getOptionalConfigFromEnv('LOGFLARE_API_KEY'),
+    logflareSourceToken: getOptionalConfigFromEnv('LOGFLARE_SOURCE_TOKEN'),
   }
 }