NarrativeScience-old / log.io

Log.io - Real-time log monitoring in your browser ================================================= Powered by node.js + socket.io How does it work? A **file input** watches log files for changes, sends new messages to the **server** via TCP, which broadcasts to **browsers** via socket.io. Users can watch adhoc log streams by activating inputs and binding them to multiple screens via the web UI. Terminology **Stream** - A logical designation for a group of messages that relate to one another. Examples include an application name, a topic name, or a backend service name. **Source** - A physical designation for a group of messages that originate from the same source. Examples include a server name, a service provider name, or a filename. **Input** - A (stream, source) pair. While originally designed to represent backend service logs spread across multiple servers, the stream/source abstraction is intentionally open-ended to allow users to define a system topology for their specific use case. Install & run server Install via npm Configure hosts & ports (see example below) Run server Browse to http://localhost:6688 Install & run file input Install via npm Configure file input (see example below) Run file input Server configuration There are two servers: the message server, which receives TCP messages from message inputs, and the HTTP server, which receives requests from browsers. By default, the application looks for configuration in , and can be overridden with the environment variable . Sample configuration file: and are both optional keys that can be omitted. File input configuration Inputs are created by associating file paths with stream and source names in a configuration file. By default, the file input looks for configuration in , and can be overridden with the environment variable . Input paths can be a file path, directory path or a glob). Additionally, watcher options can be provided for more fine-grained control over file watching mechanics and performance. See the chokidar documentation for more information. Sample configuration file: Server TCP interface The file input connects to the server via TCP, and writes properly formatted strings to the socket. Custom inputs can send messages to the server using the following commands, each of which ends with a null character: Send a log message Register a new input Remove an existing input