Giter VIP home page Giter VIP logo

log-courier's Introduction

Log Courier Build Status

Log Courier is a tool created to transmit log files speedily and securely to remote Logstash instances for processing whilst using small amounts of local resources. The project is an enhanced fork of Logstash Forwarder 0.3.1 with many enhancements and behavioural improvements.

Features

Log Courier implements the following features:

  • Tail log files, following rotations and resuming at the last offset on restart
  • Read from standard input for lightweight shipping of a program's output
  • Extra event fields, arrays and hashes on a per file basis
  • Fast and secure transmission of logs using TLS with both server and client certificate verification
  • Multiline codec to combine multiple lines into single events prior to shipping
  • A ruby gem to enable fast and secure transmission of logs between Logstash instances
  • Transmission of logs via CurveZMQ to multiple receivers simultaneously (optional, requires ZeroMQ 4+)

Installation

Build Requirements

  1. The go compiler tools (>= 1.1.0)
  2. Logstash 1.4.x
  3. (Optional) ZeroMQ (>= 4.0.0)

Building

To build with the optional ZMQ support use the following.

git clone https://github.com/driskell/log-courier
cd log-courier
make with=zmq

Otherwise, simply run make standalone as follows.

git clone https://github.com/driskell/log-courier
cd log-courier
make

The log-courier program can then be found in the 'bin' folder.

A genkey utility can also be found in 'bin' when ZMQ support is built. This utility will generate CurveZMQ key pair configurations for you.

If you receive errors, try using gmake instead.

Logstash Integration

Details instructions on how to integrate with Logstash can be found on the Logstash Integration page.

Generating Certificates and Keys

To quickly create a self-signed SSL certificate, run make selfsigned. This will prompt for the certificate information; most of which can be anything or left as the default except 'Common Name', that should be set to the exact same hostname you will use in log-courier's 'servers' configuration. This ensures that certificate validation passes successfully. You will find the generated .key and .crt files inside the 'bin' folder.

If you will be connecting via IP address, the certificate will need extra information to pass validation. Open spec/lib/openssl.cnf in your favourite editor and look for #subjectAltName = IP:1.1.1.1, remove the pound prefix, set the IP address, and run make selfsigned again.

Command Line Options

The log-courier command accepts the following command line options.

-config="": The config file to load
-cpuprofile="": write cpu profile to file
-from-beginning=false: Read new files from the beginning, instead of the end
-idle-flush-time=5s: Maximum time to wait for a full spool before flushing anyway
-log-to-syslog=false: Log to syslog instead of stdout
-spool-size=1024: Maximum number of events to spool before a flush is forced

Documentation

log-courier's People

Contributors

jordansissel avatar driskell avatar nickethier avatar igalic avatar jamtur01 avatar tzahari avatar willie avatar atwardowski avatar avleen avatar solarce avatar josegonzalez avatar yggdrasil avatar promisedlandt avatar pilif avatar yath avatar sgzijl avatar

Watchers

LuLo avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.