Cribl Interview Project

A "homework" interview project for Cribl!

Quick Start

# install
cd criblio-interview
npm install
npm start

ℹ️ The system must be run with root permissions in order to access most files within /var/log!

Maybe try out some queries! Example using httpie:

# Discover devices
http get 'http://localhost:8080/v1/devices/'

# List available logs on device "a74c3a93-6eee-5f91-80a8-07ee31d0c253"
http get 'http://localhost:8080/v1/devices/a74c3a93-6eee-5f91-80a8-07ee31d0c253/logs'

# Fetch some log lines from a device/log tuple
http get 'http://localhost:8080/v1/devices/a74c3a93-6eee-5f91-80a8-07ee31d0c253/logLines?file=vmware-network.log&count=42

Testing

npm test

For Developers

Installation

Git clone this project
npm install

Configuration

A configuration file, config.json can be used to override some defaults. The following example shows keys that may be overridden:

{
  "mode": "FOLLOWER",
  "port": 8080,
  "host": "localhost",
  "logLocation": "/var/foo/log",
  "leaderHost": "10.0.2.4",
  "leaderPort": 8080
}

Docs

See Documentation for additional information.

Missing Functionality

A number of items are not implemented, including:

AuthZ/AuthN
TLS
A number of quickly hand rolled methods such as HTTP requests need to handle edge cases
Logging
Additional testing that I don't yet have time to implement

Additionally, a number of optimizations could be performed such as caching: Perhaps a LRU of recently fetched log files per device. Keep a open fd and implement a fs watch on the particular log with a window of of the last N entries and ending position. Requests on these logs and within the window require no additional IO; requests larger than the window need only read from the known position and back.

License

See LICENSE.TXT.

NuSkooler/criblio-interview