Skip to content
This repository was archived by the owner on Jun 25, 2025. It is now read-only.

Commit 9eb022d

Browse files
author
Jonathan Chauncey
committed
docs(README) update docs
closes #112 closes #114
1 parent fc4fcbc commit 9eb022d

1 file changed

Lines changed: 18 additions & 14 deletions

File tree

README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ a lightweight, [Heroku-inspired](http://heroku.com) workflow.
1212

1313
A system logger for use in the [Deis](http://deis.io) open source PaaS.
1414

15-
This Docker image is based on the official
16-
[alpine:3.2](https://registry.hub.docker.com/_/alpine/) image.
15+
This Docker image is based on [quay.io/deis/base](https://github.com/deis/docker-base) image. You can see what version we are currently using in the [Dockerfile](rootfs/Dockerfile)
1716

1817
## Description
1918
The new v2 logger implementation has seen a simplification from the last rewrite. While it still uses much of that code it no longer depends on `etcd`. Instead, we will use kubernetes service discovery to determine where logger is running.
@@ -23,18 +22,23 @@ We have also decided to not use `logspout` as the mechanism to get logs from eac
2322
## Configuration
2423
The following environment variables can be used to configure logger:
2524

26-
* `DEIS_NSQD_SERVICE_HOST` - default:""
27-
* `DEIS_NSQD_SERVICE_PORT_TRANSPORT` - default:4150
28-
* `NSQ_TOPIC` - default:logs
29-
* `NSQ_CHANNEL` - default:consume
30-
* `NSQ_HANDLER_COUNT` - default:30
31-
* `AGGREGATOR_STOP_TIMEOUT_SEC` - default:1
32-
* `DEIS_LOGGER_REDIS_SERVICE_HOST` - default:""
33-
* `DEIS_LOGGER_REDIS_SERVICE_PORT` - default:6379
34-
* `DEIS_LOGGER_REDIS_PASSWORD` - default:""
35-
* `DEIS_LOGGER_REDIS_DB` - default:0
36-
* `DEIS_LOGGER_REDIS_PIPELINE_LENGTH` - default:50
37-
* `DEIS_LOGGER_REDIS_PIPELINE_TIMEOUT_SECONDS` - default:1
25+
| Name | Default Value |
26+
|------|---------------|
27+
| STORAGE_ADAPTER | "redis" |
28+
| NUMBER_OF_LINES (per app) | "1000" |
29+
| AGGREGATOR_TYPE | "nsq" |
30+
| DEIS_NSQD_SERVICE_HOST | "" |
31+
| DEIS_NSQD_SERVICE_PORT_TRANSPORT | 4150 |
32+
| NSQ_TOPIC | logs |
33+
| NSQ_CHANNEL | consume |
34+
| NSQ_HANDLER_COUNT | 30 |
35+
| AGGREGATOR_STOP_TIMEOUT_SEC | 1 |
36+
| DEIS_LOGGER_REDIS_SERVICE_HOST | "" |
37+
| DEIS_LOGGER_REDIS_SERVICE_PORT | 6379 |
38+
| DEIS_LOGGER_REDIS_PASSWORD | "" |
39+
| DEIS_LOGGER_REDIS_DB | 0 |
40+
| DEIS_LOGGER_REDIS_PIPELINE_LENGTH | 50 |
41+
| DEIS_LOGGER_REDIS_PIPELINE_TIMEOUT_SECONDS | 1 |
3842

3943
## Development
4044
The only assumption this project makes about your environment is that you have a working docker host to build the image against.

0 commit comments

Comments
 (0)