https://github.com/solzimer/nsyslog

Blazing fast, modular, next gen logagent
https://github.com/solzimer/nsyslog

agent aggregation concurrent correlation filter flow log log-collector logagent modular monitor processors reader real-time realtime syslog-server transporter transporters

Last synced: about 1 month ago
JSON representation

Blazing fast, modular, next gen logagent

• Host: GitHub
• URL: https://github.com/solzimer/nsyslog
• Owner: solzimer
• License: mit
• Created: 2017-05-05T13:01:36.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-06-13T10:00:05.000Z (6 months ago)
• Last Synced: 2024-09-18T10:53:17.085Z (3 months ago)
• Topics: agent, aggregation, concurrent, correlation, filter, flow, log, log-collector, logagent, modular, monitor, processors, reader, real-time, realtime, syslog-server, transporter, transporters
• Language: JavaScript
• Homepage: http://nsyslog.solzimer.es
• Size: 2.91 MB
• Stars: 11
• Watchers: 3
• Forks: 3
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-blazingly-fast - nsyslog - Blazing fast, modular, next gen logagent (JavaScript)

README

        
[![CodeInspector grade](https://www.code-inspector.com/project/2177/score/svg)](https://www.code-inspector.com/public/project/2177/nsyslog/dashboard)

[![DeepScan grade](https://deepscan.io/api/teams/6420/projects/8423/branches/100189/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=6420&pid=8423&bid=100189)



	

	The next generation logagent and syslog server!



# nsyslog

NSyslog is a modern, new generation, logagent and syslog server. It features a modular flow architecture of data collectors (inputs), processors and transporters.

![Architecture](doc/assets/nsyslog.png)

Since all the codebase is written in NodeJS, it has a very small memory footprint and excels at data input/output. It also benefits from the excellent [streams framework](https://nodejs.org/api/stream.html) provided natively by node.

### Main Features

* Small memory footprint

* Flow control of push and pull inputs

* On-Disk input data buffering

* A wide core catalog [inputs](doc/inputs/index.md), [processors](doc/processors/index.md) and [transporters](doc/transporters/index.md)

* Extensible with custom inputs, processors and transporters

* Support for Apache Storm multilang protocol

* Multicore flows for parallel processing

### Installation

#### As a CLI app

```

npm install -g nsyslog

```

Then:

```shell

> nsyslog --help

Usage: nsyslog [options]

Options:

  -V, --version            output the version number

  -f, --file [file]        Config file

  -t, --test               Only validate config file

  -L, --log-level [level]  Debug level

  --cli                    Starts CLI session

  --cli-start              Starts CLI session and flows

  -h, --help               output usage information

```

#### As an embedded module

```

npm install -save nsyslog

```

Then:

```javascript

const NSyslog = require('nsyslog');

async function start() {

	let cfg = await NSyslog.readConfig("config.json");

	let nsyslog = new NSyslog(cfg);

	await nsyslog.start();

}

start();

```

Documentation is [available here](doc/README.md)