refactor: use log:set for logs and add global support
This commit is contained in:
1 parent
6eb0bd8c87
commit
afe1e8b33c
11 files changed
+212
-26
No files matched your search
@@ -2,6 +2,7 @@
|
|||||||
/subcommands/*
|
/subcommands/*
|
||||||
/triggers/*
|
/triggers/*
|
||||||
/triggers
|
/triggers
|
||||||
|
/docker-args-process-deploy
|
||||||
/install
|
/install
|
||||||
/post-*
|
/post-*
|
||||||
/report
|
/report
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
SUBCOMMANDS = subcommands/failed subcommands/report subcommands/set subcommands/vector-logs subcommands/vector-start subcommands/vector-stop
|
SUBCOMMANDS = subcommands/failed subcommands/report subcommands/set subcommands/vector-logs subcommands/vector-start subcommands/vector-stop
|
||||||
TRIGGERS = triggers/install triggers/post-delete triggers/report
|
TRIGGERS = triggers/docker-args-process-deploy triggers/install triggers/post-delete triggers/report
|
||||||
BUILD = commands subcommands triggers
|
BUILD = commands subcommands triggers
|
||||||
PLUGIN_NAME = logs
|
PLUGIN_NAME = logs
|
||||||
|
|
||||||
|
|||||||
@@ -6,14 +6,18 @@ import (
|
|||||||
"github.com/dokku/dokku/plugins/common"
|
"github.com/dokku/dokku/plugins/common"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const MaxSize = "10m"
|
||||||
|
|
||||||
var (
|
var (
|
||||||
// DefaultProperties is a map of all valid ps properties with corresponding default property values
|
// DefaultProperties is a map of all valid ps properties with corresponding default property values
|
||||||
DefaultProperties = map[string]string{
|
DefaultProperties = map[string]string{
|
||||||
|
"max-size": "",
|
||||||
"vector-sink": "",
|
"vector-sink": "",
|
||||||
}
|
}
|
||||||
|
|
||||||
// GlobalProperties is a map of all valid global logs properties
|
// GlobalProperties is a map of all valid global logs properties
|
||||||
GlobalProperties = map[string]bool{
|
GlobalProperties = map[string]bool{
|
||||||
|
"max-size": true,
|
||||||
"vector-sink": true,
|
"vector-sink": true,
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|||||||
+23
-3
@@ -11,8 +11,11 @@ func ReportSingleApp(appName, infoFlag string) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
flags := map[string]common.ReportFunc{
|
flags := map[string]common.ReportFunc{
|
||||||
"--logs-vector-sink": reportVectorSink,
|
"--logs-computed-max-size": reportComputedMaxSize,
|
||||||
|
"--logs-global-max-size": reportGlobalMaxSize,
|
||||||
"--logs-global-vector-sink": reportGlobalVectorSink,
|
"--logs-global-vector-sink": reportGlobalVectorSink,
|
||||||
|
"--logs-max-size": reportMaxSize,
|
||||||
|
"--logs-vector-sink": reportVectorSink,
|
||||||
}
|
}
|
||||||
|
|
||||||
flagKeys := []string{}
|
flagKeys := []string{}
|
||||||
@@ -26,10 +29,27 @@ func ReportSingleApp(appName, infoFlag string) error {
|
|||||||
return common.ReportSingleApp("logs", appName, infoFlag, infoFlags, flagKeys, trimPrefix, uppercaseFirstCharacter)
|
return common.ReportSingleApp("logs", appName, infoFlag, infoFlags, flagKeys, trimPrefix, uppercaseFirstCharacter)
|
||||||
}
|
}
|
||||||
|
|
||||||
func reportVectorSink(appName string) string {
|
func reportComputedMaxSize(appName string) string {
|
||||||
return common.PropertyGet("logs", appName, "vector-sink")
|
value := reportMaxSize(appName)
|
||||||
|
if value == "" {
|
||||||
|
value = reportGlobalMaxSize(appName)
|
||||||
|
}
|
||||||
|
|
||||||
|
return value
|
||||||
|
}
|
||||||
|
|
||||||
|
func reportGlobalMaxSize(appName string) string {
|
||||||
|
return common.PropertyGetDefault("logs", "--global", "max-size", MaxSize)
|
||||||
}
|
}
|
||||||
|
|
||||||
func reportGlobalVectorSink(appName string) string {
|
func reportGlobalVectorSink(appName string) string {
|
||||||
return common.PropertyGet("logs", "--global", "vector-sink")
|
return common.PropertyGet("logs", "--global", "vector-sink")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func reportMaxSize(appName string) string {
|
||||||
|
return common.PropertyGet("logs", appName, "max-size")
|
||||||
|
}
|
||||||
|
|
||||||
|
func reportVectorSink(appName string) string {
|
||||||
|
return common.PropertyGet("logs", appName, "vector-sink")
|
||||||
|
}
|
||||||
@@ -0,0 +1,58 @@
|
|||||||
|
package logs
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"strconv"
|
||||||
|
)
|
||||||
|
|
||||||
|
func validateSetValue(appName string, key string, value string) error {
|
||||||
|
if key == "max-size" {
|
||||||
|
return validateMaxSize(appName, value)
|
||||||
|
}
|
||||||
|
|
||||||
|
if key == "vector-sink" {
|
||||||
|
return validateVectorSink(appName, value)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func validateMaxSize(appName string, value string) error {
|
||||||
|
if value == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if value == "unlimited" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
last := value[len(value)-1:]
|
||||||
|
if last != "k" && last != "m" && last != "g" {
|
||||||
|
return errors.New("Invalid max-size unit measure, value must end in any of [k, m, g]")
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(value) < 2 {
|
||||||
|
return errors.New("Invalid max-size value, must be a number followed by a unit of measure [k, m, d]")
|
||||||
|
}
|
||||||
|
|
||||||
|
number := value[:len(value)-1]
|
||||||
|
if _, err := strconv.Atoi(number); err != nil {
|
||||||
|
return fmt.Errorf("Invalid max-size value, unable to convert number to int: %s", err.Error())
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func validateVectorSink(appName string, value string) error {
|
||||||
|
if value == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err := valueToConfig(appName, value)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -35,6 +35,7 @@ func main() {
|
|||||||
case "set":
|
case "set":
|
||||||
args := flag.NewFlagSet("logs:set", flag.ExitOnError)
|
args := flag.NewFlagSet("logs:set", flag.ExitOnError)
|
||||||
global := args.Bool("global", false, "--global: set a global property")
|
global := args.Bool("global", false, "--global: set a global property")
|
||||||
|
valueOverride := args.Bool("1", false, "-1: negative value (for max-size)")
|
||||||
args.Parse(os.Args[2:])
|
args.Parse(os.Args[2:])
|
||||||
appName := args.Arg(0)
|
appName := args.Arg(0)
|
||||||
property := args.Arg(1)
|
property := args.Arg(1)
|
||||||
@@ -44,6 +45,11 @@ func main() {
|
|||||||
property = args.Arg(0)
|
property = args.Arg(0)
|
||||||
value = args.Arg(1)
|
value = args.Arg(1)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if *valueOverride {
|
||||||
|
value = "-1"
|
||||||
|
}
|
||||||
|
|
||||||
err = logs.CommandSet(appName, property, value)
|
err = logs.CommandSet(appName, property, value)
|
||||||
case "vector-logs":
|
case "vector-logs":
|
||||||
args := flag.NewFlagSet("logs:vector-logs", flag.ExitOnError)
|
args := flag.NewFlagSet("logs:vector-logs", flag.ExitOnError)
|
||||||
|
|||||||
@@ -18,6 +18,9 @@ func main() {
|
|||||||
|
|
||||||
var err error
|
var err error
|
||||||
switch trigger {
|
switch trigger {
|
||||||
|
case "docker-args-process-deploy":
|
||||||
|
appName := flag.Arg(0)
|
||||||
|
err = logs.TriggerDockerArgsProcessDeploy(appName)
|
||||||
case "install":
|
case "install":
|
||||||
err = logs.TriggerInstall()
|
err = logs.TriggerInstall()
|
||||||
case "post-delete":
|
case "post-delete":
|
||||||
|
|||||||
@@ -69,11 +69,8 @@ func CommandReport(appName string, infoFlag string) error {
|
|||||||
|
|
||||||
// CommandSet sets or clears a logs property for an app
|
// CommandSet sets or clears a logs property for an app
|
||||||
func CommandSet(appName string, property string, value string) error {
|
func CommandSet(appName string, property string, value string) error {
|
||||||
if property == "vector-sink" && value != "" {
|
if err := validateSetValue(appName, property, value); err != nil {
|
||||||
_, err := valueToConfig(appName, value)
|
return err
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
common.CommandPropertySet("logs", appName, property, value, DefaultProperties, GlobalProperties)
|
common.CommandPropertySet("logs", appName, property, value, DefaultProperties, GlobalProperties)
|
||||||
|
|||||||
@@ -2,12 +2,33 @@ package logs
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"io/ioutil"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
|
||||||
"github.com/dokku/dokku/plugins/common"
|
"github.com/dokku/dokku/plugins/common"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// TriggerDockerArgsProcessDeploy outputs the logs plugin docker options for an app
|
||||||
|
func TriggerDockerArgsProcessDeploy(appName string) error {
|
||||||
|
stdin, err := ioutil.ReadAll(os.Stdin)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
maxSize := common.PropertyGet("logs", appName, "max-size")
|
||||||
|
if maxSize == "" {
|
||||||
|
maxSize = common.PropertyGetDefault("logs", "--global", "max-size", MaxSize)
|
||||||
|
}
|
||||||
|
|
||||||
|
if maxSize != "unlimited" {
|
||||||
|
fmt.Printf(" --log-opt max-size=%s ", maxSize)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Print(string(stdin))
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// TriggerInstall initializes app restart policies
|
// TriggerInstall initializes app restart policies
|
||||||
func TriggerInstall() error {
|
func TriggerInstall() error {
|
||||||
if err := common.PropertySetup("logs"); err != nil {
|
if err := common.PropertySetup("logs"); err != nil {
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ trigger-scheduler-docker-local-install() {
|
|||||||
declare desc="scheduler-docker-local install plugin trigger"
|
declare desc="scheduler-docker-local install plugin trigger"
|
||||||
declare trigger="install"
|
declare trigger="install"
|
||||||
local DOKKU_PATH
|
local DOKKU_PATH
|
||||||
DOKKU_LOGROTATE_FILE=/etc/logrotate.d/docker
|
|
||||||
|
|
||||||
mkdir -p "${DOKKU_LIB_ROOT}/data/scheduler-docker-local"
|
mkdir -p "${DOKKU_LIB_ROOT}/data/scheduler-docker-local"
|
||||||
chown -R "${DOKKU_SYSTEM_USER}:${DOKKU_SYSTEM_GROUP}" "${DOKKU_LIB_ROOT}/data/scheduler-docker-local"
|
chown -R "${DOKKU_SYSTEM_USER}:${DOKKU_SYSTEM_GROUP}" "${DOKKU_LIB_ROOT}/data/scheduler-docker-local"
|
||||||
@@ -17,20 +16,6 @@ trigger-scheduler-docker-local-install() {
|
|||||||
|
|
||||||
DOKKU_PATH="$(which dokku)"
|
DOKKU_PATH="$(which dokku)"
|
||||||
|
|
||||||
if [[ ! -f "$DOKKU_LOGROTATE_FILE" ]]; then
|
|
||||||
cat >"$DOKKU_LOGROTATE_FILE" <<EOF
|
|
||||||
/var/lib/docker/containers/*/*.log {
|
|
||||||
rotate 7
|
|
||||||
daily
|
|
||||||
compress
|
|
||||||
size=100M
|
|
||||||
missingok
|
|
||||||
delaycompress
|
|
||||||
copytruncate
|
|
||||||
}
|
|
||||||
EOF
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [[ $(systemctl 2>/dev/null) =~ -\.mount ]]; then
|
if [[ $(systemctl 2>/dev/null) =~ -\.mount ]]; then
|
||||||
cat <<EOF >/etc/systemd/system/dokku-retire.service
|
cat <<EOF >/etc/systemd/system/dokku-retire.service
|
||||||
[Unit]
|
[Unit]
|
||||||
|
|||||||
+93
-2
@@ -98,13 +98,13 @@ teardown() {
|
|||||||
echo "output: $output"
|
echo "output: $output"
|
||||||
echo "status: $status"
|
echo "status: $status"
|
||||||
assert_failure
|
assert_failure
|
||||||
assert_output_contains "Invalid property specified, valid properties include: vector-sink"
|
assert_output_contains "Invalid property specified, valid properties include: max-size, vector-sink"
|
||||||
|
|
||||||
run /bin/bash -c "dokku logs:set $TEST_APP invalid value" 2>&1
|
run /bin/bash -c "dokku logs:set $TEST_APP invalid value" 2>&1
|
||||||
echo "output: $output"
|
echo "output: $output"
|
||||||
echo "status: $status"
|
echo "status: $status"
|
||||||
assert_failure
|
assert_failure
|
||||||
assert_output_contains "Invalid property specified, valid properties include: vector-sink"
|
assert_output_contains "Invalid property specified, valid properties include: max-size, vector-sink"
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "(logs) logs:set app" {
|
@test "(logs) logs:set app" {
|
||||||
@@ -144,7 +144,50 @@ teardown() {
|
|||||||
echo "status: $status"
|
echo "status: $status"
|
||||||
assert_success
|
assert_success
|
||||||
assert_output "console://?encoding[codec]=json"
|
assert_output "console://?encoding[codec]=json"
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku logs:report $TEST_APP --logs-max-size 2>&1"
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output_not_exists
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku logs:set $TEST_APP max-size" 2>&1
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output_contains "Unsetting max-size"
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku logs:report $TEST_APP --logs-max-size 2>&1"
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output_not_exists
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku logs:set $TEST_APP max-size 20m" 2>&1
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output_contains "Setting max-size"
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku logs:report $TEST_APP --logs-max-size 2>&1"
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output "20m"
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku logs:set $TEST_APP max-size unlimited" 2>&1
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output_contains "Setting max-size"
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku logs:report $TEST_APP --logs-max-size 2>&1"
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output "unlimited"
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "(logs) logs:set global" {
|
@test "(logs) logs:set global" {
|
||||||
run create_app
|
run create_app
|
||||||
echo "output: $output"
|
echo "output: $output"
|
||||||
@@ -189,6 +232,54 @@ teardown() {
|
|||||||
assert_success
|
assert_success
|
||||||
assert_output_contains "Unsetting vector-sink"
|
assert_output_contains "Unsetting vector-sink"
|
||||||
assert_output_contains "Writing updated vector config to /var/lib/dokku/data/logs/vector.json"
|
assert_output_contains "Writing updated vector config to /var/lib/dokku/data/logs/vector.json"
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku logs:report $TEST_APP --logs-global-vector-sink 2>&1"
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output_not_exists
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku logs:set --global max-size" 2>&1
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output_contains "Unsetting max-size"
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku logs:report $TEST_APP --logs-global-max-size 2>&1"
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output "10m"
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku logs:set --global max-size 20m" 2>&1
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output_contains "Setting max-size"
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku logs:report $TEST_APP --logs-global-max-size 2>&1"
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output "20m"
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku logs:set --global max-size unlimited" 2>&1
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output_contains "Setting max-size"
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku logs:report $TEST_APP --logs-global-max-size 2>&1"
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output "unlimited"
|
||||||
|
|
||||||
|
run /bin/bash -c "dokku logs:set --global max-size" 2>&1
|
||||||
|
echo "output: $output"
|
||||||
|
echo "status: $status"
|
||||||
|
assert_success
|
||||||
|
assert_output_contains "Unsetting max-size"
|
||||||
}
|
}
|
||||||
|
|
||||||
@test "(logs) logs:vector" {
|
@test "(logs) logs:vector" {
|
||||||
|
|||||||
Reference in new issue
Block a user