add betterstack logging support to log configuration

Author: jorgtho

src/index.d.ts

@@ -18,6 +18,13 @@ interface LogConfigOptions {
     token?: string
     level?: Levels
   }
+  betterstack?: {
+    disabled?: boolean
+    onlyInProd?: boolean
+    host?: string
+    token?: string
+    level?: Levels
+  }
   teams?: {
     disabled?: boolean
     onlyInProd?: boolean

src/lib/log-config-factory.js

@@ -12,6 +12,12 @@ function _logConfigFactory (options = {}, { axios, deepmerge, loggerOptions, env
       url: envVariables.TEAMS_WEBHOOK_URL
     }
   }
+  if ((!options || !options.betterstack) && envVariables.BETTERSTACK_URL && envVariables.BETTERSTACK_TOKEN) {
+    options.betterstack = {
+      url: envVariables.BETTERSTACK_URL,
+      token: envVariables.BETTERSTACK_TOKEN
+    }
+  }
   if (options && typeof options === 'object') {
     // remote logging
     if (options.remote && typeof options.remote === 'object') {
@@ -36,6 +42,41 @@ function _logConfigFactory (options = {}, { axios, deepmerge, loggerOptions, env
         loggerOptions.remoteLevel = options.remote.level
       }
     }
+
+    // Betterstack logging
+    if (options.betterstack && typeof options.betterstack === 'object') {
+      options.betterstack.url = options.betterstack.url || envVariables.BETTERSTACK_URL
+      options.betterstack.token = options.betterstack.token || envVariables.BETTERSTACK_TOKEN
+
+      loggerOptions.betterstackLogger = {
+        log: async msg => {
+          console.log('vi skal logge til betterstack')
+          console.log(options.betterstack.url)
+          const betterstackUrl = new URL(options.betterstack.url)
+          if (!betterstackUrl.hostname.endsWith('betterstackdata.com')) {
+            throw new Error('Invalid Betterstack URL, must end with betterstackdata.com')
+          }
+          if (!betterstackUrl.protocol === 'https:') {
+            throw new Error('Invalid Betterstack URL, must use HTTPS')
+          }
+          await axios.post(options.betterstack.url, msg, { headers: { Authorization: `Bearer ${options.betterstack.token}` } })
+        }
+      }
+
+      // onlyInProd defaults to true
+      loggerOptions.onlyInProd = options.betterstack.onlyInProd === undefined ? true : options.betterstack.onlyInProd
+      options.betterstack.onlyInProd = loggerOptions.onlyInProd
+
+      // enables betterstack logging if everything checks out, otherwise betterstack logging will be disabled
+      loggerOptions.logToBetterstack = !options.betterstack.disabled &&
+        typeof options.betterstack.url === 'string' &&
+        typeof options.betterstack.token === 'string'
+
+      // set betterstack level (lowest level for betterstack logging)
+      if (options.betterstack.level) {
+        loggerOptions.betterstackLevel = options.betterstack.level
+      }
+    }
     // Teams logging
     if (options.teams && typeof options.teams === 'object') {
       options.teams.url = options.teams.url || envVariables.TEAMS_WEBHOOK_URL

src/lib/logger-factory.js

@@ -34,6 +34,8 @@ async function _loggerFactory (level, message, { formatDateTime, logLevelMapper,
   const messageFormats = formatLogMessage(formatDateTime, pkg, logLevel, messageArray, context)
   const remoteLevel = (loggerOptions.remoteLevel && logLevelMapper(loggerOptions.remoteLevel)) || undefined
   const remoteLevelLogToRemote = remoteLevel ? logLevel.severity <= remoteLevel.severity : true
+  const betterstackLevel = (loggerOptions.betterstackLevel && logLevelMapper(loggerOptions.betterstackLevel)) || undefined
+  const betterstackLevelLogToBetterstack = betterstackLevel ? logLevel.severity <= betterstackLevel.severity : true
   const teamsLevel = (loggerOptions.teamsLevel && logLevelMapper(loggerOptions.teamsLevel)) || undefined
   const remoteLevelLogToTeams = teamsLevel ? logLevel.severity <= teamsLevel.severity : true
 
@@ -50,6 +52,16 @@ async function _loggerFactory (level, message, { formatDateTime, logLevelMapper,
     localLog(loggerOptions, warnLevel, errorMessage)
   }
 
+  // Betterstack logging
+  const shouldLogToBetterstack = (loggerOptions.logToBetterstack && !(!inProduction && loggerOptions.onlyInProd) && betterstackLevelLogToBetterstack) || false
+  try {
+    if (shouldLogToBetterstack) await loggerOptions.betterstackLogger.log(messageFormats.betterstackLogMessage)
+  } catch (error) {
+    const warnLevel = logLevelMapper('warn')
+    const errorMessage = formatLogMessage(formatDateTime, pkg, warnLevel, ['logger-factory', 'logToBetterstack', 'error', error.message])
+    localLog(loggerOptions, warnLevel, errorMessage)
+  }
+
   // Teams logging
   const shouldLogToTeams = (loggerOptions.logToTeams && !(!inProduction && loggerOptions.onlyTeamsInProd) && remoteLevelLogToTeams) || false
   try {
@@ -89,6 +101,7 @@ function formatLogMessage (formatDateTime, pkg, logLevel, messageArray, context)
   return {
     logMessage,
     remoteLogMessage: `${logLevel.level} - ${logMessage}`,
+    betterstackLogMessage: `${logLevel.level} - ${logMessage}`,
     localLogMessage: `[ ${fDate} ${fTime} ] < ${logLevel.level} >${logLevel.padding} ${logMessage}`,
     teamsMessageCard: formatMessageCard(logLevel, `${logLevel.level} - ${funcDetails}`, messageArray),
     teamsAdaptiveCard: formatAdaptiveCard(logLevel, `${logLevel.level} - ${funcDetails}`, messageArray)