Giter VIP home page Giter VIP logo

emitterly's Introduction

Emitterly Logo

Package quality NPM Version Build Status Coverage Status Licensing Commit Activity Last Commit Repo size Downloads per week Node version Top language of repo Help us and star this project

Getting Started

Start by installing Emitterly globally
npm install emitterly --global
Emitterly works with YAML files to load your prefered settings, start by creating a settings file
events:
  # This is a event name
  # It has a file that it watches and grok patterns that
  # Will match the last line that has been observed
  newlineevent:
    # The file to watch
    file: './test.txt'

    # There can be multiple filters
    filters:
      # this filter called filter1 will match: [12:08:44] 192.168.2.1 (INFO) - User logged in
      filter1: '\[%{TIME:time}\] %{IP:ip} \(%{WORD:type}\) - %{GREEDYDATA:message}'

    # There can be multiple actions
    actions:
      # A webhook action only needs a url to post to, it will post in JSON format
      webhook: 'https://webhook.site/04ed7a87-f9e5-472d-8f66-fc50f83b0a67'

    # The condition for the actions to be triggered in this event, you can use variables from the event class itself
    # For example: '"%match.ip%" == "192.168.2.1"'
    condition: '1 === 1'

    # The payload to send with the actions
    payload:
      data: '%match.ip% %event% %condition% customstring'
Start Emitterly to listen
emitterly --config "/path/to/your/settings.yml"

That's it your all done! Emitterly will listen for file changes and trigger your actions

Filters

Emitterly uses grok filters to extract key value pairs from a line event

emitterly's People

Contributors

absolute-quantum 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.