@concordiq/error-sdk 1.0.0

package/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@concordiq/error-sdk",
+  "version": "1.0.0",
+  "description": "Error monitoring SDK",
+  "main": "src/index.js",
+  "type": "module",
+  "keywords": ["errors", "monitoring", "logging"],
+  "author": "Arowolo",
+  "license": "MIT"
+}

package/readMe.md

@@ -0,0 +1,65 @@
+npm install @concordiq/error-sdk
+
+
+`Controller`
+import ErrorSDK from "@arosebine/error-sdk";
+
+ErrorSDK.init({
+  Authorization: "Bearer coiq-6ddfeede1d57a268f7131ef0597624200a8a02b7",
+
+  endpoint: "https://concordiq.onrender.com/api/v1/ingest/events",
+
+  env: "production",
+
+  service: "payment-api"
+});
+
+
+`
+try {
+  processPayment();
+} catch (err) {
+  ErrorSDK.capture(err, {
+    message: err.message,
+    stack: err.stack,
+    type: "crash"
+  });
+}
+`
+
+
+`Express.Js `
+export function expressHandler() {
+  return (err, req, res, next) => {
+    import("./index.js").then(sdk => {
+      sdk.default.capture(err, {
+        url: req.originalUrl,
+        method: req.method,
+        user: req.user?.id
+      });
+    });
+
+    next(err);
+  };
+}
+
+app.use(ErrorSDK.expressMiddleware());
+
+
+
+`To publish it`
+npm login
+npm publish --access public
+
+
+
+`To Test it Locally`
+import ErrorSDK from "./src/index.js";
+
+ErrorSDK.init({
+  apiKey: "test123",
+  endpoint: "http://localhost:4000/ingest"
+});
+
+throw new Error("Test Crash");
+

package/src/client.js

@@ -0,0 +1,19 @@
+import fetch from "node-fetch";
+
+export async function sendError(apiKey, url, payload) {
+  try {
+    await fetch(url, {
+      method: "POST",
+
+      headers: {
+        "Content-Type": "application/json",
+        "x-api-key": apiKey
+      },
+
+      body: JSON.stringify(payload)
+    });
+  } catch (err) {
+    // Never crash client app
+    console.error("SDK Send Failed:", err.message);
+  }
+}

package/src/handlers.js

@@ -0,0 +1,32 @@
+import { sendError } from "./client.js";
+
+export function attachHandlers(config) {
+  // Promise errors
+  process.on("unhandledRejection", err => {
+    report(err, config);
+  });
+
+  // Crash errors
+  process.on("uncaughtException", err => {
+    report(err, config);
+  });
+}
+
+function report(err, config) {
+  const payload = {
+    message: err.message,
+    stack: err.stack,
+    type: "system",
+
+    service: config.service,
+    env: config.env,
+
+    timestamp: new Date()
+  };
+
+  sendError(
+    config.apiKey,
+    config.endpoint,
+    payload
+  );
+}

package/src/index.js

@@ -0,0 +1,57 @@
+import { attachHandlers } from "./handlers.js";
+import { sendError } from "./client.js";
+import { getMeta } from "./utils.js";
+
+let config = null;
+
+function init(options) {
+  if (!options.apiKey) {
+    throw new Error("apiKey required");
+  }
+
+  config = {
+    apiKey: options.apiKey,
+
+    endpoint:
+      options.endpoint ||
+      "https://api.yoursaas.com/ingest",
+
+    env: options.env || "production",
+
+    service: options.service || "app"
+  };
+
+  attachHandlers(config);
+}
+
+async function capture(error, extra = {}) {
+  if (!config) return;
+
+  const payload = {
+    message: error.message || error,
+    stack: error.stack,
+
+    type: "manual",
+
+    env: config.env,
+    service: config.service,
+
+    meta: {
+      ...getMeta(),
+      ...extra
+    },
+
+    timestamp: new Date()
+  };
+
+  await sendError(
+    config.apiKey,
+    config.endpoint,
+    payload
+  );
+}
+
+export default {
+  init,
+  capture
+};

package/src/utils.js

@@ -0,0 +1,9 @@
+import os from "os";
+
+export function getMeta() {
+  return {
+    host: os.hostname(),
+    platform: process.platform,
+    memory: process.memoryUsage().rss
+  };
+}