feat(logger) send logs to aws

spot-electron/main.js

@@ -17,6 +17,7 @@ if (isDev || process.argv.indexOf('--show-devtools') !== -1) {
 }
 
 const { createApplicationWindow } = require('./src/application-window');
+const { awsLogger } = require('./src/logger');
 
 // Imports from features that we need to load.
 // Import log transport early as it caches any logs produced even before able to send.
@@ -28,6 +29,12 @@ require('./src/client-control');
 require('./src/exit');
 require('./src/volume-control');
 
+process.env.USE_CLOUDWATCH_LOGS && awsLogger.maybeCreateLogStream()
+    .catch(error => {
+        console.error('Error - couldn\'t identify Cloudwatch log stream', error);
+        process.env.USE_CLOUDWATCH_LOGS = false;
+    });
+
 app.on('ready', createApplicationWindow);
 
 app.on(

spot-electron/package.json

@@ -45,10 +45,12 @@
         "node-schedule": "2.1.1"
     },
     "devDependencies": {
+        "@aws-sdk/client-cloudwatch-logs": "3.395.0",
+        "@aws-sdk/client-firehose": "3.395.0",
         "@babel/eslint-parser": "7.19.1",
         "@babel/preset-env": "7.20.2",
-        "@types/jest": "29.2.6",
         "@jitsi/eslint-config": "4.1.5",
+        "@types/jest": "29.2.6",
         "dotenv": "16.0.3",
         "electron": "22.3.18",
         "electron-builder": "23.6.0",
@@ -82,4 +84,4 @@
         "@jitsi/node-ibeacons": "0.2.0",
         "win-audio": "2.0.2"
     }
-}
+}

spot-electron/src/application-window/applicationwindow.js

@@ -3,7 +3,7 @@ const isDev = require('electron-is-dev');
 const process = require('process');
 
 const { defaultSpotURL } = require('../../config');
-const { logger, fileLogger } = require('../logger');
+const { logger, fileLogger, awsLogger } = require('../logger');
 const { OnlineDetector } = require('../online-detector');
 
 /**
@@ -95,6 +95,8 @@ function createApplicationWindow() {
 
     applicationWindow.webContents.on('console-message', (_, level, message) => {
         fileLogger.logToFile(level, message);
+        process.env.USE_S3_LOGS && awsLogger.logToS3(level, message);
+        process.env.USE_CLOUDWATCH_LOGS && awsLogger.logToCloudwatch(level, message);
     });
 
     onlineDetector.start();

spot-electron/src/logger/awsLogger.js

@@ -0,0 +1,139 @@
+const {
+    CloudWatchLogsClient,
+    DescribeLogStreamsCommand,
+    PutLogEventsCommand,
+    CreateLogStreamCommand
+} = require('@aws-sdk/client-cloudwatch-logs');
+const {
+    FirehoseClient,
+    PutRecordCommand
+} = require('@aws-sdk/client-firehose');
+
+const { getHostId, parseLogMessage } = require('./utils');
+
+const region = process.env.REGION;
+const credentials = {
+    accessKeyId: process.env.AWS_ACCESS_KEY_ID,
+    secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY
+};
+const deliveryStreamName = process.env.FIREHOSE_DELIVERY_STREAM;
+const logGroupName = process.env.CLOUDWATCH_LOG_GROUP;
+const logStreamName = getHostId();
+
+const firehoseClient = new FirehoseClient({
+    credentials,
+    region
+});
+
+const cloudwatchClient = new CloudWatchLogsClient({
+    credentials,
+    region
+});
+
+/**
+ * Creates a Cloudwatch log stream.
+ */
+const createLogStream = async () => {
+    const command = new CreateLogStreamCommand({
+        logGroupName,
+        logStreamName
+    });
+
+    try {
+        await cloudwatchClient.send(command);
+        console.log(`Successfully created log stream ${logStreamName}.`);
+    } catch (error) {
+        console.error('Error - couldn\'t create log stream:', error, error.stack);
+    }
+};
+
+/**
+ * Adds logs to a Cloudwatch log stream.
+ */
+const putLogEvents = async message => {
+    const command = new PutLogEventsCommand({
+        logEvents: [ {
+            message,
+            timestamp: Date.now()
+        } ],
+        logGroupName,
+        logStreamName
+    });
+
+    try {
+        await cloudwatchClient.send(command);
+    } catch (error) {
+        console.error('Error - couldn\'t save log events:', error, error.stack);
+    }
+};
+
+/**
+ * Creates a Cloudwatch log stream if it doesn't exist.
+ */
+const maybeCreateLogStream = async () => {
+    const command = new DescribeLogStreamsCommand({
+        logGroupName,
+        logStreamNamePrefix: logStreamName
+    });
+
+    try {
+        const response = await cloudwatchClient.send(command);
+
+        // This call can return an empty response without throwing an exception.
+        // Additionally, the results may not match 100%,
+        // So we need to make sure the log stream gets created.
+        const isLogStreamPresent = response.logStreams.find(stream => stream.logStreamName === logStreamName);
+
+        if (!response.logStreams.length || !isLogStreamPresent) {
+            createLogStream();
+        }
+    } catch (error) {
+        if (error.__type === 'ResourceNotFoundException') {
+            console.error('Error - log stream does not exist', error, error.stack);
+
+            createLogStream();
+        } else {
+            console.error('Error - couldn\'t describe log streams:', error, error.stack);
+        }
+    }
+};
+
+/**
+ * Logs a message to Cloudwatch.
+ *
+ * @param {string} level - The log level index.
+ * @param {string} message - The main string to be logged.
+ * @returns {void}
+ */
+const logToCloudwatch = async (level, message) => {
+    putLogEvents(parseLogMessage(level, message));
+};
+
+/**
+ * Logs a message to S3 via Firehose.
+ *
+ * @param {string} level - The log level index.
+ * @param {string} message - The main string to be logged.
+ * @returns {void}
+ */
+const logToS3 = async (level, message) => {
+    const command = new PutRecordCommand({
+        DeliveryStreamName: deliveryStreamName,
+        Record: {
+            Data: Buffer.from(`
+${logStreamName} | ${new Date().toISOString()} | ${parseLogMessage(level, message)}`)
+        }
+    });
+
+    try {
+        await firehoseClient.send(command);
+    } catch (error) {
+        console.error('Error - couldn\'t put record:', error, error.stack);
+    }
+};
+
+module.exports = {
+    maybeCreateLogStream,
+    logToS3,
+    logToCloudwatch
+};

spot-electron/src/logger/index.js

@@ -1,4 +1,5 @@
 module.exports = {
     logger: require('./logger'),
-    fileLogger: require('./fileLogger')
+    fileLogger: require('./fileLogger'),
+    awsLogger: require('./awsLogger')
 };

spot-electron/src/logger/utils.js

@@ -0,0 +1,30 @@
+const os = require('os');
+
+/**
+ * Log levels map.
+ */
+const LOG_LEVEL = {
+    0: 'TRACE',
+    1: 'DEBUG',
+    2: 'INFO',
+    3: 'LOG',
+    4: 'WARN',
+    5: 'ERROR'
+};
+
+module.exports = {
+    /**
+     * Builds the log message.
+    */
+    parseLogMessage: (level, message) => `[${LOG_LEVEL[level]}] ${message}`,
+
+    /**
+     * Returns the host identifier.
+     */
+    getHostId: () => {
+        const ipAddress = [].concat(...Object.values(os.networkInterfaces()))
+            .find(networkInterface => !networkInterface.internal && networkInterface.family === 'IPv4')?.address;
+
+        return `${ipAddress}-${os.hostname()}`;
+    }
+};