From 3e6bcedb51b8c454cbe64283a392f24355b145f0 Mon Sep 17 00:00:00 2001 From: Alessio Treglia Date: Fri, 3 Jul 2015 11:52:12 +0100 Subject: [PATCH 1/6] Update plugins.md Move dokku-events from the "Dokku Features" stanza to the "Deprecated Plugins" one as it's now part of the core set of components. --- docs/plugins.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/plugins.md b/docs/plugins.md index 93e4dfd91..9421a7214 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -156,7 +156,6 @@ Note: The following plugins have been supplied by our community and may not have | [Docker Direct](https://github.com/heichblatt/dokku-docker-direct) | [heichblatt][] | | | [Dokku Name](https://github.com/alex-sherwin/dokku-name) | [alex-sherwin][] | dokku >= [c77cbf1][] | | [Dokku Registry](https://github.com/agco-adm/dokku-registry)1 | [agco-adm][] | | -| [Events Logger](https://github.com/alessio/dokku-events) | [alessio][] | dokku >= v0.3.13 | | [git rev-parse HEAD in env](https://github.com/cjblomqvist/dokku-git-rev) | [cjblomqvist][] | Compatible with 0.3.0 | | [Graduate (Environment Management)](https://github.com/glassechidna/dokku-graduate) | [Benjamin-Dobell][] | dokku >= v0.3.14 | | [HTTP Auth Secure Apps](https://github.com/matto1990/dokku-secure-apps) | [matto1990][] | Works with v0.2.3 | @@ -225,6 +224,8 @@ The following plugins have been removed as their functionality is now in Dokku C | [Supply env vars to buildpacks](https://github.com/cameron-martin/dokku-build-env)2 | [cameron-martin][] | v0.3.9 (build-env plugin) | | [user-env-compile](https://github.com/musicglue/dokku-user-env-compile)2 | [musicglue][] | v0.3.9 (build-env plugin) | | [user-env-compile](https://github.com/motin/dokku-user-env-compile)2 | [motin][] | v0.3.9 (build-env plugin) | +| [Events Logger](https://github.com/alessio/dokku-events) | [alessio][] | v0.3.21 (events plugin) | + 1 Conflicts with [VHOSTS Custom Configuration](https://github.com/neam/dokku-nginx-vhosts-custom-configuration) 2 Similar to the heroku-labs feature (see https://devcenter.heroku.com/articles/labs-user-env-compile) From 601d85f8e6655c66d88bc4613c4706c64388b7bd Mon Sep 17 00:00:00 2001 From: Alessio Treglia Date: Fri, 3 Jul 2015 12:07:38 +0100 Subject: [PATCH 2/6] Create logging.md Needless to say, this need review. --- docs/logging.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 docs/logging.md diff --git a/docs/logging.md b/docs/logging.md new file mode 100644 index 000000000..102b06a9b --- /dev/null +++ b/docs/logging.md @@ -0,0 +1,14 @@ +# 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 +``` + +## System logs + +The _events_ plugin writes log entries to ``/var/log/syslog`` as well as a Dokku-specific logs sub-directory ``/var/log/dokku/events.log``. From 8acb596fed9982a023b43be3f697719a56a6aaf4 Mon Sep 17 00:00:00 2001 From: Alessio Treglia Date: Fri, 3 Jul 2015 12:09:45 +0100 Subject: [PATCH 3/6] Update index.md Add logging.md reference. --- docs/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/index.md b/docs/index.md index 0b2dd82d3..1c49b8b3d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,6 +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) +- [Server logs] (http://progrium.viewdocs.io/dokku/logging) ### Community Contributions From 934cddbcda7207f2f24350e890b9be84dcaff67a Mon Sep 17 00:00:00 2001 From: Alessio Treglia Date: Fri, 3 Jul 2015 16:43:12 +0100 Subject: [PATCH 4/6] Fix potential ambiguity --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 1c49b8b3d..5f659d390 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) -- [Server logs] (http://progrium.viewdocs.io/dokku/logging) +- [Dokku events logs] (http://progrium.viewdocs.io/dokku/logging) ### Community Contributions From f1fda75e3d2b105dac5df2e50d54c81ec080a537 Mon Sep 17 00:00:00 2001 From: Alessio Treglia Date: Fri, 3 Jul 2015 17:16:48 +0100 Subject: [PATCH 5/6] Extend events docs --- docs/logging.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 63 insertions(+), 2 deletions(-) diff --git a/docs/logging.md b/docs/logging.md index 102b06a9b..f5e509f7a 100644 --- a/docs/logging.md +++ b/docs/logging.md @@ -9,6 +9,67 @@ events:on Enable events logger events:off Disable events logger ``` -## System logs +## Usage -The _events_ plugin writes log entries to ``/var/log/syslog`` as well as a Dokku-specific logs sub-directory ``/var/log/dokku/events.log``. +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 +``` From 76e718df56bbd7999c6f6de13c114251badc6c5a Mon Sep 17 00:00:00 2001 From: Alessio Treglia Date: Fri, 3 Jul 2015 17:18:15 +0100 Subject: [PATCH 6/6] Cosmetic fix --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 5f659d390..d037e60c3 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 Events logs] (http://progrium.viewdocs.io/dokku/logging) ### Community Contributions