Merge pull request #1256 from alessio/pr-dokku-events
Implement events logging feature
This commit is contained in:
commit
2698ce62e2
34 files changed
+196
No files matched your search
@@ -10,6 +10,9 @@ export PLUGIN_PATH=${PLUGIN_PATH:="/var/lib/dokku/plugins"}
|
|||||||
export DOKKU_NOT_IMPLEMENTED_EXIT=10
|
export DOKKU_NOT_IMPLEMENTED_EXIT=10
|
||||||
export DOKKU_VALID_EXIT=0
|
export DOKKU_VALID_EXIT=0
|
||||||
|
|
||||||
|
export DOKKU_LOGS_DIR=${DOKKU_LOGS_DIR:="/var/log/dokku"}
|
||||||
|
export DOKKU_EVENTS_LOGFILE=${DOKKU_EVENTS_LOGFILE:="$DOKKU_LOGS_DIR/events.log"}
|
||||||
|
|
||||||
source "$PLUGIN_PATH/common/functions"
|
source "$PLUGIN_PATH/common/functions"
|
||||||
|
|
||||||
[[ -f $DOKKU_ROOT/dokkurc ]] && source $DOKKU_ROOT/dokkurc
|
[[ -f $DOKKU_ROOT/dokkurc ]] && source $DOKKU_ROOT/dokkurc
|
||||||
|
|||||||
Symlink
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
Symlink
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
Symlink
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
Symlink
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
Executable
+55
@@ -0,0 +1,55 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
||||||
|
source "$(dirname $0)/../common/functions"
|
||||||
|
|
||||||
|
PLUGIN_DIR="$(dirname $0)"
|
||||||
|
|
||||||
|
case "$1" in
|
||||||
|
events)
|
||||||
|
if [[ -f $DOKKU_EVENTS_LOGFILE ]] ; then
|
||||||
|
if [[ $2 == "-t" ]]; then
|
||||||
|
tail -f $DOKKU_EVENTS_LOGFILE
|
||||||
|
else
|
||||||
|
tail -n 100 $DOKKU_EVENTS_LOGFILE
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
;;
|
||||||
|
|
||||||
|
events:on)
|
||||||
|
echo "Enabling dokku events logger"
|
||||||
|
[[ -d $DOKKU_ROOT/.dokkurc ]] || mkdir -p $DOKKU_ROOT/.dokkurc
|
||||||
|
echo "export DOKKU_EVENTS=1" > $DOKKU_ROOT/.dokkurc/DOKKU_EVENTS
|
||||||
|
;;
|
||||||
|
|
||||||
|
events:off)
|
||||||
|
echo "Disabling dokku events logger"
|
||||||
|
rm -f $DOKKU_ROOT/.dokkurc/DOKKU_EVENTS
|
||||||
|
;;
|
||||||
|
|
||||||
|
events:list)
|
||||||
|
if [[ "$DOKKU_EVENTS" ]]; then
|
||||||
|
logged="$(find $PLUGIN_DIR -type l -printf '%f ' | sort)"
|
||||||
|
dokku_col_log_info2_quiet "Events currently logged"
|
||||||
|
for hook in $logged ; do
|
||||||
|
dokku_col_log_msg "$hook"
|
||||||
|
done
|
||||||
|
else
|
||||||
|
dokku_log_warn "Events logger disabled"
|
||||||
|
fi
|
||||||
|
;;
|
||||||
|
|
||||||
|
help | events:help)
|
||||||
|
cat && cat<<EOF
|
||||||
|
events [-t] Show the last events (-t follows)
|
||||||
|
events:list List logged events
|
||||||
|
events:on Enable events logger
|
||||||
|
events:off Disable events logger
|
||||||
|
EOF
|
||||||
|
;;
|
||||||
|
|
||||||
|
*)
|
||||||
|
exit $DOKKU_NOT_IMPLEMENTED_EXIT
|
||||||
|
;;
|
||||||
|
|
||||||
|
esac
|
||||||
|
|
||||||
Symlink
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
Symlink
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
Symlink
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
Executable
+5
@@ -0,0 +1,5 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
||||||
|
source "$(dirname $0)/../common/functions"
|
||||||
|
|
||||||
|
[[ ! "$DOKKU_EVENTS" ]] || dokku_log_pluginhook_call "$(basename $0)" "$@"
|
||||||
Executable
+54
@@ -0,0 +1,54 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
|
||||||
|
source "$(dirname $0)/../common/functions"
|
||||||
|
|
||||||
|
DOKKU_RSYSLOG_FILTER=/etc/rsyslog.d/99-dokku.conf
|
||||||
|
DOKKU_LOGROTATE_FILE=/etc/logrotate.d/dokku
|
||||||
|
|
||||||
|
flag_rsyslog_needs_restart=n
|
||||||
|
|
||||||
|
# This can be done unconditionally as mkdir -p
|
||||||
|
# exits gracefully if the path already exists
|
||||||
|
mkdir -m 775 -p "$DOKKU_LOGS_DIR"
|
||||||
|
chown syslog:dokku "$DOKKU_LOGS_DIR"
|
||||||
|
|
||||||
|
if [[ ! -f "$DOKKU_EVENTS_LOGFILE" ]]; then
|
||||||
|
touch "$DOKKU_EVENTS_LOGFILE"
|
||||||
|
# chown syslog:root might not work on SUSE
|
||||||
|
chown syslog:dokku "$DOKKU_EVENTS_LOGFILE"
|
||||||
|
chmod 664 "$DOKKU_EVENTS_LOGFILE"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ ! -f "$DOKKU_RSYSLOG_FILTER" ]]; then
|
||||||
|
cat >"$DOKKU_RSYSLOG_FILTER" <<EOF
|
||||||
|
:syslogtag, contains, "dokku" $DOKKU_EVENTS_LOGFILE
|
||||||
|
EOF
|
||||||
|
flag_rsyslog_needs_restart=y
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ ! -f "$DOKKU_LOGROTATE_FILE" ]]; then
|
||||||
|
cat >"$DOKKU_LOGROTATE_FILE" <<EOF
|
||||||
|
$DOKKU_LOGS_DIR/*.log {
|
||||||
|
daily
|
||||||
|
rotate 7
|
||||||
|
missingok
|
||||||
|
notifempty
|
||||||
|
su syslog dokku
|
||||||
|
compress
|
||||||
|
delaycompress
|
||||||
|
postrotate
|
||||||
|
reload rsyslog >/dev/null 2>&1 || true
|
||||||
|
endscript
|
||||||
|
create 664 syslog dokku
|
||||||
|
}
|
||||||
|
EOF
|
||||||
|
flag_rsyslog_needs_restart=y
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ "$flag_rsyslog_needs_restart" == "y" ]]; then
|
||||||
|
service rsyslog restart
|
||||||
|
fi
|
||||||
|
|
||||||
|
[[ ! "$DOKKU_EVENTS" ]] || dokku_log_pluginhook_call "$(basename $0)" "$@"
|
||||||
|
|
||||||
|
exit 0
|
||||||
Symlink
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
Symlink
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
Symlink
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
Symlink
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
Symlink
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
Symlink
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
Symlink
+1
@@ -0,0 +1 @@
|
|||||||
|
hook
|
||||||
@@ -90,6 +90,17 @@ dokku_log_fail() {
|
|||||||
exit 1
|
exit 1
|
||||||
}
|
}
|
||||||
|
|
||||||
|
dokku_log_event() {
|
||||||
|
logger -t dokku -i -- "$@"
|
||||||
|
}
|
||||||
|
|
||||||
|
dokku_log_pluginhook_call() {
|
||||||
|
local l_hook
|
||||||
|
|
||||||
|
l_hook="$1" ; shift
|
||||||
|
dokku_log_event "INVOKED: ${l_hook}( $@ )"
|
||||||
|
}
|
||||||
|
|
||||||
dokku_container_log_verbose_quiet() {
|
dokku_container_log_verbose_quiet() {
|
||||||
CID=$1;
|
CID=$1;
|
||||||
shift
|
shift
|
||||||
|
|||||||
@@ -0,0 +1,40 @@
|
|||||||
|
#!/usr/bin/env bats
|
||||||
|
|
||||||
|
load test_helper
|
||||||
|
|
||||||
|
setup() {
|
||||||
|
create_app
|
||||||
|
}
|
||||||
|
|
||||||
|
teardown() {
|
||||||
|
destroy_app
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "(events) check conffiles" {
|
||||||
|
run bash -c "test -f /etc/logrotate.d/dokku"
|
||||||
|
echo "output: "$output
|
||||||
|
echo "status: "$status
|
||||||
|
assert_success
|
||||||
|
run bash -c "test -f /etc/rsyslog.d/99-dokku.conf"
|
||||||
|
echo "output: "$output
|
||||||
|
echo "status: "$status
|
||||||
|
assert_success
|
||||||
|
run bash -c "stat -c '%U:%G:%a' /var/log/dokku/"
|
||||||
|
echo "output: "$output
|
||||||
|
echo "status: "$status
|
||||||
|
assert_output "syslog:dokku:775"
|
||||||
|
run bash -c "stat -c '%U:%G:%a' /var/log/dokku/events.log"
|
||||||
|
echo "output: "$output
|
||||||
|
echo "status: "$status
|
||||||
|
assert_output "syslog:dokku:664"
|
||||||
|
}
|
||||||
|
|
||||||
|
@test "(events) log commands" {
|
||||||
|
run dokku events:on
|
||||||
|
deploy_app
|
||||||
|
run dokku events
|
||||||
|
echo "output: "$output
|
||||||
|
echo "status: "$status
|
||||||
|
assert_success
|
||||||
|
run dokku events:off
|
||||||
|
}
|
||||||
Reference in new issue
Block a user