@oneuptime/common 10.0.53 → 10.0.55

package/Server/Types/Domain.ts

@@ -1,4 +1,4 @@
-import logger from "../Utils/Logger";
+import logger, { LogAttributes } from "../Utils/Logger";
 import DomainCommon from "../../Types/Domain";
 import { PromiseRejectErrorFunction } from "../../Types/FunctionTypes";
 import dns from "dns";
@@ -13,9 +13,14 @@ export default class Domain extends DomainCommon {
         dns.resolveCname(
           data.domain,
           (err: Error | null, addresses: string[]) => {
+            const domainLogAttributes: LogAttributes = {
+              domain: data.domain,
+            };
+
             if (err) {
               logger.debug(
                 `DNS CNAME lookup failed for domain ${data.domain}: ${err.message}`,
+                domainLogAttributes,
               );
 
               // Handle specific DNS error types with user-friendly messages
@@ -89,9 +94,14 @@ export default class Domain extends DomainCommon {
         dns.resolveTxt(
           domain.toString(),
           (err: Error | null, data: Array<Array<string>>) => {
+            const domainLogAttributes: LogAttributes = {
+              domain: domain.toString(),
+            };
+
             if (err) {
               logger.debug(
                 `DNS TXT lookup failed for domain ${domain.toString()}: ${err.message}`,
+                domainLogAttributes,
               );
 
               // Handle specific DNS error types with user-friendly messages
@@ -136,10 +146,10 @@ export default class Domain extends DomainCommon {
               );
             }
 
-            logger.debug("Verify TXT Record");
-            logger.debug("Domain " + domain.toString());
-            logger.debug("Data: ");
-            logger.debug(data);
+            logger.debug("Verify TXT Record", domainLogAttributes);
+            logger.debug("Domain " + domain.toString(), domainLogAttributes);
+            logger.debug("Data: ", domainLogAttributes);
+            logger.debug(data, domainLogAttributes);
 
             let isVerified: boolean = false;
             for (const item of data) {

package/Server/Types/Workflow/Components/API/Post.ts

@@ -12,7 +12,7 @@ import ComponentMetadata, {
 import ComponentID from "../../../../../Types/Workflow/ComponentID";
 import APIComponents from "../../../../../Types/Workflow/Components/API";
 import API from "../../../../../Utils/API";
-import logger from "../../../../Utils/Logger";
+import logger, { LogAttributes } from "../../../../Utils/Logger";
 import CaptureSpan from "../../../../Utils/Telemetry/CaptureSpan";
 
 export default class ApiPost extends ComponentCode {
@@ -42,24 +42,35 @@ export default class ApiPost extends ComponentCode {
 
     let apiResult: HTTPResponse<JSONObject> | HTTPErrorResponse | null = null;
 
-    logger.debug("API Post Component is running.");
+    const workflowLogAttributes: LogAttributes = {
+      projectId: options.projectId.toString(),
+      workflowId: options.workflowId.toString(),
+    };
+
+    logger.debug("API Post Component is running.", workflowLogAttributes);
 
     const url: URL = args["url"] as URL;
     if (!url) {
       throw options.onError(new BadDataException("URL is required"));
     }
 
-    logger.debug(`URL: ${url}`);
+    logger.debug(`URL: ${url}`, workflowLogAttributes);
 
     const requestBody: JSONObject = args["request-body"] as JSONObject;
 
-    logger.debug(`Request Body: ${JSON.stringify(requestBody)}`);
+    logger.debug(
+      `Request Body: ${JSON.stringify(requestBody)}`,
+      workflowLogAttributes,
+    );
 
     const requestHeaders: Dictionary<string> = args[
       "request-headers"
     ] as Dictionary<string>;
 
-    logger.debug(`Request Headers: ${JSON.stringify(requestHeaders)}`);
+    logger.debug(
+      `Request Headers: ${JSON.stringify(requestHeaders)}`,
+      workflowLogAttributes,
+    );
 
     try {
       apiResult = await API.post({
@@ -68,7 +79,7 @@ export default class ApiPost extends ComponentCode {
         headers: args["request-headers"] as Dictionary<string>,
       });
 
-      logger.debug("API Post Component is done.");
+      logger.debug("API Post Component is done.", workflowLogAttributes);
 
       return Promise.resolve({
         returnValues: ApiComponentUtils.getReturnValues(apiResult),
@@ -89,8 +100,11 @@ export default class ApiPost extends ComponentCode {
         });
       }
 
-      logger.debug("API Post Component is done with error.");
-      logger.debug(err);
+      logger.debug(
+        "API Post Component is done with error.",
+        workflowLogAttributes,
+      );
+      logger.debug(err, workflowLogAttributes);
 
       return Promise.resolve({
         returnValues: {

package/Server/Types/Workflow/Components/BaseModel/OnTriggerBaseModel.ts

@@ -6,7 +6,7 @@ import {
   ExpressResponse,
   NextFunction,
 } from "../../../../Utils/Express";
-import logger from "../../../../Utils/Logger";
+import logger, { LogAttributes } from "../../../../Utils/Logger";
 import Response from "../../../../Utils/Response";
 import Select from "../../../Database/Select";
 import { RunOptions, RunReturnType } from "../../ComponentCode";
@@ -131,8 +131,13 @@ export default class OnTriggerBaseModel<
 
     let select: Select<TBaseModel> = args["select"] as Select<TBaseModel>;
 
-    logger.debug("Select: ");
-    logger.debug(select);
+    const runLogAttributes: LogAttributes = {
+      projectId: options.projectId.toString(),
+      workflowId: options.workflowId.toString(),
+    };
+
+    logger.debug("Select: ", runLogAttributes);
+    logger.debug(select, runLogAttributes);
 
     if (select && typeof select === "string") {
       select = JSONFunctions.parse(select) as Select<TBaseModel>;
@@ -236,7 +241,10 @@ export default class OnTriggerBaseModel<
               listenOn = JSON.parse(listenOn);
             }
           } catch (err) {
-            logger.error(err);
+            logger.error(err, {
+              projectId: req.params["projectId"],
+              workflowId: workflow.id?.toString(),
+            });
             continue;
           }
 

package/Server/Utils/AnalyticsDatabase/StatementGenerator.ts

@@ -856,6 +856,16 @@ export default class StatementGenerator<TBaseModel extends AnalyticsBaseModel> {
     return statement;
   }
 
+  public toDropSkipIndexStatement(indexName: string): string {
+    const databaseName: string = this.database.getDatasourceOptions().database!;
+    const statement: string = `ALTER TABLE ${databaseName}.${this.model.tableName} DROP INDEX IF EXISTS ${indexName}`;
+
+    logger.debug(`${this.model.tableName} Drop Skip Index Statement`);
+    logger.debug(statement);
+
+    return statement;
+  }
+
   public toDropColumnStatement(columnName: string): string {
     const statement: string = `ALTER TABLE ${this.database.getDatasourceOptions()
       .database!}.${this.model.tableName} DROP COLUMN IF EXISTS ${columnName}`;

package/Server/Utils/CodeRepository/CodeRepository.ts

@@ -2,7 +2,7 @@ import path from "path";
 import fs from "fs";
 import Execute from "../Execute";
 import LocalFile from "../LocalFile";
-import logger from "../Logger";
+import logger, { LogAttributes } from "../Logger";
 import CaptureSpan from "../Telemetry/CaptureSpan";
 import CodeRepositoryFile from "./CodeRepositoryFile";
 import Dictionary from "../../../Types/Dictionary";
@@ -91,11 +91,17 @@ export default class CodeRepositoryUtil {
       ]);
       await this.runGitCommand(data.repoPath, ["checkout", data.branchName]);
     } catch (error) {
+      const branchLogAttributes: LogAttributes = {
+        repoPath: data.repoPath,
+        branchName: data.branchName,
+      };
+
       logger.debug(
         `Branch ${data.branchName} not found. Creating a new branch instead.`,
+        branchLogAttributes,
       );
 
-      logger.debug(error);
+      logger.debug(error, branchLogAttributes);
 
       await this.runGitCommand(data.repoPath, [
         "checkout",
@@ -172,7 +178,10 @@ export default class CodeRepositoryUtil {
       `${data.repoPath}/${data.directoryPath}`,
     );
 
-    logger.debug("Deleting directory: " + totalPath);
+    logger.debug("Deleting directory: " + totalPath, {
+      repoPath: data.repoPath,
+      directoryPath: data.directoryPath,
+    });
 
     await LocalFile.deleteDirectory(totalPath);
   }
@@ -182,8 +191,14 @@ export default class CodeRepositoryUtil {
     repoPath: string;
     branchName: string;
   }): Promise<void> {
+    const createBranchLogAttributes: LogAttributes = {
+      repoPath: data.repoPath,
+      branchName: data.branchName,
+    };
+
     logger.debug(
       `Creating git branch '${data.branchName}' in ${path.resolve(data.repoPath)}`,
+      createBranchLogAttributes,
     );
 
     const stdout: string = await this.runGitCommand(data.repoPath, [
@@ -192,7 +207,7 @@ export default class CodeRepositoryUtil {
       data.branchName,
     ]);
 
-    logger.debug(stdout);
+    logger.debug(stdout, createBranchLogAttributes);
   }
 
   @CaptureSpan()
@@ -200,8 +215,14 @@ export default class CodeRepositoryUtil {
     repoPath: string;
     branchName: string;
   }): Promise<void> {
+    const checkoutLogAttributes: LogAttributes = {
+      repoPath: data.repoPath,
+      branchName: data.branchName,
+    };
+
     logger.debug(
       `Checking out git branch '${data.branchName}' in ${path.resolve(data.repoPath)}`,
+      checkoutLogAttributes,
     );
 
     const stdout: string = await this.runGitCommand(data.repoPath, [
@@ -209,7 +230,7 @@ export default class CodeRepositoryUtil {
       data.branchName,
     ]);
 
-    logger.debug(stdout);
+    logger.debug(stdout, checkoutLogAttributes);
   }
 
   @CaptureSpan()
@@ -249,13 +270,21 @@ export default class CodeRepositoryUtil {
       );
     }
 
+    const addFilesLogAttributes: LogAttributes = {
+      repoPath: data.repoPath,
+    };
+
     if (sanitizedRelativeFilePaths.length === 0) {
-      logger.debug("git add skipped because no file paths were provided");
+      logger.debug(
+        "git add skipped because no file paths were provided",
+        addFilesLogAttributes,
+      );
       return;
     }
 
     logger.debug(
       `Adding ${sanitizedRelativeFilePaths.length} file(s) to git in ${path.resolve(data.repoPath)}`,
+      addFilesLogAttributes,
     );
 
     const stdout: string = await this.runGitCommand(data.repoPath, [
@@ -263,7 +292,7 @@ export default class CodeRepositoryUtil {
       ...sanitizedRelativeFilePaths,
     ]);
 
-    logger.debug(stdout);
+    logger.debug(stdout, addFilesLogAttributes);
   }
 
   @CaptureSpan()
@@ -271,7 +300,14 @@ export default class CodeRepositoryUtil {
     repoPath: string;
     username: string;
   }): Promise<void> {
-    logger.debug(`Setting git user.name in ${path.resolve(data.repoPath)}`);
+    const setUsernameLogAttributes: LogAttributes = {
+      repoPath: data.repoPath,
+    };
+
+    logger.debug(
+      `Setting git user.name in ${path.resolve(data.repoPath)}`,
+      setUsernameLogAttributes,
+    );
 
     const stdout: string = await this.runGitCommand(data.repoPath, [
       "config",
@@ -279,7 +315,7 @@ export default class CodeRepositoryUtil {
       data.username,
     ]);
 
-    logger.debug(stdout);
+    logger.debug(stdout, setUsernameLogAttributes);
   }
 
   @CaptureSpan()
@@ -287,7 +323,11 @@ export default class CodeRepositoryUtil {
     repoPath: string;
     message: string;
   }): Promise<void> {
-    logger.debug("Executing git commit");
+    const commitLogAttributes: LogAttributes = {
+      repoPath: data.repoPath,
+    };
+
+    logger.debug("Executing git commit", commitLogAttributes);
 
     const stdout: string = await Execute.executeCommandFile({
       command: "git",
@@ -295,7 +335,7 @@ export default class CodeRepositoryUtil {
       cwd: data.repoPath,
     });
 
-    logger.debug(stdout);
+    logger.debug(stdout, commitLogAttributes);
   }
 
   @CaptureSpan()
@@ -323,7 +363,15 @@ export default class CodeRepositoryUtil {
       `./${relativeTarget}`,
     );
 
-    logger.debug(`Getting last commit hash for ${gitArgument} in ${repoRoot}`);
+    const commitHashLogAttributes: LogAttributes = {
+      repoPath: data.repoPath,
+      filePath: data.filePath,
+    };
+
+    logger.debug(
+      `Getting last commit hash for ${gitArgument} in ${repoRoot}`,
+      commitHashLogAttributes,
+    );
 
     const hash: string = await this.runGitCommand(repoRoot, [
       "log",
@@ -332,7 +380,7 @@ export default class CodeRepositoryUtil {
       gitArgument,
     ]);
 
-    logger.debug(hash);
+    logger.debug(hash, commitHashLogAttributes);
 
     return hash.trim();
   }
@@ -490,6 +538,7 @@ export default class CodeRepositoryUtil {
           return arg.includes(" ") ? `"${arg}"` : arg;
         })
         .join(" ")}`,
+      { repoPath },
     );
 
     return Execute.executeCommandFile({

package/Server/Utils/Express.ts

@@ -37,6 +37,7 @@ export interface OneUptimeRequest extends express.Request {
   userType?: UserType;
   userAuthorization?: JSONWebTokenData;
   tenantId?: ObjectID;
+  requestId?: string;
   userGlobalAccessPermission?: UserGlobalAccessPermission;
   userTenantAccessPermission?: Dictionary<UserTenantAccessPermission>; // tenantId <-> UserTenantAccessPermission;
   rawFormUrlEncodedBody?: string;

package/Server/Utils/Greenlock/Greenlock.ts

@@ -6,7 +6,7 @@ import {
 import AcmeCertificateService from "../../Services/AcmeCertificateService";
 import AcmeChallengeService from "../../Services/AcmeChallengeService";
 import QueryHelper from "../../Types/Database/QueryHelper";
-import logger from "../Logger";
+import logger, { LogAttributes } from "../Logger";
 import SortOrder from "../../../Types/BaseDatabase/SortOrder";
 import LIMIT_MAX from "../../../Types/Database/LimitMax";
 import OneUptimeDate from "../../../Types/Date";
@@ -56,6 +56,7 @@ export default class GreenlockUtil {
 
       logger.debug(
         `Found ${certificates.length} certificates which are expiring soon`,
+        { certificateCount: certificates.length },
       );
 
       // order certificate for each domain
@@ -65,7 +66,14 @@ export default class GreenlockUtil {
           continue;
         }
 
-        logger.debug(`Renewing certificate for domain: ${certificate.domain}`);
+        const certLogAttributes: LogAttributes = {
+          domain: certificate.domain,
+        };
+
+        logger.debug(
+          `Renewing certificate for domain: ${certificate.domain}`,
+          certLogAttributes,
+        );
 
         try {
           //validate cname
@@ -76,6 +84,7 @@ export default class GreenlockUtil {
           if (!isValidCname) {
             logger.debug(
               `CNAME is not valid for domain: ${certificate.domain}`,
+              certLogAttributes,
             );
 
             // if cname is not valid then remove the domain
@@ -84,9 +93,13 @@ export default class GreenlockUtil {
 
             logger.error(
               `Cname is not valid for domain: ${certificate.domain}`,
+              certLogAttributes,
             );
           } else {
-            logger.debug(`CNAME is valid for domain: ${certificate.domain}`);
+            logger.debug(
+              `CNAME is valid for domain: ${certificate.domain}`,
+              certLogAttributes,
+            );
 
             await GreenlockUtil.orderCert({
               domain: certificate.domain,
@@ -95,13 +108,15 @@ export default class GreenlockUtil {
 
             logger.debug(
               `Certificate renewed for domain: ${certificate.domain}`,
+              certLogAttributes,
             );
           }
         } catch (e) {
           logger.error(
             `Error renewing certificate for domain: ${certificate.domain}`,
+            certLogAttributes,
           );
-          logger.error(e);
+          logger.error(e, certLogAttributes);
         }
       }
     } catch (e) {
@@ -127,7 +142,7 @@ export default class GreenlockUtil {
         },
       });
     } catch (err) {
-      logger.error(`Error removing domain: ${domain}`);
+      logger.error(`Error removing domain: ${domain}`, { domain });
       throw err;
     }
   }
@@ -137,14 +152,20 @@ export default class GreenlockUtil {
     domain: string;
     validateCname: (domain: string) => Promise<boolean>;
   }): Promise<void> {
+    const orderLogAttributes: LogAttributes = {
+      domain: data.domain,
+    };
+
     try {
       logger.debug(
         `GreenlockUtil - Ordering certificate for domain: ${data.domain}`,
+        orderLogAttributes,
       );
 
       let { domain } = data;
 
       domain = domain.trim().toLowerCase();
+      orderLogAttributes["domain"] = domain;
 
       const acmeAccountKeyInBase64: string = LetsEncryptAccountKey;
 
@@ -163,20 +184,29 @@ export default class GreenlockUtil {
 
       //validate cname
 
-      logger.debug(`Validating cname for domain: ${domain}`);
+      logger.debug(
+        `Validating cname for domain: ${domain}`,
+        orderLogAttributes,
+      );
 
       const isValidCname: boolean = await data.validateCname(domain);
 
       if (!isValidCname) {
-        logger.debug(`CNAME is not valid for domain: ${domain}`);
-        logger.debug(`Removing domain: ${domain}`);
+        logger.debug(
+          `CNAME is not valid for domain: ${domain}`,
+          orderLogAttributes,
+        );
+        logger.debug(`Removing domain: ${domain}`, orderLogAttributes);
 
         await GreenlockUtil.removeDomain(domain);
-        logger.error(`Cname is not valid for domain: ${domain}`);
+        logger.error(
+          `Cname is not valid for domain: ${domain}`,
+          orderLogAttributes,
+        );
         throw new BadDataException("Cname is not valid for domain " + domain);
       }
 
-      logger.debug(`Cname is valid for domain: ${domain}`);
+      logger.debug(`Cname is valid for domain: ${domain}`, orderLogAttributes);
 
       const client: acme.Client = new acme.Client({
         directoryUrl: acme.directory.letsencrypt.production,
@@ -187,7 +217,10 @@ export default class GreenlockUtil {
         commonName: domain,
       });
 
-      logger.debug(`Ordering certificate for domain: ${domain}`);
+      logger.debug(
+        `Ordering certificate for domain: ${domain}`,
+        orderLogAttributes,
+      );
 
       const certificate: string = await client.auto({
         csr: certificateRequest,
@@ -204,6 +237,7 @@ export default class GreenlockUtil {
           if (challenge.type === "http-01") {
             logger.debug(
               `Creating challenge for domain: ${authz.identifier.value}`,
+              orderLogAttributes,
             );
 
             const acmeChallenge: AcmeChallenge = new AcmeChallenge();
@@ -220,6 +254,7 @@ export default class GreenlockUtil {
 
             logger.debug(
               `Challenge created for domain: ${authz.identifier.value}`,
+              orderLogAttributes,
             );
           }
         },
@@ -231,6 +266,7 @@ export default class GreenlockUtil {
 
           logger.debug(
             `Removing challenge for domain: ${authz.identifier.value}`,
+            orderLogAttributes,
           );
 
           if (challenge.type === "http-01") {
@@ -248,11 +284,15 @@ export default class GreenlockUtil {
 
           logger.debug(
             `Challenge removed for domain: ${authz.identifier.value}`,
+            orderLogAttributes,
           );
         },
       });
 
-      logger.debug(`Certificate ordered for domain: ${domain}`);
+      logger.debug(
+        `Certificate ordered for domain: ${domain}`,
+        orderLogAttributes,
+      );
 
       // get expires at date from certificate
       const cert: acme.CertificateInfo =
@@ -260,8 +300,8 @@ export default class GreenlockUtil {
       const issuedAt: Date = cert.notBefore;
       const expiresAt: Date = cert.notAfter;
 
-      logger.debug(`Certificate expires at: ${expiresAt}`);
-      logger.debug(`Certificate issued at: ${issuedAt}`);
+      logger.debug(`Certificate expires at: ${expiresAt}`, orderLogAttributes);
+      logger.debug(`Certificate issued at: ${issuedAt}`, orderLogAttributes);
 
       // check if the certificate is already in the database.
       const existingCertificate: AcmeCertificate | null =
@@ -278,7 +318,10 @@ export default class GreenlockUtil {
         });
 
       if (existingCertificate) {
-        logger.debug(`Updating certificate for domain: ${domain}`);
+        logger.debug(
+          `Updating certificate for domain: ${domain}`,
+          orderLogAttributes,
+        );
 
         // update the certificate
         await AcmeCertificateService.updateBy({
@@ -298,9 +341,15 @@ export default class GreenlockUtil {
           },
         });
 
-        logger.debug(`Certificate updated for domain: ${domain}`);
+        logger.debug(
+          `Certificate updated for domain: ${domain}`,
+          orderLogAttributes,
+        );
       } else {
-        logger.debug(`Creating certificate for domain: ${domain}`);
+        logger.debug(
+          `Creating certificate for domain: ${domain}`,
+          orderLogAttributes,
+        );
         // create the certificate
         const acmeCertificate: AcmeCertificate = new AcmeCertificate();
 
@@ -317,11 +366,17 @@ export default class GreenlockUtil {
           },
         });
 
-        logger.debug(`Certificate created for domain: ${domain}`);
+        logger.debug(
+          `Certificate created for domain: ${domain}`,
+          orderLogAttributes,
+        );
       }
     } catch (e) {
-      logger.error(`Error ordering certificate for domain: ${data.domain}`);
-      logger.error(e);
+      logger.error(
+        `Error ordering certificate for domain: ${data.domain}`,
+        orderLogAttributes,
+      );
+      logger.error(e, orderLogAttributes);
 
       if (e instanceof Exception) {
         throw e;

package/Server/Utils/LLM/LLMService.ts

@@ -5,7 +5,7 @@ import { JSONObject } from "../../../Types/JSON";
 import API from "../../../Utils/API";
 import LlmType from "../../../Types/LLM/LlmType";
 import BadDataException from "../../../Types/Exception/BadDataException";
-import logger from "../Logger";
+import logger, { LogAttributes } from "../Logger";
 import CaptureSpan from "../Telemetry/CaptureSpan";
 
 export interface LLMMessage {
@@ -92,9 +92,14 @@ export default class LLMService {
         },
       });
 
+    const openAILogAttributes: LogAttributes = {
+      llmType: config.llmType,
+      modelName: modelName,
+    };
+
     if (response instanceof HTTPErrorResponse) {
-      logger.error("Error from OpenAI API:");
-      logger.error(response);
+      logger.error("Error from OpenAI API:", openAILogAttributes);
+      logger.error(response, openAILogAttributes);
       throw new BadDataException(
         `OpenAI API error: ${JSON.stringify(response.jsonData)}`,
       );
@@ -175,9 +180,14 @@ export default class LLMService {
         },
       });
 
+    const anthropicLogAttributes: LogAttributes = {
+      llmType: config.llmType,
+      modelName: modelName,
+    };
+
     if (response instanceof HTTPErrorResponse) {
-      logger.error("Error from Anthropic API:");
-      logger.error(response);
+      logger.error("Error from Anthropic API:", anthropicLogAttributes);
+      logger.error(response, anthropicLogAttributes);
       throw new BadDataException(
         `Anthropic API error: ${JSON.stringify(response.jsonData)}`,
       );
@@ -253,9 +263,14 @@ export default class LLMService {
         },
       });
 
+    const ollamaLogAttributes: LogAttributes = {
+      llmType: config.llmType,
+      modelName: modelName,
+    };
+
     if (response instanceof HTTPErrorResponse) {
-      logger.error("Error from Ollama API:");
-      logger.error(response);
+      logger.error("Error from Ollama API:", ollamaLogAttributes);
+      logger.error(response, ollamaLogAttributes);
       throw new BadDataException(
         `Ollama API error: ${JSON.stringify(response.jsonData)}`,
       );