Skip to content

Commit cbb3b0f

Browse files
author
Matthew Fisher
committed
docs(logspout): update docs to reflect deis' fork
1 parent 7b9ea2a commit cbb3b0f

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

logspout/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
# logspout
22

3-
A log router for Docker container output that runs entirely inside Docker. It attaches to all containers on a host, then routes their logs wherever you want.
3+
A log router for Docker container output that runs entirely inside Docker. It attaches to all containers on a host, then routes their logs wherever you want.
44

55
It's a 100% stateless log appliance (unless you persist routes). It's not meant for managing log files or looking at history. It is just a means to get your logs out to live somewhere else, where they belong.
66

7-
For now it only captures stdout and stderr, but soon Docker will let us hook into more ... perhaps getting everything from every container's /dev/log.
7+
For now it only captures stdout and stderr, but soon Docker will let us hook into more ... perhaps getting everything from every container's /dev/log.
88

99
## Getting logspout
1010

11-
Logspout is a very small Docker container (14MB virtual, based on busybox), so you can just pull it from the index:
11+
Logspout is a very small Docker container, so you can just pull it from the index:
1212

13-
$ docker pull progrium/logspout
13+
$ docker pull deis/logspout
1414

1515
## Using logspout
1616

1717
#### Route all container output to remote syslog
1818

1919
The simplest way to use logspout is to just take all logs and ship to a remote syslog. Just pass a default syslog target URI as the command. Also, we always mount the Docker Unix socket with `-v` to `/tmp/docker.sock`:
2020

21-
$ docker run -v=/var/run/docker.sock:/tmp/docker.sock progrium/logspout syslog://logs.papertrailapp.com:55555
21+
$ docker run -v=/var/run/docker.sock:/tmp/docker.sock deis/logspout syslog://logs.papertrailapp.com:55555
2222

23-
Logs will be tagged with the container name. The hostname will be the hostname of the logspout container, so you probably want to set the container hostname to the actual hostname by adding `-h $HOSTNAME`.
23+
If deis/logspout is deployed on Deis, it will connect automatically to deis-logger via service discovery.
2424

2525
#### Inspect log streams using curl
2626

2727
Whether or not you run it with a default routing target, if you publish its port 8000, you can connect with curl to see your local aggregated logs in realtime.
2828

2929
$ docker run -d -p 8000:8000 \
3030
-v=/var/run/docker.sock:/tmp/docker.sock \
31-
progrium/logspout
31+
deis/logspout
3232
$ curl $(docker port `docker ps -lq` 8000)/logs
3333

3434
You should see a nicely colored stream of all your container logs. You can filter by container name, log type, and more. You can also get JSON objects, or you can upgrade to WebSocket and get JSON logs in your browser.
@@ -37,14 +37,14 @@ See [Streaming Endpoints](#streaming-endpoints) for all options.
3737

3838
#### Create custom routes via HTTP
3939

40-
Along with streaming endpoints, logspout also exposes a `/routes` resource to create and manage routes.
40+
Along with streaming endpoints, logspout also exposes a `/routes` resource to create and manage routes.
4141

4242
$ curl $(docker port `docker ps -lq` 8000)/logs -X POST \
4343
-d '{"source": {"filter": "db", "types": ["stderr"]}, target": {"type": "syslog", "addr": "logs.papertrailapp.com:55555"}}'
4444

45-
That example creates a new syslog route to [Papertrail](https://papertrailapp.com) of only `stderr` for containers with `db` in their name.
45+
That example creates a new syslog route to [Papertrail](https://papertrailapp.com) of only `stderr` for containers with `db` in their name.
4646

47-
By default, routes are ephemeral. But if you mount a volume to `/mnt/routes`, they will be persisted to disk.
47+
By default, routes are ephemeral. But if you mount a volume to `/mnt/routes`, they will be persisted to disk.
4848

4949
See [Routes Resource](#routes-resource) for all options.
5050

@@ -88,9 +88,9 @@ Takes a JSON object like this:
8888
}
8989
}
9090

91-
The `source` field should be an object with `filter`, `name`, or `id` fields. You can specify specific log types with the `types` field to collect only `stdout` or `stderr`. If you don't specify `types`, it will route all types.
91+
The `source` field should be an object with `filter`, `name`, or `id` fields. You can specify specific log types with the `types` field to collect only `stdout` or `stderr`. If you don't specify `types`, it will route all types.
9292

93-
To route all logs of all types on all containers, don't specify a `source`.
93+
To route all logs of all types on all containers, don't specify a `source`.
9494

9595
The `append_tag` field of `target` is optional and specific to `syslog`. It lets you append to the tag of syslog packets for this route. By default the tag is `<container-name>`, so an `append_tag` value of `.app` would make the tag `<container-name>.app`.
9696

@@ -143,4 +143,4 @@ This project was made possible by [DigitalOcean](http://digitalocean.com).
143143

144144
## License
145145

146-
BSD
146+
BSD

0 commit comments

Comments
 (0)