Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Set envoy log level per pod #1849

Merged
merged 1 commit into from
Feb 13, 2023
Merged

Set envoy log level per pod #1849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 54 additions & 62 deletions cli/cmd/proxy/loglevel/command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,39 +1,36 @@
package loglevel

import (
"bytes"
"context"
"errors"
"fmt"
"io"
"net/http"
"strings"
"sync"

"github.com/hashicorp/consul-k8s/cli/common"
"github.com/hashicorp/consul-k8s/cli/common/flag"
"github.com/hashicorp/consul-k8s/cli/common/terminal"
"github.com/posener/complete"
helmCLI "helm.sh/helm/v3/pkg/cli"
"k8s.io/apimachinery/pkg/api/validation"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/rest"

"github.com/hashicorp/consul-k8s/cli/common"
"github.com/hashicorp/consul-k8s/cli/common/envoy"
"github.com/hashicorp/consul-k8s/cli/common/flag"
"github.com/hashicorp/consul-k8s/cli/common/terminal"
)

const (
defaultAdminPort = 19000
flagNameNamespace = "namespace"
flagNameUpdateLevel = "update-level"
flagNameKubeConfig = "kubeconfig"
flagNameKubeContext = "context"
)

type LoggerConfig map[string]string
var ErrIncorrectArgFormat = errors.New("Exactly one positional argument is required: <pod-name>")

var (
ErrIncorrectArgFormat = errors.New("Exactly one positional argument is required: <pod-name>")
ErrNoLoggersReturned = errors.New("No loggers were returned from Envoy")
)
type LoggerConfig map[string]string

var levelToColor = map[string]string{
"trace": terminal.Green,
Expand All @@ -54,13 +51,14 @@ type LogLevelCommand struct {
// Command Flags
podName string
namespace string
level string
kubeConfig string
kubeContext string

once sync.Once
help string
restConfig *rest.Config
logLevelFetcher func(context.Context, common.PortForwarder) (LoggerConfig, error)
once sync.Once
help string
restConfig *rest.Config
envoyLoggingCaller func(context.Context, common.PortForwarder, *envoy.LoggerParams) (map[string]string, error)
}

func (l *LogLevelCommand) init() {
Expand All @@ -74,6 +72,13 @@ func (l *LogLevelCommand) init() {
Aliases: []string{"n"},
})

f.StringVar(&flag.StringVar{
Name: flagNameUpdateLevel,
Target: &l.level,
Usage: "Update the level for the logger. Can be either `-update-level warning` to change all loggers to warning, or a comma delineated list of loggers with level can be passed like `-update-level grpc:warning,http:info` to only modify specific loggers.",
Aliases: []string{"u"},
})

f = l.set.NewSet("Global Options")
f.StringVar(&flag.StringVar{
Name: flagNameKubeConfig,
Expand Down Expand Up @@ -103,8 +108,8 @@ func (l *LogLevelCommand) Run(args []string) int {
return l.logOutputAndDie(err)
}

if l.logLevelFetcher == nil {
l.logLevelFetcher = FetchLogLevel
if l.envoyLoggingCaller == nil {
l.envoyLoggingCaller = envoy.CallLoggingEndpoint
}

err = l.initKubernetes()
Expand All @@ -117,11 +122,11 @@ func (l *LogLevelCommand) Run(args []string) int {
return l.logOutputAndDie(err)
}

logLevels, err := l.fetchLogLevels(adminPorts)
err = l.fetchOrSetLogLevels(adminPorts)
if err != nil {
return l.logOutputAndDie(err)
}
l.outputLevels(logLevels)

return 0
}

Expand Down Expand Up @@ -150,6 +155,7 @@ func (l *LogLevelCommand) parseFlags(args []string) error {
if err != nil {
return err
}

return nil
}

Expand Down Expand Up @@ -222,7 +228,7 @@ func (l *LogLevelCommand) fetchAdminPorts() (map[string]int, error) {
return adminPorts, nil
}

func (l *LogLevelCommand) fetchLogLevels(adminPorts map[string]int) (map[string]LoggerConfig, error) {
func (l *LogLevelCommand) fetchOrSetLogLevels(adminPorts map[string]int) error {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so I also consolidated the calls to envoy into this function, because they were both the exact same code, I'd prefer to keep them separate so it reads better, but having the envoy API is kinda forcing my hand to keep this code from being completely duplicated

loggers := make(map[string]LoggerConfig, 0)

for name, port := range adminPorts {
Expand All @@ -233,61 +239,47 @@ func (l *LogLevelCommand) fetchLogLevels(adminPorts map[string]int) (map[string]
KubeClient: l.kubernetes,
RestConfig: l.restConfig,
}

logLevels, err := l.logLevelFetcher(l.Ctx, &pf)
params, err := parseParams(l.level)
if err != nil {
return err
}
logLevels, err := l.envoyLoggingCaller(l.Ctx, &pf, params)
if err != nil {
return loggers, err
return err
}
loggers[name] = logLevels
}
return loggers, nil
}

// FetchLogLevel requests the logging endpoint from Envoy Admin Interface for a given port
// more can be read about that endpoint https://www.envoyproxy.io/docs/envoy/latest/operations/admin#post--logging
func FetchLogLevel(ctx context.Context, portForward common.PortForwarder) (LoggerConfig, error) {
endpoint, err := portForward.Open(ctx)
if err != nil {
return nil, err
}

defer portForward.Close()

// this endpoint does not support returning json, so we've gotta parse the plain text
response, err := http.Post(fmt.Sprintf("http://%s/logging", endpoint), "text/plain", bytes.NewBuffer([]byte{}))
if err != nil {
return nil, err
}

body, err := io.ReadAll(response.Body)
if err != nil {
return nil, fmt.Errorf("failed to reach envoy: %v", err)
}
l.outputLevels(loggers)
return nil
}

if response.StatusCode >= 400 {
return nil, fmt.Errorf("call to envoy failed with status code: %d, and message: %s", response.StatusCode, body)
func parseParams(params string) (*envoy.LoggerParams, error) {
loggerParams := envoy.NewLoggerParams()
if len(params) == 0 {
return loggerParams, nil
}

loggers := strings.Split(string(body), "\n")
if len(loggers) == 0 {
return nil, ErrNoLoggersReturned
// contains global log level change
if !strings.Contains(params, ":") {
err := loggerParams.SetGlobalLoggerLevel(params)
if err != nil {
return nil, err
}
return loggerParams, nil
}

logLevels := make(map[string]string)
var name string
var level string
// contains changes to at least 1 specific log level
loggerChanges := strings.Split(params, ",")

// the first line here is just a header
for _, logger := range loggers[1:] {
if len(logger) == 0 {
continue
for _, logger := range loggerChanges {
levelValues := strings.Split(logger, ":")
err := loggerParams.SetLoggerLevel(levelValues[0], levelValues[1])
if err != nil {
return nil, err
}
fmt.Sscanf(logger, "%s %s", &name, &level)
name = strings.TrimRight(name, ":")
logLevels[name] = level
}

return logLevels, nil
return loggerParams, nil
}

func (l *LogLevelCommand) outputLevels(logLevels map[string]LoggerConfig) {
Expand Down
Loading