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

https://github.com/telexintegrations/smart-log-error-tracker


https://github.com/telexintegrations/smart-log-error-tracker

Last synced: 9 months ago
JSON representation

Awesome Lists containing this project

README

          

# Smart-Log-Error-Tracker

A Telex integration specialized in monitoring and reporting Nginx error logs. This service analyzes Nginx error logs and reports them through Telex's webhook system, with planned support for remote Nginx instances.

## Features

Current Features:
- Local Nginx error log monitoring
- Intelligent error parsing and classification
- Configurable error thresholds
- Severity-based error categorization
- Real-time Nginx error detection
- Detailed error analysis and reporting

Upcoming Features:
- Remote Nginx instance monitoring
- Multi-instance support
- Dynamic log source configuration
- Real-time remote log streaming
- User authentication and access control
- Custom alert configurations per instance
- Dashboard for monitoring multiple Nginx servers

## Prerequisites

- Node.js v20.11.1 or higher
- npm v10.x or higher
- Access to Nginx error logs
- Telex webhook URL (for production)

## Installation

1. Clone the repository:

```bash
git clone
cd nginxLogErrorTracker
```

2. Install dependencies:

```bash
npm install
```

3. Configure environment variables:

```bash
cp .env.example .env
# Edit .env with your configuration
```

## Configuration

Create a `.env` file with the following variables:

```env
NODE_ENV=development
NGINX_LOG_PATH=C:\\nginx-1.27.4\\logs\\error.log # Update with your Nginx log path
ERROR_THRESHOLD=1
TELEX_WEBHOOK_URL=https://telex.example.com/webhook
```

## Usage

### Development

```bash
npm run start
```

### Testing

```bash
npm test
```

### Manual Testing

```bash
npm run manual-test
```

## Error Classification

The system classifies Nginx errors into the following severity levels:

- 🔴 Emergency/Critical (emerg, alert, crit) - Severity 7-5
- 🔴 Error (error) - Severity 4
- 🟡 Warning (warn) - Severity 3
- đŸŸĸ Notice (notice) - Severity 2
- â„šī¸ Info (info) - Severity 1
- 🔍 Debug (debug) - Severity 0

## Roadmap

1. Remote Instance Support
- Secure remote log access
- Multiple instance management
- Instance health monitoring

2. User Management
- Authentication system
- Role-based access control
- Instance access permissions

3. Enhanced Monitoring
- Real-time dashboard
- Custom alert rules
- Historical data analysis

4. Advanced Features
- Log pattern learning
- Predictive error detection
- Custom reporting formats
---