An open API service indexing awesome lists of open source software.

https://github.com/errsole/errsole.js

Collect, Store, and Visualize Logs with a Single Module
https://github.com/errsole/errsole.js

bunyan log log4j log4js logger logging logs node nodejs open-source opensource pino winston

Last synced: 2 months ago
JSON representation

Collect, Store, and Visualize Logs with a Single Module

Awesome Lists containing this project

README

        


Collect, Store, and Visualize Logs with a Single Module


Setup |
Advanced Configuration |
Advanced Logging Functions


Release Version
Last Commit
License

Coverage Status

Errsole is an open-source logger for Node.js apps. It comes with a built-in log viewer to view, filter, and search your app logs.

https://github.com/user-attachments/assets/ddb68538-f6eb-4416-b761-e215328f177f

## Features

### Minimal Setup

Just include the Errsole package in your code—no need for dedicated servers, software installations, or complicated configurations.

### Logger++

Errsole automatically collects all logs from the Node.js console. Additionally, it provides advanced logging functions that support multiple log levels and the ability to attach metadata to logs. [Read More](https://github.com/errsole/errsole.js/blob/master/docs/advanced-logging-functions.md)

### Store Anywhere

Store your logs wherever you want—whether in a file or any database of your choice. You can also configure log rotation to specify how long logs should be retained.

### Log Viewer

View, filter, and search through your logs using the built-in Web Dashboard. Secure authentication and team management features ensure that only you and your team can access the logs.

### Critical Error Notifications

Get immediate notifications when your app crashes or encounters critical errors. The notification includes the error message, the app name, the environment, the server name, and a direct link to view the error in your logs.

## Benchmarks

A Node.js app using Errsole Logger can handle 90,000 more requests per minute than when using Elasticsearch and 70,000 more requests per minute than when using Amazon CloudWatch. [Read More](https://github.com/errsole/errsole.js/blob/master/docs/benchmarks.md)

errsole-vs-elasticsearch-benchmarks

## Setup

#### Development Environment
For local development or scenarios where you prefer storing logs directly on the server, you can integrate Errsole with SQLite. When using SQLite, logs will be stored in a file on your server.

* [Errsole with SQLite](https://github.com/errsole/errsole.js/blob/master/docs/sqlite-storage.md)

#### Production Environment

In production environments, where centralized log storage is critical, Errsole offers multiple storage options to fit your needs:

* [Errsole with MySQL](https://github.com/errsole/errsole.js/blob/master/docs/mysql-storage.md)
* [Errsole with PostgreSQL](https://github.com/errsole/errsole.js/blob/master/docs/postgresql-storage.md)
* [Errsole with MongoDB](https://github.com/errsole/errsole.js/blob/master/docs/mongodb-storage.md)
* Errsole with AWS DynamoDB (Upcoming)

#### Advanced Configuration

* [Advanced Configuration](https://github.com/errsole/errsole.js/blob/master/docs/advanced-configuration.md)

#### Advanced Logging

* [Advanced Logging Functions](https://github.com/errsole/errsole.js/blob/master/docs/advanced-logging-functions.md)

#### Integrations

* [Winston with Errsole](https://github.com/errsole/errsole.js/blob/master/docs/winston-errsole.md)
* Pino with Errsole (Upcoming)

## FAQs

* [How can I resolve the "Error: listen EADDRINUSE: address already in use :::8001" error?](https://github.com/errsole/errsole.js/discussions/91)
* [How can I run the Errsole Dashboard on a separate server from my app?](https://github.com/errsole/errsole.js/discussions/113)

## Useful Links

* **Encountering issues?** [Open an issue](https://github.com/errsole/errsole.js/issues/new) on our GitHub repository.

* **Have questions?** Use our [Q&A forum](https://github.com/errsole/errsole.js/discussions/categories/q-a).

* **Want to request a feature or share your ideas?** Use our [discussion forum](https://github.com/errsole/errsole.js/discussions/categories/general).

* **Want to contribute?** First, share your idea with the community in our [discussion forum](https://github.com/errsole/errsole.js/discussions/categories/general) to see what others are saying. Then, fork the repository, make your changes, and submit a pull request.

## License

[MIT](https://github.com/errsole/errsole.js/blob/master/LICENSE)