mirror of
https://github.com/1Password/onepassword-operator.git
synced 2025-10-23 16:00:46 +00:00
Update packages and add vendor directory
This commit is contained in:
2
vendor/github.com/go-logr/zapr/.gitignore
generated
vendored
Normal file
2
vendor/github.com/go-logr/zapr/.gitignore
generated
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
*~
|
||||
*.swp
|
201
vendor/github.com/go-logr/zapr/LICENSE
generated
vendored
Normal file
201
vendor/github.com/go-logr/zapr/LICENSE
generated
vendored
Normal file
@@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright {yyyy} {name of copyright owner}
|
||||
|
||||
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.
|
70
vendor/github.com/go-logr/zapr/README.md
generated
vendored
Normal file
70
vendor/github.com/go-logr/zapr/README.md
generated
vendored
Normal file
@@ -0,0 +1,70 @@
|
||||
Zapr :zap:
|
||||
==========
|
||||
|
||||
A [logr](https://github.com/go-logr/logr) implementation using
|
||||
[Zap](https://github.com/uber-go/zap).
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
```go
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"go.uber.org/zap"
|
||||
"github.com/go-logr/logr"
|
||||
"github.com/go-logr/zapr"
|
||||
)
|
||||
|
||||
func main() {
|
||||
var log logr.Logger
|
||||
|
||||
zapLog, err := zap.NewDevelopment()
|
||||
if err != nil {
|
||||
panic(fmt.Sprintf("who watches the watchmen (%v)?", err))
|
||||
}
|
||||
log = zapr.NewLogger(zapLog)
|
||||
|
||||
log.Info("Logr in action!", "the answer", 42)
|
||||
}
|
||||
```
|
||||
|
||||
Increasing Verbosity
|
||||
--------------------
|
||||
|
||||
Zap uses semantically named levels for logging (`DebugLevel`, `InfoLevel`,
|
||||
`WarningLevel`, ...). Logr uses arbitrary numeric levels. By default logr's
|
||||
`V(0)` is zap's `InfoLevel` and `V(1)` is zap's `DebugLevel` (which is
|
||||
numerically -1). Zap does not have named levels that are more verbose than
|
||||
`DebugLevel`, but it's possible to fake it.
|
||||
|
||||
As of zap v1.19.0 you can do something like the following in your setup code:
|
||||
|
||||
```go
|
||||
zc := zap.NewProductionConfig()
|
||||
zc.Level = zap.NewAtomicLevelAt(zapcore.Level(-2))
|
||||
z, err := zc.Build()
|
||||
if err != nil {
|
||||
// ...
|
||||
}
|
||||
log := zapr.NewLogger(z)
|
||||
```
|
||||
|
||||
Zap's levels get more verbose as the number gets smaller and more important and
|
||||
the number gets larger (`DebugLevel` is -1, `InfoLevel` is 0, `WarnLevel` is 1,
|
||||
and so on).
|
||||
|
||||
The `-2` in the above snippet means that `log.V(2).Info()` calls will be active.
|
||||
`-3` would enable `log.V(3).Info()`, etc. Note that zap's levels are `int8`
|
||||
which means the most verbose level you can give it is -128. The zapr
|
||||
implementation will cap `V()` levels greater than 127 to 127, so setting the
|
||||
zap level to -128 really means "activate all logs".
|
||||
|
||||
Implementation Details
|
||||
----------------------
|
||||
|
||||
For the most part, concepts in Zap correspond directly with those in logr.
|
||||
|
||||
Unlike Zap, all fields *must* be in the form of sugared fields --
|
||||
it's illegal to pass a strongly-typed Zap field in a key position to any
|
||||
of the logging methods (`Log`, `Error`).
|
316
vendor/github.com/go-logr/zapr/zapr.go
generated
vendored
Normal file
316
vendor/github.com/go-logr/zapr/zapr.go
generated
vendored
Normal file
@@ -0,0 +1,316 @@
|
||||
/*
|
||||
Copyright 2019 The logr Authors.
|
||||
|
||||
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 2018 Solly Ross
|
||||
//
|
||||
// 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.
|
||||
|
||||
// Package zapr defines an implementation of the github.com/go-logr/logr
|
||||
// interfaces built on top of Zap (go.uber.org/zap).
|
||||
//
|
||||
// Usage
|
||||
//
|
||||
// A new logr.Logger can be constructed from an existing zap.Logger using
|
||||
// the NewLogger function:
|
||||
//
|
||||
// log := zapr.NewLogger(someZapLogger)
|
||||
//
|
||||
// Implementation Details
|
||||
//
|
||||
// For the most part, concepts in Zap correspond directly with those in
|
||||
// logr.
|
||||
//
|
||||
// Unlike Zap, all fields *must* be in the form of sugared fields --
|
||||
// it's illegal to pass a strongly-typed Zap field in a key position
|
||||
// to any of the log methods.
|
||||
//
|
||||
// Levels in logr correspond to custom debug levels in Zap. Any given level
|
||||
// in logr is represents by its inverse in zap (`zapLevel = -1*logrLevel`).
|
||||
// For example V(2) is equivalent to log level -2 in Zap, while V(1) is
|
||||
// equivalent to Zap's DebugLevel.
|
||||
package zapr
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/go-logr/logr"
|
||||
"go.uber.org/zap"
|
||||
"go.uber.org/zap/zapcore"
|
||||
)
|
||||
|
||||
// NB: right now, we always use the equivalent of sugared logging.
|
||||
// This is necessary, since logr doesn't define non-suggared types,
|
||||
// and using zap-specific non-suggared types would make uses tied
|
||||
// directly to Zap.
|
||||
|
||||
// zapLogger is a logr.Logger that uses Zap to log. The level has already been
|
||||
// converted to a Zap level, which is to say that `logrLevel = -1*zapLevel`.
|
||||
type zapLogger struct {
|
||||
// NB: this looks very similar to zap.SugaredLogger, but
|
||||
// deals with our desire to have multiple verbosity levels.
|
||||
l *zap.Logger
|
||||
|
||||
// numericLevelKey controls whether the numeric logr level is
|
||||
// added to each Info log message and with which key.
|
||||
numericLevelKey string
|
||||
|
||||
// errorKey is the field name used for the error in
|
||||
// Logger.Error calls.
|
||||
errorKey string
|
||||
|
||||
// allowZapFields enables logging of strongly-typed Zap
|
||||
// fields. It is off by default because it breaks
|
||||
// implementation agnosticism.
|
||||
allowZapFields bool
|
||||
|
||||
// panicMessages enables log messages for invalid log calls
|
||||
// that explain why a call was invalid (for example,
|
||||
// non-string key). This is enabled by default.
|
||||
panicMessages bool
|
||||
}
|
||||
|
||||
const (
|
||||
// noLevel tells handleFields to not inject a numeric log level field.
|
||||
noLevel = -1
|
||||
)
|
||||
|
||||
// handleFields converts a bunch of arbitrary key-value pairs into Zap fields. It takes
|
||||
// additional pre-converted Zap fields, for use with automatically attached fields, like
|
||||
// `error`.
|
||||
func (zl *zapLogger) handleFields(lvl int, args []interface{}, additional ...zap.Field) []zap.Field {
|
||||
injectNumericLevel := zl.numericLevelKey != "" && lvl != noLevel
|
||||
|
||||
// a slightly modified version of zap.SugaredLogger.sweetenFields
|
||||
if len(args) == 0 {
|
||||
// fast-return if we have no suggared fields and no "v" field.
|
||||
if !injectNumericLevel {
|
||||
return additional
|
||||
}
|
||||
// Slightly slower fast path when we need to inject "v".
|
||||
return append(additional, zap.Int(zl.numericLevelKey, lvl))
|
||||
}
|
||||
|
||||
// unlike Zap, we can be pretty sure users aren't passing structured
|
||||
// fields (since logr has no concept of that), so guess that we need a
|
||||
// little less space.
|
||||
numFields := len(args)/2 + len(additional)
|
||||
if injectNumericLevel {
|
||||
numFields++
|
||||
}
|
||||
fields := make([]zap.Field, 0, numFields)
|
||||
if injectNumericLevel {
|
||||
fields = append(fields, zap.Int(zl.numericLevelKey, lvl))
|
||||
}
|
||||
for i := 0; i < len(args); {
|
||||
// Check just in case for strongly-typed Zap fields,
|
||||
// which might be illegal (since it breaks
|
||||
// implementation agnosticism). If disabled, we can
|
||||
// give a better error message.
|
||||
if field, ok := args[i].(zap.Field); ok {
|
||||
if zl.allowZapFields {
|
||||
fields = append(fields, field)
|
||||
i++
|
||||
continue
|
||||
}
|
||||
if zl.panicMessages {
|
||||
zl.l.WithOptions(zap.AddCallerSkip(1)).DPanic("strongly-typed Zap Field passed to logr", zapIt("zap field", args[i]))
|
||||
}
|
||||
break
|
||||
}
|
||||
|
||||
// make sure this isn't a mismatched key
|
||||
if i == len(args)-1 {
|
||||
if zl.panicMessages {
|
||||
zl.l.WithOptions(zap.AddCallerSkip(1)).DPanic("odd number of arguments passed as key-value pairs for logging", zapIt("ignored key", args[i]))
|
||||
}
|
||||
break
|
||||
}
|
||||
|
||||
// process a key-value pair,
|
||||
// ensuring that the key is a string
|
||||
key, val := args[i], args[i+1]
|
||||
keyStr, isString := key.(string)
|
||||
if !isString {
|
||||
// if the key isn't a string, DPanic and stop logging
|
||||
if zl.panicMessages {
|
||||
zl.l.WithOptions(zap.AddCallerSkip(1)).DPanic("non-string key argument passed to logging, ignoring all later arguments", zapIt("invalid key", key))
|
||||
}
|
||||
break
|
||||
}
|
||||
|
||||
fields = append(fields, zapIt(keyStr, val))
|
||||
i += 2
|
||||
}
|
||||
|
||||
return append(fields, additional...)
|
||||
}
|
||||
|
||||
func zapIt(field string, val interface{}) zap.Field {
|
||||
// Handle types that implement logr.Marshaler: log the replacement
|
||||
// object instead of the original one.
|
||||
if marshaler, ok := val.(logr.Marshaler); ok {
|
||||
field, val = invokeMarshaler(field, marshaler)
|
||||
}
|
||||
return zap.Any(field, val)
|
||||
}
|
||||
|
||||
func invokeMarshaler(field string, m logr.Marshaler) (f string, ret interface{}) {
|
||||
defer func() {
|
||||
if r := recover(); r != nil {
|
||||
ret = fmt.Sprintf("PANIC=%s", r)
|
||||
f = field + "Error"
|
||||
}
|
||||
}()
|
||||
return field, m.MarshalLog()
|
||||
}
|
||||
|
||||
func (zl *zapLogger) Init(ri logr.RuntimeInfo) {
|
||||
zl.l = zl.l.WithOptions(zap.AddCallerSkip(ri.CallDepth))
|
||||
}
|
||||
|
||||
// Zap levels are int8 - make sure we stay in bounds. logr itself should
|
||||
// ensure we never get negative values.
|
||||
func toZapLevel(lvl int) zapcore.Level {
|
||||
if lvl > 127 {
|
||||
lvl = 127
|
||||
}
|
||||
// zap levels are inverted.
|
||||
return 0 - zapcore.Level(lvl)
|
||||
}
|
||||
|
||||
func (zl zapLogger) Enabled(lvl int) bool {
|
||||
return zl.l.Core().Enabled(toZapLevel(lvl))
|
||||
}
|
||||
|
||||
func (zl *zapLogger) Info(lvl int, msg string, keysAndVals ...interface{}) {
|
||||
if checkedEntry := zl.l.Check(toZapLevel(lvl), msg); checkedEntry != nil {
|
||||
checkedEntry.Write(zl.handleFields(lvl, keysAndVals)...)
|
||||
}
|
||||
}
|
||||
|
||||
func (zl *zapLogger) Error(err error, msg string, keysAndVals ...interface{}) {
|
||||
if checkedEntry := zl.l.Check(zap.ErrorLevel, msg); checkedEntry != nil {
|
||||
checkedEntry.Write(zl.handleFields(noLevel, keysAndVals, zap.NamedError(zl.errorKey, err))...)
|
||||
}
|
||||
}
|
||||
|
||||
func (zl *zapLogger) WithValues(keysAndValues ...interface{}) logr.LogSink {
|
||||
newLogger := *zl
|
||||
newLogger.l = zl.l.With(zl.handleFields(noLevel, keysAndValues)...)
|
||||
return &newLogger
|
||||
}
|
||||
|
||||
func (zl *zapLogger) WithName(name string) logr.LogSink {
|
||||
newLogger := *zl
|
||||
newLogger.l = zl.l.Named(name)
|
||||
return &newLogger
|
||||
}
|
||||
|
||||
func (zl *zapLogger) WithCallDepth(depth int) logr.LogSink {
|
||||
newLogger := *zl
|
||||
newLogger.l = zl.l.WithOptions(zap.AddCallerSkip(depth))
|
||||
return &newLogger
|
||||
}
|
||||
|
||||
// Underlier exposes access to the underlying logging implementation. Since
|
||||
// callers only have a logr.Logger, they have to know which implementation is
|
||||
// in use, so this interface is less of an abstraction and more of way to test
|
||||
// type conversion.
|
||||
type Underlier interface {
|
||||
GetUnderlying() *zap.Logger
|
||||
}
|
||||
|
||||
func (zl *zapLogger) GetUnderlying() *zap.Logger {
|
||||
return zl.l
|
||||
}
|
||||
|
||||
// NewLogger creates a new logr.Logger using the given Zap Logger to log.
|
||||
func NewLogger(l *zap.Logger) logr.Logger {
|
||||
return NewLoggerWithOptions(l)
|
||||
}
|
||||
|
||||
// NewLoggerWithOptions creates a new logr.Logger using the given Zap Logger to
|
||||
// log and applies additional options.
|
||||
func NewLoggerWithOptions(l *zap.Logger, opts ...Option) logr.Logger {
|
||||
// creates a new logger skipping one level of callstack
|
||||
log := l.WithOptions(zap.AddCallerSkip(1))
|
||||
zl := &zapLogger{
|
||||
l: log,
|
||||
}
|
||||
zl.errorKey = "error"
|
||||
zl.panicMessages = true
|
||||
for _, option := range opts {
|
||||
option(zl)
|
||||
}
|
||||
return logr.New(zl)
|
||||
}
|
||||
|
||||
// Option is one additional parameter for NewLoggerWithOptions.
|
||||
type Option func(*zapLogger)
|
||||
|
||||
// LogInfoLevel controls whether a numeric log level is added to
|
||||
// Info log message. The empty string disables this, a non-empty
|
||||
// string is the key for the additional field. Errors and
|
||||
// internal panic messages do not have a log level and thus
|
||||
// are always logged without this extra field.
|
||||
func LogInfoLevel(key string) Option {
|
||||
return func(zl *zapLogger) {
|
||||
zl.numericLevelKey = key
|
||||
}
|
||||
}
|
||||
|
||||
// ErrorKey replaces the default "error" field name used for the error
|
||||
// in Logger.Error calls.
|
||||
func ErrorKey(key string) Option {
|
||||
return func(zl *zapLogger) {
|
||||
zl.errorKey = key
|
||||
}
|
||||
}
|
||||
|
||||
// AllowZapFields controls whether strongly-typed Zap fields may
|
||||
// be passed instead of a key/value pair. This is disabled by
|
||||
// default because it breaks implementation agnosticism.
|
||||
func AllowZapFields(allowed bool) Option {
|
||||
return func(zl *zapLogger) {
|
||||
zl.allowZapFields = allowed
|
||||
}
|
||||
}
|
||||
|
||||
// DPanicOnBugs controls whether extra log messages are emitted for
|
||||
// invalid log calls with zap's DPanic method. Depending on the
|
||||
// configuration of the zap logger, the program then panics after
|
||||
// emitting the log message which is useful in development because
|
||||
// such invalid log calls are bugs in the program. The log messages
|
||||
// explain why a call was invalid (for example, non-string
|
||||
// key). Emitting them is enabled by default.
|
||||
func DPanicOnBugs(enabled bool) Option {
|
||||
return func(zl *zapLogger) {
|
||||
zl.panicMessages = enabled
|
||||
}
|
||||
}
|
||||
|
||||
var _ logr.LogSink = &zapLogger{}
|
||||
var _ logr.CallDepthLogSink = &zapLogger{}
|
Reference in New Issue
Block a user