GT-30 API for setting operator log level (#1087)

Author: nikita-vanyasin

CHANGELOG.md

@@ -68,6 +68,7 @@
 - (Bugfix) Add Panic Handler
 - (Bugfix) Unify yaml packages
 - (Feature) Add new GRPC and HTTP API
+- (Feature) Add new API endpoints to allow getting and setting operator logging level
 
 ## [1.2.13](https://github.com/arangodb/kube-arangodb/tree/1.2.13) (2022-06-07)
 - (Bugfix) Fix arangosync members state inspection

docs/design/api.md

@@ -16,7 +16,7 @@ The HTTP API is running at endpoint specified by operator command line options `
 
 The HTTP API exposes endpoints used to get operator health and readiness status, operator version, and prometheus-compatible metrics.
 
-For now only `/metrics` endpoint require authorization.
+For now only `/metrics` and `/log/level` endpoints require authorization.
 
 
 ## gRPC

pkg/api/api.go

@@ -94,7 +94,7 @@ func NewServer(cli typedCore.CoreV1Interface, cfg ServerConfig) (*Server, error)
 		),
 		grpcAddress: cfg.GRPCAddress,
 	}
-	handler, err := buildHTTPHandler(cfg, auth)
+	handler, err := buildHTTPHandler(s, cfg, auth)
 	if err != nil {
 		return nil, err
 	}

pkg/api/grpc.go

@@ -22,8 +22,10 @@ package api
 
 import (
 	"context"
+	"fmt"
 
 	pb "github.com/arangodb/kube-arangodb/pkg/api/server"
+	"github.com/arangodb/kube-arangodb/pkg/logging"
 	"github.com/arangodb/kube-arangodb/pkg/version"
 )
 
@@ -37,3 +39,46 @@ func (s *Server) GetVersion(ctx context.Context, _ *pb.Empty) (*pb.Version, erro
 		BuildDate: v.BuildDate,
 	}, nil
 }
+
+var loglevelMap = map[pb.LogLevel]logging.Level{
+	pb.LogLevel_TRACE: logging.Trace,
+	pb.LogLevel_DEBUG: logging.Debug,
+	pb.LogLevel_INFO:  logging.Info,
+	pb.LogLevel_WARN:  logging.Warn,
+	pb.LogLevel_ERROR: logging.Error,
+	pb.LogLevel_FATAL: logging.Fatal,
+}
+
+func logLevelToGRPC(l logging.Level) pb.LogLevel {
+	for grpcVal, localVal := range loglevelMap {
+		if l == localVal {
+			return grpcVal
+		}
+	}
+	return pb.LogLevel_DEBUG
+}
+
+func (s *Server) GetLogLevel(ctx context.Context, _ *pb.Empty) (*pb.LogLevelConfig, error) {
+	l := s.getLogLevelsByTopics()
+
+	topics := make(map[string]pb.LogLevel, len(l))
+	for topic, level := range l {
+		topics[topic] = logLevelToGRPC(level)
+	}
+	return &pb.LogLevelConfig{
+		Topics: topics,
+	}, nil
+}
+
+func (s *Server) SetLogLevel(ctx context.Context, cfg *pb.LogLevelConfig) (*pb.Empty, error) {
+	l := make(map[string]logging.Level, len(cfg.Topics))
+	for topic, grpcLevel := range cfg.Topics {
+		level, ok := loglevelMap[grpcLevel]
+		if !ok {
+			return &pb.Empty{}, fmt.Errorf("unknown log level %s for topic %s", grpcLevel, topic)
+		}
+		l[topic] = level
+	}
+	s.setLogLevelsByTopics(l)
+	return &pb.Empty{}, nil
+}

pkg/api/http.go

@@ -26,13 +26,14 @@ import (
 	"github.com/gin-gonic/gin"
 	prometheus "github.com/prometheus/client_golang/prometheus/promhttp"
 
+	"github.com/arangodb/kube-arangodb/pkg/logging"
 	"github.com/arangodb/kube-arangodb/pkg/util/errors"
 	operatorHTTP "github.com/arangodb/kube-arangodb/pkg/util/http"
 	"github.com/arangodb/kube-arangodb/pkg/util/probe"
 	"github.com/arangodb/kube-arangodb/pkg/version"
 )
 
-func buildHTTPHandler(cfg ServerConfig, auth *authorization) (http.Handler, error) {
+func buildHTTPHandler(s *Server, cfg ServerConfig, auth *authorization) (http.Handler, error) {
 	gin.SetMode(gin.ReleaseMode)
 	r := gin.New()
 	r.Use(gin.Recovery())
@@ -61,6 +62,8 @@ func buildHTTPHandler(cfg ServerConfig, auth *authorization) (http.Handler, erro
 	r.GET("/ready", gin.WrapF(handleGetReady(readyProbes...)))
 
 	r.GET("/metrics", auth.ensureHTTPAuth, gin.WrapH(prometheus.Handler()))
+	r.GET("/log/level", auth.ensureHTTPAuth, s.handleGetLogLevel)
+	r.POST("/log/level", auth.ensureHTTPAuth, s.handlePostLogLevel)
 
 	return r, nil
 }
@@ -77,3 +80,43 @@ func handleGetReady(probes ...*probe.ReadyProbe) func(w http.ResponseWriter, r *
 		w.WriteHeader(http.StatusOK)
 	}
 }
+
+func (s *Server) handleGetLogLevel(c *gin.Context) {
+	logLevels := s.getLogLevelsByTopics()
+	topics := make(map[string]string, len(logLevels))
+	for topic, level := range logLevels {
+		topics[topic] = level.String()
+	}
+	c.JSON(http.StatusOK, gin.H{
+		"topics": topics,
+	})
+}
+
+func (s *Server) handlePostLogLevel(c *gin.Context) {
+	var req = struct {
+		Topics map[string]string `json:"topics"`
+	}{}
+
+	err := c.BindJSON(&req)
+	if err != nil {
+		c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{
+			"msg": err.Error(),
+		})
+		return
+	}
+
+	logLevels := make(map[string]logging.Level, len(req.Topics))
+	for topic, levelStr := range req.Topics {
+		l, err := logging.ParseLogLevel(levelStr)
+		if err != nil {
+			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{
+				"msg": err.Error(),
+			})
+			return
+		}
+		logLevels[topic] = l
+	}
+
+	s.setLogLevelsByTopics(logLevels)
+	c.JSON(http.StatusOK, gin.H{})
+}

pkg/api/logging.go

@@ -0,0 +1,33 @@
+//
+// DISCLAIMER
+//
+// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+
+package api
+
+import (
+	"github.com/arangodb/kube-arangodb/pkg/logging"
+)
+
+func (s *Server) getLogLevelsByTopics() map[string]logging.Level {
+	return logging.Global().LogLevels()
+}
+
+func (s *Server) setLogLevelsByTopics(logLevels map[string]logging.Level) {
+	logging.Global().ApplyLogLevels(logLevels)
+}