README
¶
Fireplace
Fireplace is a set of tools for capturing and viewing structured log entries from your applications. Currently it is specifically tailored to log entries coming from Go applications using https://github.com/sirupsen/logrus for logging. Fireplace provides a hook which will automatically send logs to Fireplace Server and capture them into a MongoDB database. Fireplace Viewer can then be used to sort through logs using a web UI.
Screenshots
Getting Started
Fireplace Server is a Go application that runs an HTTP server for capturing and serving up structured log entries. Fireplace Viewer is a web application used to view these captured logs.
Here we'll show how to get setup using Docker. If you wish to know more details about either the server or viewer, check out their respective READMEs.
Build and Run from Docker Registry
docker run --name fireplace -d appnerds/fireplace
Local Docker Build and Run
To run the server, viewer, and database, the first task is to setup an
environment file. In the root of this repository there is a file named
env.template.
Make a copy of this file and rename it to .env. Then open the file
and modify the values for your configuration. Also be sure to include
your private GITHUB_TOKEN. Be sure to use a token that has access to
the private App Nerds repositories for building.
Now, run the following to build and run.
docker-compose up
Then open your browser to http://localhost:8090.
Directories