-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This splits up pkg/runtime/log into pkg/log, pkg/internal/log, and pkg/log/zap. - pkg/log contains generic logging helpers, and the generic root logger It *only* depends on logr, and thus won't pull in Zap if you don't need it. - pkg/internal/log contains the internal log handle (with the appropriate name). Nothing outside CR should be logging with this handle anyway, so this enforces it. - pkg/log/zap contains Zap-related setup code, and thus CR only has a dependency on Zap if you pull in this package. - pkg/runtime/log remains as a deprecated package to ease refactoring and compatibility. While practically a few types have been removed from this package, in reality most consumers shouldn't notice.
- Loading branch information
1 parent
b15adb2
commit c2254ef
Showing
11 changed files
with
433 additions
and
205 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
/* | ||
Copyright 2018 The Kubernetes 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. | ||
*/ | ||
|
||
// Package log contains utilities for fetching a new logger | ||
// when one is not already available. | ||
// Deprecated: use pkg/log | ||
package log | ||
|
||
import ( | ||
"github.com/go-logr/logr" | ||
|
||
"sigs.k8s.io/controller-runtime/pkg/log" | ||
) | ||
|
||
var ( | ||
// RuntimeLog is a base parent logger for use inside controller-runtime. | ||
RuntimeLog logr.Logger | ||
) | ||
|
||
func init() { | ||
RuntimeLog = log.Log.WithName("controller-runtime") | ||
} |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
/* | ||
Copyright 2018 The Kubernetes 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. | ||
*/ | ||
|
||
// Package log contains utilities for fetching a new logger | ||
// when one is not already available. | ||
// Deprecated: use pkg/log | ||
package log | ||
|
||
import ( | ||
"github.com/go-logr/logr" | ||
) | ||
|
||
// SetLogger sets a concrete logging implementation for all deferred Loggers. | ||
func SetLogger(l logr.Logger) { | ||
Log.Fulfill(l) | ||
} | ||
|
||
// Log is the base logger used by kubebuilder. It delegates | ||
// to another logr.Logger. You *must* call SetLogger to | ||
// get any actual logging. | ||
var Log = NewDelegatingLogger(NullLogger{}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
/* | ||
Copyright 2019 The Kubernetes 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. | ||
*/ | ||
|
||
// Package zap contains helpers for setting up a new logr.Logger instance | ||
// using the Zap logging framework. | ||
package zap | ||
|
||
import ( | ||
"io" | ||
"os" | ||
"time" | ||
|
||
"github.com/go-logr/logr" | ||
"github.com/go-logr/zapr" | ||
"go.uber.org/zap" | ||
"go.uber.org/zap/zapcore" | ||
) | ||
|
||
// Logger is a Logger implementation. | ||
// If development is true, a Zap development config will be used | ||
// (stacktraces on warnings, no sampling), otherwise a Zap production | ||
// config will be used (stacktraces on errors, sampling). | ||
func Logger(development bool) logr.Logger { | ||
return LoggerTo(os.Stderr, development) | ||
} | ||
|
||
// LoggerTo returns a new Logger implementation using Zap which logs | ||
// to the given destination, instead of stderr. It otherise behaves like | ||
// ZapLogger. | ||
func LoggerTo(destWriter io.Writer, development bool) logr.Logger { | ||
// this basically mimics New<type>Config, but with a custom sink | ||
sink := zapcore.AddSync(destWriter) | ||
|
||
var enc zapcore.Encoder | ||
var lvl zap.AtomicLevel | ||
var opts []zap.Option | ||
if development { | ||
encCfg := zap.NewDevelopmentEncoderConfig() | ||
enc = zapcore.NewConsoleEncoder(encCfg) | ||
lvl = zap.NewAtomicLevelAt(zap.DebugLevel) | ||
opts = append(opts, zap.Development(), zap.AddStacktrace(zap.ErrorLevel)) | ||
} else { | ||
encCfg := zap.NewProductionEncoderConfig() | ||
enc = zapcore.NewJSONEncoder(encCfg) | ||
lvl = zap.NewAtomicLevelAt(zap.InfoLevel) | ||
opts = append(opts, zap.AddStacktrace(zap.WarnLevel), | ||
zap.WrapCore(func(core zapcore.Core) zapcore.Core { | ||
return zapcore.NewSampler(core, time.Second, 100, 100) | ||
})) | ||
} | ||
opts = append(opts, zap.AddCallerSkip(1), zap.ErrorOutput(sink)) | ||
log := zap.New(zapcore.NewCore(&KubeAwareEncoder{Encoder: enc, Verbose: development}, sink, lvl)) | ||
log = log.WithOptions(opts...) | ||
return zapr.NewLogger(log) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
/* | ||
Copyright 2018 The Kubernetes 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. | ||
*/ | ||
|
||
package zap | ||
|
||
import ( | ||
"testing" | ||
|
||
. "github.com/onsi/ginkgo" | ||
. "github.com/onsi/gomega" | ||
"sigs.k8s.io/controller-runtime/pkg/envtest/printer" | ||
) | ||
|
||
func TestSource(t *testing.T) { | ||
RegisterFailHandler(Fail) | ||
RunSpecsWithDefaultAndCustomReporters(t, "Zap Log Suite", []Reporter{printer.NewlineReporter{}}) | ||
} |
Oops, something went wrong.