From 7ceac5787bf838869a629ff3edc56e598bec3f68 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Fri, 3 Jul 2015 13:06:43 -0400 Subject: [PATCH] Minor fixes to the logging docs [ci skip] --- docs/dokku-event-logs.md | 73 ++++++++++++++++++++++++++++++++++++++ docs/index.md | 2 +- docs/logging.md | 75 ---------------------------------------- 3 files changed, 74 insertions(+), 76 deletions(-) create mode 100644 docs/dokku-event-logs.md delete mode 100644 docs/logging.md diff --git a/docs/dokku-event-logs.md b/docs/dokku-event-logs.md new file mode 100644 index 000000000..8ff961adb --- /dev/null +++ b/docs/dokku-event-logs.md @@ -0,0 +1,73 @@ +# Dokku Event Logs + +Docker provides an _events_ command to show system's real time events. Likewise, Dokku can record events as syslog entries and also provides a plugin to display the last ones. + +``` +events [-t] Show the last events (-t follows) +events:list List logged events +events:on Enable events logger +events:off Disable events logger +``` + +## Usage + +Enable the plugin: + +``` +$ dokku events:on +Enabling dokku events logger +``` + +Dokku will then write log entries to ``/var/log/syslog`` as well as a Dokku-specific logs sub-directory ``/var/log/dokku/events.log``, which can be easily displayed with the command `dokku events`: + +``` +Jul 3 16:09:48 dokku.me dokku[127630]: INVOKED: pre-release-buildstep( pythonapp ) +Jul 3 16:10:02 dokku.me dokku[128095]: INVOKED: docker-args-run( rubyapp ) +Jul 3 16:10:02 dokku.me dokku[128114]: INVOKED: docker-args-run( nhl ) +Jul 3 16:10:03 dokku.me dokku[128136]: INVOKED: post-release-buildstep( pythonapp ) +Jul 3 16:10:03 dokku.me dokku[128195]: INVOKED: pre-deploy( pythonapp ) +Jul 3 16:10:23 dokku.me dokku[129253]: INVOKED: docker-args-deploy( pythonapp ) +Jul 3 16:10:24 dokku.me dokku[129337]: INVOKED: bind-external-ip( pythonapp ) +Jul 3 16:10:24 dokku.me dokku[129451]: INVOKED: check-deploy( pythonapp 6274ced0d4be11af4490cd18abaf77cdd593f025133f403d984e80d86a39acec web 5000 10.0.16.80 ) +Jul 3 16:10:35 dokku.me dokku[129561]: INVOKED: docker-args-deploy( pythonapp ) +Jul 3 16:10:35 dokku.me dokku[129649]: INVOKED: bind-external-ip( pythonapp ) +Jul 3 16:10:36 dokku.me dokku[129760]: INVOKED: check-deploy( pythonapp ac88a56ee4161ff37e4b92d1498c3eadc91f0aa7c8b81b44fc077e2a51d54cc0 worker ) +Jul 3 16:10:46 dokku.me dokku[129851]: INVOKED: post-deploy( pythonapp ) +Jul 3 16:10:46 dokku.me dokku[129945]: INVOKED: nginx-pre-reload( pythonapp ) +Jul 3 16:15:02 dokku.me dokku[130397]: INVOKED: docker-args-run( goapp ) +Jul 3 16:21:02 dokku.me dokku[130796]: INVOKED: docker-args-run( rubyapp ) +Jul 3 16:30:02 dokku.me dokku[131384]: INVOKED: docker-args-run( rubyapp ) +``` + +You can list all events that are currently being recorded via `dokku events:list`: +``` +=====> Events currently logged +backup-check +docker-args-build +pre-delete +post-deploy +receive-app +pre-release-buildstep +nginx-pre-reload +docker-args-deploy +post-build-buildstep +post-domains-update +post-release-dockerfile +check-deploy +backup-import +backup-export +git-pre-pull +git-post-pull +nginx-hostname +bind-external-ip +pre-deploy +post-delete +dependencies +pre-build-buildstep +docker-args-run +pre-build-dockerfile +post-release-buildstep +post-build-dockerfile +pre-release-dockerfile +update +``` diff --git a/docs/index.md b/docs/index.md index d037e60c3..8ecec63ef 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,7 +18,7 @@ Docker powered mini-Heroku. The smallest PaaS implementation you've ever seen. - [Nginx Configuration](http://progrium.viewdocs.io/dokku/nginx) - [Running Remote commands](http://progrium.viewdocs.io/dokku/remote-commands) - [Container Options](http://progrium.viewdocs.io/dokku/docker-options) -- [Dokku Events logs] (http://progrium.viewdocs.io/dokku/logging) +- [Dokku Event Logs](http://progrium.viewdocs.io/dokku/dokku-events-logs) ### Community Contributions diff --git a/docs/logging.md b/docs/logging.md deleted file mode 100644 index f5e509f7a..000000000 --- a/docs/logging.md +++ /dev/null @@ -1,75 +0,0 @@ -# Events - -Docker provides an _events_ command to show system's real time events. Likewise, Dokku can record events as syslog entries and also provides a plugin to display the last ones. - -``` -events [-t] Show the last events (-t follows) -events:list List logged events -events:on Enable events logger -events:off Disable events logger -``` - -## Usage - -Enable the plugin: - -``` -$ dokku events:on -Enabling dokku events logger -``` - -It writes log entries to ``/var/log/syslog`` as well as a Dokku-specific logs sub-directory ``/var/log/dokku/events.log``, which can be easily displayed: - -``` -$ dokku events -Jul 3 16:09:48 dokku.me dokku[127630]: INVOKED: pre-release-buildstep( pythonapp ) -Jul 3 16:10:02 dokku.me dokku[128095]: INVOKED: docker-args-run( rubyapp ) -Jul 3 16:10:02 dokku.me dokku[128114]: INVOKED: docker-args-run( nhl ) -Jul 3 16:10:03 dokku.me dokku[128136]: INVOKED: post-release-buildstep( pythonapp ) -Jul 3 16:10:03 dokku.me dokku[128195]: INVOKED: pre-deploy( pythonapp ) -Jul 3 16:10:23 dokku.me dokku[129253]: INVOKED: docker-args-deploy( pythonapp ) -Jul 3 16:10:24 dokku.me dokku[129337]: INVOKED: bind-external-ip( pythonapp ) -Jul 3 16:10:24 dokku.me dokku[129451]: INVOKED: check-deploy( pythonapp 6274ced0d4be11af4490cd18abaf77cdd593f025133f403d984e80d86a39acec web 5000 10.0.16.80 ) -Jul 3 16:10:35 dokku.me dokku[129561]: INVOKED: docker-args-deploy( pythonapp ) -Jul 3 16:10:35 dokku.me dokku[129649]: INVOKED: bind-external-ip( pythonapp ) -Jul 3 16:10:36 dokku.me dokku[129760]: INVOKED: check-deploy( pythonapp ac88a56ee4161ff37e4b92d1498c3eadc91f0aa7c8b81b44fc077e2a51d54cc0 worker ) -Jul 3 16:10:46 dokku.me dokku[129851]: INVOKED: post-deploy( pythonapp ) -Jul 3 16:10:46 dokku.me dokku[129945]: INVOKED: nginx-pre-reload( pythonapp ) -Jul 3 16:15:02 dokku.me dokku[130397]: INVOKED: docker-args-run( goapp ) -Jul 3 16:21:02 dokku.me dokku[130796]: INVOKED: docker-args-run( rubyapp ) -Jul 3 16:30:02 dokku.me dokku[131384]: INVOKED: docker-args-run( rubyapp ) -``` - -List all events that are currently being recored: -``` -& dokku events:list -=====> Events currently logged -backup-check -docker-args-build -pre-delete -post-deploy -receive-app -pre-release-buildstep -nginx-pre-reload -docker-args-deploy -post-build-buildstep -post-domains-update -post-release-dockerfile -check-deploy -backup-import -backup-export -git-pre-pull -git-post-pull -nginx-hostname -bind-external-ip -pre-deploy -post-delete -dependencies -pre-build-buildstep -docker-args-run -pre-build-dockerfile -post-release-buildstep -post-build-dockerfile -pre-release-dockerfile -update -```