Package Exports

log.io-file-input

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (log.io-file-input) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Log.io - File Input

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.

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 file input

Install via npm

npm install -g log.io-file-input

Configure file input (see example below)

nano ~/.log.io/inputs/file.json

Run file input

log.io-file-input

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 ~/.log.io/inputs/file.json, and can be overridden with the environment variable LOGIO_FILE_INPUT_CONFIG_PATH.

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:

{
  "messageServer": {
    "host": "127.0.0.1",
    "port": 6689
  },
  "inputs": [
    {
      "source": "server1",
      "stream": "app1",
      "config": {
        "path": "log.io-demo/file-generator/app1-server1.log"
      }
    },
    {
      "source": "server2",
      "stream": "system-logs",
      "config": {
        "path": "/var/log/**/*.log",
        "watcherOptions": {
          "ignored": "*.txt",
          "depth": 99,
        }
      }
    }
  ]
}

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

+msg|streamName1|sourceName1|this is log message\0

+input|streamName1|sourceName1\0

Remove an existing input

-input|streamName1|sourceName1\0