Giter Club home page Giter Club logo

merkyl's Introduction

merkyl

Introduction

Merkyl is a log file tailer with a bottle web interface. Its intended usage is during unit testing of local or remote systems, where the user wishes to retain context relevant logs. When running lots of tests, it is easy for logs to get huge and trying to sift through them to find the data that is relevant to the portion of time a specific test was running for is tedious, even with time stamping. Merkyl was created to allow you to start a tail of a log file, grab it, and then reset it, effectively clearing the memory of what the file did contain, and replacing it with only new, relevant data.

Merkyl features both an HTTP API and a small web GUI to facilitate ease of use outside of testing frameworks.

Warnings

Merkyl is Beta software and is in no way guaranteed to be secure. Poor usage may leave sensitive files open to the network. It is intended for automated testing purposes only. YOU HAVE BEEN WARNED.

Merkyl is not intended to be used for massively large files and runs using the simple single threaded bottle framework, again, YOU HAVE BEEN WARNED.

Usage

Merkyl is usually pip installed and is started up by running the following:

merkyl 8192 allowed.files

  • 8192 is the port that merkyl should listen on, currently there is no binding to specific IPs and so

runs on all interfaces. * allowed.files is a text file containing paths that merkyl will .startswith() match against when a new path is requested to be tailed.

You can then navigate to the gui by heading to http://127.0.0.1:8192/gui/ and can use the form to add new file names to tail. This file can then be accessed via the GUI, or via http://127.0.0.1:8192/get/file.name note that to get the file you do not use the path, just the file name. This is true with all files, meaning you cannot tail two files of the same name currently.

merkyl's People

Contributors

psav avatar richardfontana avatar cbx33 avatar

Watchers

James Cloos avatar Hervé Beraud 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.