Move canonical repo to heroku/log-shuttle

readme.md

@@ -2,95 +2,4 @@
 
 # Log Shuttle
 
-[Logplex](https://github.com/heroku/logplex) supports HTTP inputs. Each user process will pipe it's `stdout` to log-shuttle. Log-shuttle will POST the data to [Logplex](https://github.com/heroku/logplex).
-
-Problems that log-shuttle solves:
-
-* Remove Syslog dependency between user process & Logplex.
-* Improve cross-datacenter security model.
-* More control over backpressure.
-
-Design decisions:
-
-* 1 log-shuttle per logplex token disables noisy neighbors.
-* Many logplex tokens on 1 log-shuttle is possible but dangerous.
-* Fail fast and contain failure inside the log-shuttle process.
-
-## Usage
-
-### Install
-
-```bash
-# Assuming Go1.
-$ go get github.com/ryandotsmith/log-shuttle
-$ cd $GOPATH/src/github.com/ryandotsmith/log-shuttle
-$ go build
-```
-
-### Set `LOGPLEX_URL`
-
-```bash
-$ export LOGPLEX_URL=https://logplex.com
-$ # or with basic auth creds which will be used for HTTP requests:
-$ export LOGPLEX_URL=https://user:password@logplex.com
-```
-
-### Connect Via UNIX Socket
-
-```bash
-$ ./log-shuttle -logplex-token="123" -socket="/tmp/log-shuttle"
-$ echo 'hi world' | nc -U /tmp/log-shuttle
-```
-
-### Connect Via STDOUT
-
-```bash
-$ echo 'hi world' | ./log-shuttle -logplex-token="123" -procid="demo" -batch-size=1
-```
-
-### Flags
-
-Run the following command for available flags: `$ log-shuttle -h`
-
-#### -logplex-token
-
-log-shuttle uses this flag's value to inflate each log's headers with the token, which serves as an identifier of the source of the log message. If the `LOGPLEX_URL` does not contain a username or password, this value is also used as the HTTP Basic Auth password.
-
-#### -skip-headers
-
-There are certain cases in which you would not want log-shuttle to prepend log messages with the rfc5424 approved headers. By using the `skip-headers` flag, log-shuttle will not prepend headers before submitting the logs to logplex. If you are skipping headers, please ensure that you have the logplex token included in the headers.
-
-#### -front-buff
-
-The front buffer holds lines while the backend sends them to logplex. If log-shuttle receives large amounts of data with a small front-buff, log-shuttle will drop data. The number of dropped lines will be visible in log-shuttle's STDOUT.
-
-#### -wait
-
-The backend routine that delivers log lines to logplex will execute if the front-buff is full or on a timed schedule --whichever occurs first. The timer is configurable by the wait flag.
-
-#### -batch-size
-
-The batch-size determines how many rfc5424 formatted log-lines to pack into an HTTP request.
-
-### l2met
-
-[l2met](https://github.com/ryandotsmith/l2met) is a service that will convert log lines into librato metrics. You can point log-shuttle at an l2met service for maximum log leverage. Just set LOGPLEX_URL to your l2met drain URL.
-
-## Hacking on log-shuttle
-
-* Keep changes in a feature branch
-* Submit PR
-* Update `logShuttleVersion` in main.go
-* Update `VERSION` in Makefile
-* Add entry in CHANGELOG
-* git tag -a vX.Y.Z -m 'vX.Y.Z had this change' HEAD
-
-## License
-
-Copyright (c) 2012 Ryan R. Smith
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The canonical repository has moved to https://github.com/heroku/log-shuttle.