From 28c29da1662f389f508ddcff4f58c4d4400a35fd Mon Sep 17 00:00:00 2001 From: Mriyam Tamuli Date: Sat, 8 Oct 2016 04:01:46 +0530 Subject: [PATCH] Document the logs plugin --- docs/deployment/logs.md | 38 ++++++++++++++++++++++++++++++++++++++ docs/template.html | 1 + 2 files changed, 39 insertions(+) create mode 100644 docs/deployment/logs.md diff --git a/docs/deployment/logs.md b/docs/deployment/logs.md new file mode 100644 index 000000000..9be0352f8 --- /dev/null +++ b/docs/deployment/logs.md @@ -0,0 +1,38 @@ +# Log Management + +``` +logs # display recent log output +``` + +## Usage + +### Application Logs +You can easily get logs of an application using the `logs` command: + +```shell +dokku logs node-js-app +``` + +## Behavioral modifiers + +Dokku also supports certain command-line arguments that augment the `log` command's behavior. + +``` +-n, --num NUM # the number of lines to display +-p, --ps PS # only display logs from the given process +-t, --tail # continually stream logs +-q, --quiet # display raw logs without colors, time and names +``` + +You can use these modifiers as + +```shell +dokku logs +``` + +For example, + +```shell +dokku logs node-js-app -t -p web +``` +will show logs continually from the web process. diff --git a/docs/template.html b/docs/template.html index 723aa640f..7c69c23c8 100644 --- a/docs/template.html +++ b/docs/template.html @@ -198,6 +198,7 @@ Deploying an Application Application Management + Application Logs Remote Commands One Off Processes/Cron Process Scaling