Code Monkey home page Code Monkey logo

docker-logentries's Introduction

docker-logentries

Forward all your logs to Logentries, like a breeze.

logentries dashboard

See the Logentries community pack at http://revelops.com/community/packs/docker/.

Usage as a Container

The simplest way to forward all your container's log to Logentries is to run this repository as a container, with:

docker run -v /var/run/docker.sock:/var/run/docker.sock logentries/docker-logentries -t <TOKEN> -j -a host=`uname -n`

You can also use different tokens for logging, stats and events:

docker run -v /var/run/docker.sock:/var/run/docker.sock logentries/docker-logentries -l <LOGSTOKEN> -k <STATSTOKEN> -e <EVENTSTOKEN> -j -a host=`uname -n`

You can pass the --no-stats flag if you do not want stats to be published to Logentries every second. You need this flag for Docker version < 1.5.

You can pass the --no-logs flag if you do not want logs to be published to Logentries.

You can pass the --no-dockerEvents flag if you do not want events to be published to Logentries.

The -i/--statsinterval <STATSINTERVAL> downsamples the logs sent to Logentries. It collects samples and averages them before sending to Logentries.

If you don't use -a a default host=`uname -n` value will be added.

In a managed environment, container names may be obfuscated. If there is a label that provides a better name for logging, it can be used instead: --nameLabel com.amazonaws.ecs.container-name.

You can also filter the containers for which the logs/stats are forwarded with:

  • --matchByName REGEXP: forward logs/stats only for the containers whose name matches the given REGEXP.
  • --matchByImage REGEXP: forward logs/stats only for the containers whose image matches the given REGEXP.
  • --skipByName REGEXP: do not forward logs/stats for the containers whose name matches the given REGEXP.
  • --skipByImage REGEXP: do not forward logs/stats for the containers whose image matches the given REGEXP.

You can pass the --containersTokensFilepath flag if you want different containers logs to be published to different log sets. The configuration file needs to respect the following format:

{
    "repoName1": "logentries_token",
    "repoName2": "logentries_token"
}

Running container in a restricted environment.

Some environments(such as Google Compute Engine) does not allow to access the docker socket without special privileges. You will get EACCES(Error: read EACCES) error if you try to run the container. To run the container in such environments add --privileged to the docker run command.

Example:

docker run --privileged -v /var/run/docker.sock:/var/run/docker.sock logentries/docker-logentries -t <TOKEN> -j -a host=`uname -n`

Usage as a CLI

  1. npm install docker-logentries -g
  2. docker-logentries -t TOKEN -a host=\uname -n``
  3. ..there is no step 3

You can also pass the -j switch if you log in JSON format, like bunyan.

You can pass the --no-stats flag if you do not want stats to be published to Logentries every second.

You can pass the --no-logs flag if you do not want logs to be published to Logentries.

You can pass the --no-dockerEvents flag if you do not want events to be published to Logentries.

The -a/--add flag allows to add fixed values to the data being published. This follows the format 'name=value'.

The -i/--statsinterval downsamples the logs sent to Logentries. It collects samples and averages them before sending to Logentries.

In a managed environment, container names may be obfuscated. If there is a label that provides a better name for logging, it can be used instead: --nameLabel com.amazonaws.ecs.container-name.

You can also filter the containers for which the logs/stats are forwarded with:

  • --matchByName REGEXP: forward logs/stats only for the containers whose name matches the given REGEXP.
  • --matchByImage REGEXP: forward logs/stats only for the containers whose image matches the given REGEXP.
  • --skipByName REGEXP: do not forward logs/stats for the containers whose name matches the given REGEXP.
  • --skipByImage REGEXP: do not forward logs/stats for the containers whose image matches the given REGEXP.

Embedded usage

Install it with: npm install docker-logentries --save

Then, in your JS file:

var logentries = require('docker-logentries')({
  json: false, // or true to parse lines as JSON
  secure: true, // or false to connect over plain TCP
  token: process.env.TOKEN, // logentries TOKEN
  newline: true, // Split on newline delimited entries
  stats: true, // disable stats if false
  add: null, // an object whose properties will be added

  // In a managed environment, container names may be obfuscated. 
  // If there is a label that provides a better name for logging,
  // provide the key here.
  nameLabel: 'com.amazonaws.ecs.container-name',

  // the following options limit the containers being matched
  // so we can avoid catching logs for unwanted containers
  matchByName: /hello/, // optional
  matchByImage: /matteocollina/, //optional
  skipByName: /.*pasteur.*/, //optional
  skipByImage: /.*dockerfile.*/ //optional
})

// logentries is the source stream with all the
// log lines

setTimeout(function() {
  logentries.destroy()
}, 5000)

Building a docker repo from this repository

Using the plain docker file

First clone this repository, then:

docker build -t logentries .
docker run -v /var/run/docker.sock:/var/run/docker.sock logentries -t <TOKEN> -j -a host=`uname -n`

Using Make - the official nodejs onbuild image

export BUILD_TYPE=node-onbuild
make build
make test
make tag

Using Make - the alpine linx build (~42Mb)

export BUILD_TYPE=alpine-node
make build
make test
make tag

Pushing to your own repo

After you've build, tested, tagged it locally

export DOCKER_REGISTRY_PREFIX=you-dockerhub-user/yourimage-name
make push

How it works

This module wraps four Docker APIs:

  • POST /containers/{id}/attach, to fetch the logs
  • GET /containers/{id}/stats, to fetch the stats of the container
  • GET /containers/json, to detect the containers that are running when this module starts
  • GET /events, to detect new containers that will start after the module has started

This module wraps docker-loghose and docker-stats to fetch the logs and the stats as a never ending stream of data.

All the originating requests are wrapped in a never-ending-stream.

License

MIT

docker-logentries's People

Contributors

mcollina avatar jedi4ever avatar stephenhynes7 avatar maxim-filimonov avatar m0wfo avatar mihaidma avatar pelger avatar cammellos avatar ardimehist-r7 avatar omgapuppy avatar looztra avatar gcallsen avatar jperichon avatar kennethlimcp avatar ream88 avatar knakayama avatar

Watchers

Sebastian Hillig avatar R. Kevin Nelson avatar James Cloos avatar Markus Hinsche avatar Jakub 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.