/logagent-js

Smart Log Parser and Log Shipper written in Node

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Deploy - read more

Logagent

Smart and lightweight Log Parser and Log Shipper written in Node. It can ship logs to Elasticsearch and thus also to Logsene. See Documentation. Homepage: https://sematext.com/logagent

Status of this package

This is the repository for logagent v2.x.

Release notes

Quickstart

Install Node.js

Official Node.js downloads and instructions. E.g. for Debian/Ubuntu:

curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
sudo apt-get install -y nodejs

Install logagent with npm

sudo npm i -g @sematext/logagent

Install service for logagent using systemd, upstart, launchd

sudo logagent-setup LOGSENE_TOKEN

Edit the config file in /etc/sematext/logagent.conf - by default all logs from /var/log/**/*.log are shipped to Logsene.

sudo service logagent restart # upstart

Features

This project contains a library and patterns for log parsing and cli tools and installers to use logagent as log shipper with the following features:

Parser

  • log format detection and intelligent pattern matching
  • pattern library included
  • easy to extend with custom patterns and JS transform functions
  • recognition of Date and Number fields
  • replace sensitive data with SHA-1 hash codes
  • GeoIP lookup with automatic GeoIP db updates (maxmind geopip-lite files)

Command Line Tool

  • log format converter (e.g. text to JSON, line delimited JSON or YAML)

  • log shipper for Logsene

    • including cli, launchd (Mac OS X), upstart and systemd (Linux) service installer
    • disk buffer for failed inserts during network outage

Inputs

  • Standard input (stdin) that can read the output stream from any Linux cli tool
    • patterns are applied to each incoming text line; includes support for multi-line patters, e.g. for Java Stack Traces and JSON input.
  • Syslog Server (UDP) listener - logagent can also act as a syslog server and receive Syslog messages via UDP. The parser is applied to the message field.
  • Heroku Log Drain makes it easy to ship Heroku logs to Elasticsearch or Logsene
  • Cloud Foundry Log Drain

Processing

  • logagent applies patterns defined in patterns.yml to all logs and creates structured logs from plain-text log lines
  • GeoIP lookups for IP address fields, including automatic download and update of the GeoIP lite database from Maxmind

Reliable log shipping with disk buffer

Logagent doesn't lose data. It stores parsed logs to a disk buffer if the network connection to the Elasticsearch API fails. Logagent retries shipping logs later, when the network or Elasticsearch is available again.

Outputs

  • bulk inserts to Logsene / Elasticsearch API
  • JSON, line delimited JSON and YML to standard output

Deployment options

  • Deployable as a system service: systemd, upstart (Linux), or launchd (Mac OS X)
  • Docker Container to receive logs via syslog
  • Deployment to Heroku as Heroku Log drain
  • Deployment to Cloud Foundry as Cloud Foundry Log drain (thus usable with Pivotal, Bluemix, etc.)

API

  • Node.js module to integrate parsers into Node.js programs
  • logagent is a part of SPM for Docker to parse Container Logs

Documentation

The documentation is available here.

Related packages

Support