Merge pull request #60 from topcoder-platform/tracing

Tracing

Author: Hamid Tavakoli

config/default.js

@@ -48,5 +48,8 @@ module.exports = {
   API_CONTEXT_PATH: process.env.API_CONTEXT_PATH || '/v5/email',
 
   PAYLOAD_SENDGRID_TEMPLATE_KEY: process.env.PAYLOAD_SENDGRID_TEMPLATE_KEY || 'sendgrid_template_id',
-
+  //Tracing information
+  APM_OTLP_TRACE_EXPORTER_URL: process.env.APM_OTLP_TRACE_EXPORTER_URL || '',
+  APM_SERVICE_NAME: process.env.APM_SERVICE_NAME || 'tc-email-service',
+  APM_TRACER_NAME: process.env.APM_TRACER_NAME || 'tc-email-service',
 };

connect/connectEmailServer.js

@@ -6,6 +6,7 @@ const config = require('config');
 const emailServer = require('../index');
 const service = require('./service');
 const logger = require('../src/common/logger');
+const { functionWrapper } = require('../src/common/wrapper');
 
 // set configuration for the server, see ../config/default.js for available config parameters
 // setConfig should be called before initDatabase and start functions
@@ -17,20 +18,23 @@ emailServer.setConfig({ LOG_LEVEL: config.LOG_LEVEL });
 // the topic is topic name,
 // the message is JSON event message,
 const handler = async (topic, message) => {
-  let templateId = config.TEMPLATE_MAP[topic];
-  templateId = _.get(message, config.PAYLOAD_SENDGRID_TEMPLATE_KEY, templateId);
-  if (!templateId) {
-    return { success: false, error: `Template not found for topic ${topic}` };
-  }
-
-  try {
-    await service.sendEmail(templateId, message)
-    return { success: true };
-  } catch (err) {
-    logger.error("Error occurred in sendgrid api calling:", err);
-    return { success: false, error: err };
-  }
+  (await functionWrapper(async () => {
 
+    let templateId = config.TEMPLATE_MAP[topic];
+    templateId = _.get(message, config.PAYLOAD_SENDGRID_TEMPLATE_KEY, templateId);
+    if (!templateId) {
+      return { success: false, error: `Template not found for topic ${topic}` };
+    }
+
+    try {
+      await service.sendEmail(templateId, message)
+      return { success: true };
+    } catch (err) {
+      logger.error("Error occurred in sendgrid api calling:", err);
+      return { success: false, error: err };
+    }
+
+  }, 'emailHandler'))(topic, message);
 };
 
 // init all events

connect/service.js

@@ -10,55 +10,57 @@ const logger = require('../src/common/logger');
 sgMail.setApiKey(config.SENDGRID_API_KEY);
 
 const sendEmail = async (templateId, message) => { // send email
+  (await functionWrapper(async () => {
 
-  let msg = {}
-  const from = message.from ? message.from : config.EMAIL_FROM;
-  const replyTo = message.replyTo ? message.replyTo : config.EMAIL_FROM;
-  const substitutions = message.data;
-  const categories = message.categories ? message.categories : [];
-  const to = message.recipients;
-  const cc = message.cc ? message.cc : [];
-  const bcc = message.bcc ? message.bcc : [];
-  const sendAt = message.sendAt ? message.sendAt : undefined;
-  const personalizations = message.personalizations ? message.personalizations : undefined
-  const attachments = message.attachments ? message.attachments : [];
+    let msg = {}
+    const from = message.from ? message.from : config.EMAIL_FROM;
+    const replyTo = message.replyTo ? message.replyTo : config.EMAIL_FROM;
+    const substitutions = message.data;
+    const categories = message.categories ? message.categories : [];
+    const to = message.recipients;
+    const cc = message.cc ? message.cc : [];
+    const bcc = message.bcc ? message.bcc : [];
+    const sendAt = message.sendAt ? message.sendAt : undefined;
+    const personalizations = message.personalizations ? message.personalizations : undefined
+    const attachments = message.attachments ? message.attachments : [];
 
-  if (message.version && message.version == "v3") {
-    msg = {
-      to,
-      templateId,
-      dynamicTemplateData: substitutions,
-      personalizations,
-      from,
-      replyTo,
-      categories,
-      cc,
-      bcc,
-      attachments,
-      sendAt
-    };
-  } else {
-    msg = {
-      to,
-      templateId,
-      substitutions,
-      substitutionWrappers: ['{{', '}}'],
-      from,
-      replyTo,
-      categories,
-      cc,
-      bcc,
-    };
-  }
-  logger.info(`Sending email with templateId: ${templateId} and message: ${JSON.stringify(msg)}`);
-  try {
-    const result = await sgMail.send(msg)
-    logger.info(`Email sent successfully with result: ${JSON.stringify(result)}`);
-    return result
-  } catch (err) {
-    logger.error(`Error occurred in sendgrid api calling: ${err}`);
-    throw err
-  }
+    if (message.version && message.version == "v3") {
+      msg = {
+        to,
+        templateId,
+        dynamicTemplateData: substitutions,
+        personalizations,
+        from,
+        replyTo,
+        categories,
+        cc,
+        bcc,
+        attachments,
+        sendAt
+      };
+    } else {
+      msg = {
+        to,
+        templateId,
+        substitutions,
+        substitutionWrappers: ['{{', '}}'],
+        from,
+        replyTo,
+        categories,
+        cc,
+        bcc,
+      };
+    }
+    logger.info(`Sending email with templateId: ${templateId} and message: ${JSON.stringify(msg)}`);
+    try {
+      const result = await sgMail.send(msg)
+      logger.info(`Email sent successfully with result: ${JSON.stringify(result)}`);
+      return result
+    } catch (err) {
+      logger.error(`Error occurred in sendgrid api calling: ${err}`);
+      throw err
+    }
+  }, 'sendgridSendEmail'))(templateId, message);
 }
 module.exports = {
   sendEmail,