From 847fcf855136287fd8e16deda9a95fb0e61cb1e2 Mon Sep 17 00:00:00 2001 From: Clint Date: Tue, 12 Nov 2019 13:29:29 -0600 Subject: [PATCH] Update how Vault Agent configures Consul Templates internal logger (#7822) * fix up logger in Vault Agent Template * update deps --- command/agent.go | 2 + command/agent/template/template.go | 55 ++- command/agent/template/template_test.go | 2 + go.sum | 1 + .../consul-template/logging/logging.go | 88 +++++ .../consul-template/logging/syslog.go | 53 +++ .../github.com/hashicorp/logutils/.gitignore | 22 ++ vendor/github.com/hashicorp/logutils/LICENSE | 354 ++++++++++++++++++ .../github.com/hashicorp/logutils/README.md | 36 ++ vendor/github.com/hashicorp/logutils/go.mod | 1 + vendor/github.com/hashicorp/logutils/level.go | 81 ++++ vendor/modules.txt | 3 + 12 files changed, 693 insertions(+), 5 deletions(-) create mode 100644 vendor/github.com/hashicorp/consul-template/logging/logging.go create mode 100644 vendor/github.com/hashicorp/consul-template/logging/syslog.go create mode 100644 vendor/github.com/hashicorp/logutils/.gitignore create mode 100644 vendor/github.com/hashicorp/logutils/LICENSE create mode 100644 vendor/github.com/hashicorp/logutils/README.md create mode 100644 vendor/github.com/hashicorp/logutils/go.mod create mode 100644 vendor/github.com/hashicorp/logutils/level.go diff --git a/command/agent.go b/command/agent.go index df36cea7e..4d7bc201a 100644 --- a/command/agent.go +++ b/command/agent.go @@ -530,6 +530,8 @@ func (c *AgentCommand) Run(args []string) int { ts := template.NewServer(&template.ServerConfig{ Logger: c.logger.Named("template.server"), + LogLevel: level, + LogWriter: c.logWriter, VaultConf: config.Vault, Namespace: namespace, ExitAfterAuth: config.ExitAfterAuth, diff --git a/command/agent/template/template.go b/command/agent/template/template.go index 271ebe6e7..426ea11d2 100644 --- a/command/agent/template/template.go +++ b/command/agent/template/template.go @@ -7,9 +7,11 @@ package template import ( "context" + "io" "strings" ctconfig "github.com/hashicorp/consul-template/config" + ctlogging "github.com/hashicorp/consul-template/logging" "github.com/hashicorp/consul-template/manager" "github.com/hashicorp/go-hclog" "github.com/hashicorp/vault/command/agent/config" @@ -25,6 +27,15 @@ type ServerConfig struct { ExitAfterAuth bool Namespace string + + // LogLevel is needed to set the internal Consul Template Runner's log level + // to match the log level of Vault Agent. The internal Runner creates it's own + // logger and can't be set externally or copied from the Template Server. + // + // LogWriter is needed to initialize Consul Template's internal logger to use + // the same io.Writer that Vault Agent itself is using. + LogLevel hclog.Level + LogWriter io.Writer } // Server manages the Consul Template Runner which renders templates @@ -80,8 +91,9 @@ func (ts *Server) Run(ctx context.Context, incoming chan string, templates []*ct // construct a consul template vault config based the agents vault // configuration var runnerConfig *ctconfig.Config - if runnerConfig = newRunnerConfig(ts.config, templates); runnerConfig == nil { - ts.logger.Error("template server failed to generate runner config") + var runnerConfigErr error + if runnerConfig, runnerConfigErr = newRunnerConfig(ts.config, templates); runnerConfigErr != nil { + ts.logger.Error("template server failed to generate runner config", "error", runnerConfigErr) return } @@ -134,8 +146,7 @@ func (ts *Server) Run(ctx context.Context, incoming chan string, templates []*ct // newRunnerConfig returns a consul-template runner configuration, setting the // Vault and Consul configurations based on the clients configs. -func newRunnerConfig(sc *ServerConfig, templates ctconfig.TemplateConfigs) *ctconfig.Config { - // TODO only use default Vault config +func newRunnerConfig(sc *ServerConfig, templates ctconfig.TemplateConfigs) (*ctconfig.Config, error) { conf := ctconfig.DefaultConfig() conf.Templates = templates.Copy() @@ -173,5 +184,39 @@ func newRunnerConfig(sc *ServerConfig, templates ctconfig.TemplateConfigs) *ctco } conf.Finalize() - return conf + + // setup log level from TemplateServer config + conf.LogLevel = logLevelToStringPtr(sc.LogLevel) + + if err := ctlogging.Setup(&ctlogging.Config{ + Name: "template.server.runner", + Level: *conf.LogLevel, + Writer: sc.LogWriter, + }); err != nil { + return nil, err + } + return conf, nil +} + +// logLevelToString converts a go-hclog level to a matching, uppercase string +// value. It's used to convert Vault Agent's hclog level to a string version +// suitable for use in Consul Template's runner configuration input. +func logLevelToStringPtr(level hclog.Level) *string { + // consul template's default level is WARN, but Vault Agent's default is INFO, + // so we use that for the Runner's default. + var levelStr string + + switch level { + case hclog.Trace: + levelStr = "TRACE" + case hclog.Debug: + levelStr = "DEBUG" + case hclog.Warn: + levelStr = "WARN" + case hclog.Error: + levelStr = "ERROR" + default: + levelStr = "INFO" + } + return pointerutil.StringPtr(levelStr) } diff --git a/command/agent/template/template_test.go b/command/agent/template/template_test.go index 057dc81c2..9d71bcc54 100644 --- a/command/agent/template/template_test.go +++ b/command/agent/template/template_test.go @@ -117,6 +117,8 @@ func TestServerRun(t *testing.T) { VaultConf: &config.Vault{ Address: ts.URL, }, + LogLevel: hclog.Trace, + LogWriter: hclog.DefaultOutput, ExitAfterAuth: true, } diff --git a/go.sum b/go.sum index 94b69faa7..70517b900 100644 --- a/go.sum +++ b/go.sum @@ -340,6 +340,7 @@ github.com/hashicorp/golang-lru v0.5.3 h1:YPkqC67at8FYaadspW/6uE0COsBxS2656RLEr8 github.com/hashicorp/golang-lru v0.5.3/go.mod h1:iADmTwqILo4mZ8BN3D2Q6+9jd8WM5uGBxy+E8yxSoD4= github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4= github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ= +github.com/hashicorp/logutils v1.0.0 h1:dLEQVugN8vlakKOUE3ihGLTZJRB4j+M2cdTm/ORI65Y= github.com/hashicorp/logutils v1.0.0/go.mod h1:QIAnNjmIWmVIIkWDTG1z5v++HQmx9WQRO+LraFDTW64= github.com/hashicorp/mdns v1.0.0/go.mod h1:tL+uN++7HEJ6SQLQ2/p+z2pH24WQKWjBPkE0mNTz8vQ= github.com/hashicorp/memberlist v0.1.3/go.mod h1:ajVTdAv/9Im8oMAAj5G31PhhMCZJV2pPBoIllUwCN7I= diff --git a/vendor/github.com/hashicorp/consul-template/logging/logging.go b/vendor/github.com/hashicorp/consul-template/logging/logging.go new file mode 100644 index 000000000..82c4eacc1 --- /dev/null +++ b/vendor/github.com/hashicorp/consul-template/logging/logging.go @@ -0,0 +1,88 @@ +package logging + +import ( + "fmt" + "io" + "io/ioutil" + "log" + "strings" + + "github.com/hashicorp/go-syslog" + "github.com/hashicorp/logutils" +) + +// Levels are the log levels we respond to=o. +var Levels = []logutils.LogLevel{"TRACE", "DEBUG", "INFO", "WARN", "ERR"} + +// Config is the configuration for this log setup. +type Config struct { + // Name is the progname as it will appear in syslog output (if enabled). + Name string `json:"name"` + + // Level is the log level to use. + Level string `json:"level"` + + // Syslog and SyslogFacility are the syslog configuration options. + Syslog bool `json:"syslog"` + SyslogFacility string `json:"syslog_facility"` + + // Writer is the output where logs should go. If syslog is enabled, data will + // be written to writer in addition to syslog. + Writer io.Writer `json:"-"` +} + +func Setup(config *Config) error { + var logOutput io.Writer + + // Setup the default logging + logFilter := NewLogFilter() + logFilter.MinLevel = logutils.LogLevel(strings.ToUpper(config.Level)) + logFilter.Writer = config.Writer + if !ValidateLevelFilter(logFilter.MinLevel, logFilter) { + levels := make([]string, 0, len(logFilter.Levels)) + for _, level := range logFilter.Levels { + levels = append(levels, string(level)) + } + return fmt.Errorf("invalid log level %q, valid log levels are %s", + config.Level, strings.Join(levels, ", ")) + } + + // Check if syslog is enabled + if config.Syslog { + log.Printf("[DEBUG] (logging) enabling syslog on %s", config.SyslogFacility) + + l, err := gsyslog.NewLogger(gsyslog.LOG_NOTICE, config.SyslogFacility, config.Name) + if err != nil { + return fmt.Errorf("error setting up syslog logger: %s", err) + } + syslog := &SyslogWrapper{l, logFilter} + logOutput = io.MultiWriter(logFilter, syslog) + } else { + logOutput = io.MultiWriter(logFilter) + } + + log.SetFlags(log.Ldate | log.Ltime | log.Lmicroseconds | log.LUTC) + log.SetOutput(logOutput) + + return nil +} + +// NewLogFilter returns a LevelFilter that is configured with the log levels that +// we use. +func NewLogFilter() *logutils.LevelFilter { + return &logutils.LevelFilter{ + Levels: Levels, + MinLevel: "WARN", + Writer: ioutil.Discard, + } +} + +// ValidateLevelFilter verifies that the log levels within the filter are valid. +func ValidateLevelFilter(min logutils.LogLevel, filter *logutils.LevelFilter) bool { + for _, level := range filter.Levels { + if level == min { + return true + } + } + return false +} diff --git a/vendor/github.com/hashicorp/consul-template/logging/syslog.go b/vendor/github.com/hashicorp/consul-template/logging/syslog.go new file mode 100644 index 000000000..4f151b095 --- /dev/null +++ b/vendor/github.com/hashicorp/consul-template/logging/syslog.go @@ -0,0 +1,53 @@ +package logging + +import ( + "bytes" + + "github.com/hashicorp/go-syslog" + "github.com/hashicorp/logutils" +) + +// syslogPriorityMap is used to map a log level to a syslog priority level. +var syslogPriorityMap = map[string]gsyslog.Priority{ + "DEBUG": gsyslog.LOG_INFO, + "INFO": gsyslog.LOG_NOTICE, + "WARN": gsyslog.LOG_WARNING, + "ERR": gsyslog.LOG_ERR, +} + +// SyslogWrapper is used to cleanup log messages before writing them to a +// Syslogger. Implements the io.Writer interface. +type SyslogWrapper struct { + l gsyslog.Syslogger + filt *logutils.LevelFilter +} + +// Write is used to implement io.Writer. +func (s *SyslogWrapper) Write(p []byte) (int, error) { + // Skip syslog if the log level doesn't apply + if !s.filt.Check(p) { + return 0, nil + } + + // Extract log level + var level string + afterLevel := p + x := bytes.IndexByte(p, '[') + if x >= 0 { + y := bytes.IndexByte(p[x:], ']') + if y >= 0 { + level = string(p[x+1 : x+y]) + afterLevel = p[x+y+2:] + } + } + + // Each log level will be handled by a specific syslog priority. + priority, ok := syslogPriorityMap[level] + if !ok { + priority = gsyslog.LOG_NOTICE + } + + // Attempt the write + err := s.l.WriteLevel(priority, afterLevel) + return len(p), err +} diff --git a/vendor/github.com/hashicorp/logutils/.gitignore b/vendor/github.com/hashicorp/logutils/.gitignore new file mode 100644 index 000000000..00268614f --- /dev/null +++ b/vendor/github.com/hashicorp/logutils/.gitignore @@ -0,0 +1,22 @@ +# Compiled Object files, Static and Dynamic libs (Shared Objects) +*.o +*.a +*.so + +# Folders +_obj +_test + +# Architecture specific extensions/prefixes +*.[568vq] +[568vq].out + +*.cgo1.go +*.cgo2.c +_cgo_defun.c +_cgo_gotypes.go +_cgo_export.* + +_testmain.go + +*.exe diff --git a/vendor/github.com/hashicorp/logutils/LICENSE b/vendor/github.com/hashicorp/logutils/LICENSE new file mode 100644 index 000000000..c33dcc7c9 --- /dev/null +++ b/vendor/github.com/hashicorp/logutils/LICENSE @@ -0,0 +1,354 @@ +Mozilla Public License, version 2.0 + +1. Definitions + +1.1. “Contributor” + + means each individual or legal entity that creates, contributes to the + creation of, or owns Covered Software. + +1.2. “Contributor Version” + + means the combination of the Contributions of others (if any) used by a + Contributor and that particular Contributor’s Contribution. + +1.3. “Contribution” + + means Covered Software of a particular Contributor. + +1.4. “Covered Software” + + means Source Code Form to which the initial Contributor has attached the + notice in Exhibit A, the Executable Form of such Source Code Form, and + Modifications of such Source Code Form, in each case including portions + thereof. + +1.5. “Incompatible With Secondary Licenses” + means + + a. that the initial Contributor has attached the notice described in + Exhibit B to the Covered Software; or + + b. that the Covered Software was made available under the terms of version + 1.1 or earlier of the License, but not also under the terms of a + Secondary License. + +1.6. “Executable Form” + + means any form of the work other than Source Code Form. + +1.7. “Larger Work” + + means a work that combines Covered Software with other material, in a separate + file or files, that is not Covered Software. + +1.8. “License” + + means this document. + +1.9. “Licensable” + + means having the right to grant, to the maximum extent possible, whether at the + time of the initial grant or subsequently, any and all of the rights conveyed by + this License. + +1.10. “Modifications” + + means any of the following: + + a. any file in Source Code Form that results from an addition to, deletion + from, or modification of the contents of Covered Software; or + + b. any new file in Source Code Form that contains any Covered Software. + +1.11. “Patent Claims” of a Contributor + + means any patent claim(s), including without limitation, method, process, + and apparatus claims, in any patent Licensable by such Contributor that + would be infringed, but for the grant of the License, by the making, + using, selling, offering for sale, having made, import, or transfer of + either its Contributions or its Contributor Version. + +1.12. “Secondary License” + + means either the GNU General Public License, Version 2.0, the GNU Lesser + General Public License, Version 2.1, the GNU Affero General Public + License, Version 3.0, or any later versions of those licenses. + +1.13. “Source Code Form” + + means the form of the work preferred for making modifications. + +1.14. “You” (or “Your”) + + means an individual or a legal entity exercising rights under this + License. For legal entities, “You” includes any entity that controls, is + controlled by, or is under common control with You. For purposes of this + definition, “control” means (a) the power, direct or indirect, to cause + the direction or management of such entity, whether by contract or + otherwise, or (b) ownership of more than fifty percent (50%) of the + outstanding shares or beneficial ownership of such entity. + + +2. License Grants and Conditions + +2.1. Grants + + Each Contributor hereby grants You a world-wide, royalty-free, + non-exclusive license: + + a. under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or as + part of a Larger Work; and + + b. under Patent Claims of such Contributor to make, use, sell, offer for + sale, have made, import, and otherwise transfer either its Contributions + or its Contributor Version. + +2.2. Effective Date + + The licenses granted in Section 2.1 with respect to any Contribution become + effective for each Contribution on the date the Contributor first distributes + such Contribution. + +2.3. Limitations on Grant Scope + + The licenses granted in this Section 2 are the only rights granted under this + License. No additional rights or licenses will be implied from the distribution + or licensing of Covered Software under this License. Notwithstanding Section + 2.1(b) above, no patent license is granted by a Contributor: + + a. for any code that a Contributor has removed from Covered Software; or + + b. for infringements caused by: (i) Your and any other third party’s + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + + c. under Patent Claims infringed by Covered Software in the absence of its + Contributions. + + This License does not grant any rights in the trademarks, service marks, or + logos of any Contributor (except as may be necessary to comply with the + notice requirements in Section 3.4). + +2.4. Subsequent Licenses + + No Contributor makes additional grants as a result of Your choice to + distribute the Covered Software under a subsequent version of this License + (see Section 10.2) or under the terms of a Secondary License (if permitted + under the terms of Section 3.3). + +2.5. Representation + + Each Contributor represents that the Contributor believes its Contributions + are its original creation(s) or it has sufficient rights to grant the + rights to its Contributions conveyed by this License. + +2.6. Fair Use + + This License is not intended to limit any rights You have under applicable + copyright doctrines of fair use, fair dealing, or other equivalents. + +2.7. Conditions + + Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in + Section 2.1. + + +3. Responsibilities + +3.1. Distribution of Source Form + + All distribution of Covered Software in Source Code Form, including any + Modifications that You create or to which You contribute, must be under the + terms of this License. You must inform recipients that the Source Code Form + of the Covered Software is governed by the terms of this License, and how + they can obtain a copy of this License. You may not attempt to alter or + restrict the recipients’ rights in the Source Code Form. + +3.2. Distribution of Executable Form + + If You distribute Covered Software in Executable Form then: + + a. such Covered Software must also be made available in Source Code Form, + as described in Section 3.1, and You must inform recipients of the + Executable Form how they can obtain a copy of such Source Code Form by + reasonable means in a timely manner, at a charge no more than the cost + of distribution to the recipient; and + + b. You may distribute such Executable Form under the terms of this License, + or sublicense it under different terms, provided that the license for + the Executable Form does not attempt to limit or alter the recipients’ + rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + + You may create and distribute a Larger Work under terms of Your choice, + provided that You also comply with the requirements of this License for the + Covered Software. If the Larger Work is a combination of Covered Software + with a work governed by one or more Secondary Licenses, and the Covered + Software is not Incompatible With Secondary Licenses, this License permits + You to additionally distribute such Covered Software under the terms of + such Secondary License(s), so that the recipient of the Larger Work may, at + their option, further distribute the Covered Software under the terms of + either this License or such Secondary License(s). + +3.4. Notices + + You may not remove or alter the substance of any license notices (including + copyright notices, patent notices, disclaimers of warranty, or limitations + of liability) contained within the Source Code Form of the Covered + Software, except that You may alter any license notices to the extent + required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + + You may choose to offer, and to charge a fee for, warranty, support, + indemnity or liability obligations to one or more recipients of Covered + Software. However, You may do so only on Your own behalf, and not on behalf + of any Contributor. You must make it absolutely clear that any such + warranty, support, indemnity, or liability obligation is offered by You + alone, and You hereby agree to indemnify every Contributor for any + liability incurred by such Contributor as a result of warranty, support, + indemnity or liability terms You offer. You may include additional + disclaimers of warranty and limitations of liability specific to any + jurisdiction. + +4. Inability to Comply Due to Statute or Regulation + + If it is impossible for You to comply with any of the terms of this License + with respect to some or all of the Covered Software due to statute, judicial + order, or regulation then You must: (a) comply with the terms of this License + to the maximum extent possible; and (b) describe the limitations and the code + they affect. Such description must be placed in a text file included with all + distributions of the Covered Software under this License. Except to the + extent prohibited by statute or regulation, such description must be + sufficiently detailed for a recipient of ordinary skill to be able to + understand it. + +5. Termination + +5.1. The rights granted under this License will terminate automatically if You + fail to comply with any of its terms. However, if You become compliant, + then the rights granted under this License from a particular Contributor + are reinstated (a) provisionally, unless and until such Contributor + explicitly and finally terminates Your grants, and (b) on an ongoing basis, + if such Contributor fails to notify You of the non-compliance by some + reasonable means prior to 60 days after You have come back into compliance. + Moreover, Your grants from a particular Contributor are reinstated on an + ongoing basis if such Contributor notifies You of the non-compliance by + some reasonable means, this is the first time You have received notice of + non-compliance with this License from such Contributor, and You become + compliant prior to 30 days after Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent + infringement claim (excluding declaratory judgment actions, counter-claims, + and cross-claims) alleging that a Contributor Version directly or + indirectly infringes any patent, then the rights granted to You by any and + all Contributors for the Covered Software under Section 2.1 of this License + shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user + license agreements (excluding distributors and resellers) which have been + validly granted by You or Your distributors under this License prior to + termination shall survive termination. + +6. Disclaimer of Warranty + + Covered Software is provided under this License on an “as is” basis, without + warranty of any kind, either expressed, implied, or statutory, including, + without limitation, warranties that the Covered Software is free of defects, + merchantable, fit for a particular purpose or non-infringing. The entire + risk as to the quality and performance of the Covered Software is with You. + Should any Covered Software prove defective in any respect, You (not any + Contributor) assume the cost of any necessary servicing, repair, or + correction. This disclaimer of warranty constitutes an essential part of this + License. No use of any Covered Software is authorized under this License + except under this disclaimer. + +7. Limitation of Liability + + Under no circumstances and under no legal theory, whether tort (including + negligence), contract, or otherwise, shall any Contributor, or anyone who + distributes Covered Software as permitted above, be liable to You for any + direct, indirect, special, incidental, or consequential damages of any + character including, without limitation, damages for lost profits, loss of + goodwill, work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses, even if such party shall have been + informed of the possibility of such damages. This limitation of liability + shall not apply to liability for death or personal injury resulting from such + party’s negligence to the extent applicable law prohibits such limitation. + Some jurisdictions do not allow the exclusion or limitation of incidental or + consequential damages, so this exclusion and limitation may not apply to You. + +8. Litigation + + Any litigation relating to this License may be brought only in the courts of + a jurisdiction where the defendant maintains its principal place of business + and such litigation shall be governed by laws of that jurisdiction, without + reference to its conflict-of-law provisions. Nothing in this Section shall + prevent a party’s ability to bring cross-claims or counter-claims. + +9. Miscellaneous + + This License represents the complete agreement concerning the subject matter + hereof. If any provision of this License is held to be unenforceable, such + provision shall be reformed only to the extent necessary to make it + enforceable. Any law or regulation which provides that the language of a + contract shall be construed against the drafter shall not be used to construe + this License against a Contributor. + + +10. Versions of the License + +10.1. New Versions + + Mozilla Foundation is the license steward. Except as provided in Section + 10.3, no one other than the license steward has the right to modify or + publish new versions of this License. Each version will be given a + distinguishing version number. + +10.2. Effect of New Versions + + You may distribute the Covered Software under the terms of the version of + the License under which You originally received the Covered Software, or + under the terms of any subsequent version published by the license + steward. + +10.3. Modified Versions + + If you create software not governed by this License, and you want to + create a new license for such software, you may create and use a modified + version of this License if you rename the license and remove any + references to the name of the license steward (except to note that such + modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses + If You choose to distribute Source Code Form that is Incompatible With + Secondary Licenses under the terms of this version of the License, the + notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice + + This Source Code Form is subject to the + terms of the Mozilla Public License, v. + 2.0. If a copy of the MPL was not + distributed with this file, You can + obtain one at + http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular file, then +You may include the notice in a location (such as a LICENSE file in a relevant +directory) where a recipient would be likely to look for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - “Incompatible With Secondary Licenses” Notice + + This Source Code Form is “Incompatible + With Secondary Licenses”, as defined by + the Mozilla Public License, v. 2.0. + diff --git a/vendor/github.com/hashicorp/logutils/README.md b/vendor/github.com/hashicorp/logutils/README.md new file mode 100644 index 000000000..49490eaeb --- /dev/null +++ b/vendor/github.com/hashicorp/logutils/README.md @@ -0,0 +1,36 @@ +# logutils + +logutils is a Go package that augments the standard library "log" package +to make logging a bit more modern, without fragmenting the Go ecosystem +with new logging packages. + +## The simplest thing that could possibly work + +Presumably your application already uses the default `log` package. To switch, you'll want your code to look like the following: + +```go +package main + +import ( + "log" + "os" + + "github.com/hashicorp/logutils" +) + +func main() { + filter := &logutils.LevelFilter{ + Levels: []logutils.LogLevel{"DEBUG", "WARN", "ERROR"}, + MinLevel: logutils.LogLevel("WARN"), + Writer: os.Stderr, + } + log.SetOutput(filter) + + log.Print("[DEBUG] Debugging") // this will not print + log.Print("[WARN] Warning") // this will + log.Print("[ERROR] Erring") // and so will this + log.Print("Message I haven't updated") // and so will this +} +``` + +This logs to standard error exactly like go's standard logger. Any log messages you haven't converted to have a level will continue to print as before. diff --git a/vendor/github.com/hashicorp/logutils/go.mod b/vendor/github.com/hashicorp/logutils/go.mod new file mode 100644 index 000000000..ba38a4576 --- /dev/null +++ b/vendor/github.com/hashicorp/logutils/go.mod @@ -0,0 +1 @@ +module github.com/hashicorp/logutils diff --git a/vendor/github.com/hashicorp/logutils/level.go b/vendor/github.com/hashicorp/logutils/level.go new file mode 100644 index 000000000..6381bf162 --- /dev/null +++ b/vendor/github.com/hashicorp/logutils/level.go @@ -0,0 +1,81 @@ +// Package logutils augments the standard log package with levels. +package logutils + +import ( + "bytes" + "io" + "sync" +) + +type LogLevel string + +// LevelFilter is an io.Writer that can be used with a logger that +// will filter out log messages that aren't at least a certain level. +// +// Once the filter is in use somewhere, it is not safe to modify +// the structure. +type LevelFilter struct { + // Levels is the list of log levels, in increasing order of + // severity. Example might be: {"DEBUG", "WARN", "ERROR"}. + Levels []LogLevel + + // MinLevel is the minimum level allowed through + MinLevel LogLevel + + // The underlying io.Writer where log messages that pass the filter + // will be set. + Writer io.Writer + + badLevels map[LogLevel]struct{} + once sync.Once +} + +// Check will check a given line if it would be included in the level +// filter. +func (f *LevelFilter) Check(line []byte) bool { + f.once.Do(f.init) + + // Check for a log level + var level LogLevel + x := bytes.IndexByte(line, '[') + if x >= 0 { + y := bytes.IndexByte(line[x:], ']') + if y >= 0 { + level = LogLevel(line[x+1 : x+y]) + } + } + + _, ok := f.badLevels[level] + return !ok +} + +func (f *LevelFilter) Write(p []byte) (n int, err error) { + // Note in general that io.Writer can receive any byte sequence + // to write, but the "log" package always guarantees that we only + // get a single line. We use that as a slight optimization within + // this method, assuming we're dealing with a single, complete line + // of log data. + + if !f.Check(p) { + return len(p), nil + } + + return f.Writer.Write(p) +} + +// SetMinLevel is used to update the minimum log level +func (f *LevelFilter) SetMinLevel(min LogLevel) { + f.MinLevel = min + f.init() +} + +func (f *LevelFilter) init() { + badLevels := make(map[LogLevel]struct{}) + for _, level := range f.Levels { + if level == f.MinLevel { + break + } + badLevels[level] = struct{}{} + } + f.badLevels = badLevels +} diff --git a/vendor/modules.txt b/vendor/modules.txt index e0d76cd2c..c59e369d6 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -290,6 +290,7 @@ github.com/grpc-ecosystem/grpc-gateway/internal github.com/hailocab/go-hostpool # github.com/hashicorp/consul-template v0.22.0 github.com/hashicorp/consul-template/config +github.com/hashicorp/consul-template/logging github.com/hashicorp/consul-template/manager github.com/hashicorp/consul-template/signals github.com/hashicorp/consul-template/child @@ -349,6 +350,8 @@ github.com/hashicorp/hcl/hcl/scanner github.com/hashicorp/hcl/hcl/strconv github.com/hashicorp/hcl/json/scanner github.com/hashicorp/hcl/json/token +# github.com/hashicorp/logutils v1.0.0 +github.com/hashicorp/logutils # github.com/hashicorp/nomad/api v0.0.0-20190412184103-1c38ced33adf github.com/hashicorp/nomad/api github.com/hashicorp/nomad/api/contexts