go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/common/logging/config.go (about)

     1  // Copyright 2015 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package logging
    16  
    17  import (
    18  	"context"
    19  	"flag"
    20  )
    21  
    22  // Config is a logging configuration structure.
    23  type Config struct {
    24  	Level Level
    25  }
    26  
    27  // AddFlags adds common flags to a supplied FlagSet.
    28  func (c *Config) AddFlags(fs *flag.FlagSet) {
    29  	c.AddFlagsPrefix(fs, "")
    30  }
    31  
    32  // AddFlagsPrefix adds common flags to a supplied FlagSet with a prefix.
    33  //
    34  // A string prefix must be supplied which will be prepended to
    35  // each added flag verbatim.
    36  func (c *Config) AddFlagsPrefix(fs *flag.FlagSet, prefix string) {
    37  	fs.Var(&c.Level, prefix+"log-level",
    38  		"The logging level. Valid options are: debug, info, warning, error.")
    39  }
    40  
    41  // Set returns a new context configured to use logging level passed via the
    42  // command-line level flag.
    43  func (c *Config) Set(ctx context.Context) context.Context {
    44  	return SetLevel(ctx, c.Level)
    45  }