errsole

Fix Your Node.js Errors in Minutes

---

:star: We appreciate your star. It helps!

Table of Contents

• Getting Started
• Features
  • Know the root cause of every error in your app
  • Reproduce any error with just a click of a button
  • Debug the server code without affecting your live app
  • Collaborate and take your productivity to the next level
• Demo Video
• Try Our Sandbox
• Documentation
• Support
• License

---

Getting Started

Install

Errsole is a Node.js module. You can install this module using the npm install command:

npm install errsole

Configure

You must obtain a unique token to configure the Errsole module in your app.

Follow the steps below to generate a unique token:

1. Click on the button below to go to the Errsole website.
2. Create an Errsole account or sign in with an existing one.
3. Create an entry for your app.
4. Copy the code snippet generated for your app, which includes a unique token.
5. Insert the code snippet as the first line of your app's main file.
6. Deploy your app as usual. Once deployed, Errsole will start capturing errors and associating them with your app's entry in the Errsole platform.

Example

/**
 * Insert this Errsole code snippet as the first line of your app's main file
 */
const errsole = require('errsole');
errsole.initialize({
  framework: 'express',
  token: '[Your Errsole Token]',
  exitOnException: true,
  skipRoutes: [{
    method: 'POST',
    path: '/users/login'
  }],
  filterRoutes: [{
    method: 'PUT',
    path: '/users/:userId/profile'
  }],
  editCode: true,
  evalExpression: true
});
// End of Errsole code snippet

/**
 * Your app code starts here
 */
const express = require('express');
const app = express();

app.get('/', function (req, res) {
  res.send('Hello World');
});

app.listen(3000);

Advanced Configuration

Name	Type	Description
framework	string	Required. Your Node.js framework name.
token	string	Required. Create a unique token for your app on the Errsole website.
exitOnException	boolean	Optional. The default value is true. By default, Errsole will exit the process after capturing an uncaught exception. If this is not the behavior you want, you can disable it by setting exitOnException to false.
skipRoutes	Array	Optional. The default value is []. Errsole does not save any HTTP requests that match the routes specified in this list.
filterRoutes	Array	Optional. The default value is []. Errsole only captures the Method, URL, and Status Code of HTTP requests that match the routes specified in this list.
enableDebugger	boolean	Optional. The default value is true. If false, the Errsole Debugger is disabled.
editCode	boolean	Optional. If true, your developers have the ability to edit code in a sandbox while debugging an error. This feature allows your developers to debug your app's code more effectively, but it also grants them the ability to run arbitrary code on your server. You have two options: You can set it to false here to disable the code editing option for all developers, or you can set it to true here and manage the permissions of each developer on the errsole website.
evalExpression	boolean	Optional. If true, your developers have the ability to evaluate JavaScript expressions while debugging an error. This feature allows your developers to debug your app's code more effectively, but it also grants them the ability to run arbitrary code on your server. You have two options: You can set it to false here to disable the eval expression option for all developers, or you can set it to true here and manage the permissions of each developer on the errsole website.

---

Features

Know the root cause of every error in your app

Errsole captures all errors raised in all your servers, along with the HTTP requests that caused them, which is all the information you need to reproduce the errors.

Reproduce any error with just a click of a button

Errsole creates a sandbox environment that is an exact replica of your live app. You can reproduce the error in the sandbox and inspect every line of the code without affecting the live app.

Debug the server code without affecting your live app

With a feature-rich debugger directly connected to the sandbox, you can set breakpoints, reproduce the error, inspect variables, identify the problem, edit code and verify the fix without affecting your live app.

Collaborate and take your productivity to the next level

You can invite your entire development team to your app and control their permissions at a granular level. You can assign errors to your developers to speed up error resolution and increase productivity.

---

Demo Video

https://github.com/errsole/errsole.js/assets/3775513/f7dadda0-9dc9-4827-9d96-2b7e41473a5d

---

Try Our Sandbox

Experience Errsole firsthand by troubleshooting errors in our demo app:

---

Documentation

For a complete product documentation, please visit our documentation page:

https://www.errsole.com/documentation/

---

Support

:star: We appreciate your star. It helps!

If you run into any issues, please email us at [e-mail].

For bug reports, please open an issue on GitHub.

License

MIT