From d69ae811d6992d0584c7aec5a685eab58404eb69 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Mon, 11 Sep 2023 21:28:02 -0700 Subject: [PATCH 1/2] alias log package to github.com/containerd/log v0.1.0 This "soft" deprecates the package, but keeps the local uses of the package, which can make backporting this to release-branches easier (we can still move all uses in those branches as well though). Signed-off-by: Sebastiaan van Stijn --- go.mod | 1 + go.sum | 2 + integration/client/go.mod | 1 + integration/client/go.sum | 2 + log/context_deprecated.go | 107 ++++++++++ log/context_test.go | 63 ------ log/logtest/context_deprecated.go | 31 +++ .../github.com/containerd/log/.golangci.yml | 30 +++ vendor/github.com/containerd/log/LICENSE | 191 ++++++++++++++++++ vendor/github.com/containerd/log/README.md | 17 ++ .../github.com/containerd/log}/context.go | 0 .../containerd/log}/logtest/context.go | 2 +- .../containerd/log}/logtest/log_hook.go | 0 vendor/modules.txt | 4 + 14 files changed, 387 insertions(+), 64 deletions(-) create mode 100644 log/context_deprecated.go delete mode 100644 log/context_test.go create mode 100644 log/logtest/context_deprecated.go create mode 100644 vendor/github.com/containerd/log/.golangci.yml create mode 100644 vendor/github.com/containerd/log/LICENSE create mode 100644 vendor/github.com/containerd/log/README.md rename {log => vendor/github.com/containerd/log}/context.go (100%) rename {log => vendor/github.com/containerd/log}/logtest/context.go (97%) rename {log => vendor/github.com/containerd/log}/logtest/log_hook.go (100%) diff --git a/go.mod b/go.mod index 04a980a3e..2175e602d 100644 --- a/go.mod +++ b/go.mod @@ -17,6 +17,7 @@ require ( github.com/containerd/go-cni v1.1.9 github.com/containerd/go-runc v1.1.0 github.com/containerd/imgcrypt v1.1.7 + github.com/containerd/log v0.1.0 github.com/containerd/nri v0.5.0 github.com/containerd/ttrpc v1.2.2 github.com/containerd/typeurl/v2 v2.1.1 diff --git a/go.sum b/go.sum index 9bcb1b9b3..2fd1eb19f 100644 --- a/go.sum +++ b/go.sum @@ -267,6 +267,8 @@ github.com/containerd/imgcrypt v1.1.3/go.mod h1:/TPA1GIDXMzbj01yd8pIbQiLdQxed5ue github.com/containerd/imgcrypt v1.1.4/go.mod h1:LorQnPtzL/T0IyCeftcsMEO7AqxUDbdO8j/tSUpgxvo= github.com/containerd/imgcrypt v1.1.7 h1:WSf9o9EQ0KGHiUx2ESFZ+PKf4nxK9BcvV/nJDX8RkB4= github.com/containerd/imgcrypt v1.1.7/go.mod h1:FD8gqIcX5aTotCtOmjeCsi3A1dHmTZpnMISGKSczt4k= +github.com/containerd/log v0.1.0 h1:TCJt7ioM2cr/tfR8GPbGf9/VRAX8D2B4PjzCpfX540I= +github.com/containerd/log v0.1.0/go.mod h1:VRRf09a7mHDIRezVKTRCrOq78v577GXq3bSa3EhrzVo= github.com/containerd/nri v0.0.0-20201007170849-eb1350a75164/go.mod h1:+2wGSDGFYfE5+So4M5syatU0N0f0LbWpuqyMi4/BE8c= github.com/containerd/nri v0.0.0-20210316161719-dbaa18c31c14/go.mod h1:lmxnXF6oMkbqs39FiCt1s0R2HSMhcLel9vNL3m4AaeY= github.com/containerd/nri v0.1.0/go.mod h1:lmxnXF6oMkbqs39FiCt1s0R2HSMhcLel9vNL3m4AaeY= diff --git a/integration/client/go.mod b/integration/client/go.mod index b6ef27bb6..8683c03d3 100644 --- a/integration/client/go.mod +++ b/integration/client/go.mod @@ -29,6 +29,7 @@ require ( github.com/container-orchestrated-devices/container-device-interface v0.6.1 // indirect github.com/containerd/console v1.0.3 // indirect github.com/containerd/fifo v1.1.0 // indirect + github.com/containerd/log v0.1.0 // indirect github.com/coreos/go-systemd/v22 v22.5.0 // indirect github.com/davecgh/go-spew v1.1.1 // indirect github.com/distribution/reference v0.5.0 // indirect diff --git a/integration/client/go.sum b/integration/client/go.sum index ba8cd7f2c..3d925e0cd 100644 --- a/integration/client/go.sum +++ b/integration/client/go.sum @@ -896,6 +896,8 @@ github.com/containerd/go-runc v1.0.0/go.mod h1:cNU0ZbCgCQVZK4lgG3P+9tn9/PaJNmoDX github.com/containerd/go-runc v1.1.0 h1:OX4f+/i2y5sUT7LhmcJH7GYrjjhHa1QI4e8yO0gGleA= github.com/containerd/go-runc v1.1.0/go.mod h1:xJv2hFF7GvHtTJd9JqTS2UVxMkULUYw4JN5XAUZqH5U= github.com/containerd/imgcrypt v1.1.7/go.mod h1:FD8gqIcX5aTotCtOmjeCsi3A1dHmTZpnMISGKSczt4k= +github.com/containerd/log v0.1.0 h1:TCJt7ioM2cr/tfR8GPbGf9/VRAX8D2B4PjzCpfX540I= +github.com/containerd/log v0.1.0/go.mod h1:VRRf09a7mHDIRezVKTRCrOq78v577GXq3bSa3EhrzVo= github.com/containerd/nri v0.5.0/go.mod h1:qIu2NlP3r/qK4YGnNuQf0De4VPqQWP2i2CVBfAZbGzg= github.com/containerd/protobuild v0.3.0/go.mod h1:5mNMFKKAwCIAkFBPiOdtRx2KiQlyEJeMXnL5R1DsWu8= github.com/containerd/stargz-snapshotter/estargz v0.4.1/go.mod h1:x7Q9dg9QYb4+ELgxmo4gBUeJB0tl5dqH1Sdz0nJU1QM= diff --git a/log/context_deprecated.go b/log/context_deprecated.go new file mode 100644 index 000000000..08bf2b748 --- /dev/null +++ b/log/context_deprecated.go @@ -0,0 +1,107 @@ +/* + Copyright The containerd 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 + +import ( + "context" + + "github.com/containerd/log" +) + +// G is a shorthand for [GetLogger]. +var G = log.G + +// L is an alias for the standard logger. +var L = log.L + +// Fields type to pass to "WithFields". +type Fields = log.Fields + +// Entry is a logging entry. +type Entry = log.Entry + +// RFC3339NanoFixed is [time.RFC3339Nano] with nanoseconds padded using +// zeros to ensure the formatted time is always the same number of +// characters. +const RFC3339NanoFixed = log.RFC3339NanoFixed + +// Level is a logging level. +type Level = log.Level + +// Supported log levels. +const ( + // TraceLevel level. + TraceLevel Level = log.TraceLevel + + // DebugLevel level. + DebugLevel Level = log.DebugLevel + + // InfoLevel level. + InfoLevel Level = log.InfoLevel + + // WarnLevel level. + WarnLevel Level = log.WarnLevel + + // ErrorLevel level + ErrorLevel Level = log.ErrorLevel + + // FatalLevel level. + FatalLevel Level = log.FatalLevel + + // PanicLevel level. + PanicLevel Level = log.PanicLevel +) + +// SetLevel sets log level globally. It returns an error if the given +// level is not supported. +func SetLevel(level string) error { + return log.SetLevel(level) +} + +// GetLevel returns the current log level. +func GetLevel() log.Level { + return log.GetLevel() +} + +// OutputFormat specifies a log output format. +type OutputFormat = log.OutputFormat + +// Supported log output formats. +const ( + // TextFormat represents the text logging format. + TextFormat log.OutputFormat = "text" + + // JSONFormat represents the JSON logging format. + JSONFormat log.OutputFormat = "json" +) + +// SetFormat sets the log output format. +func SetFormat(format OutputFormat) error { + return log.SetFormat(format) +} + +// WithLogger returns a new context with the provided logger. Use in +// combination with logger.WithField(s) for great effect. +func WithLogger(ctx context.Context, logger *log.Entry) context.Context { + return log.WithLogger(ctx, logger) +} + +// GetLogger retrieves the current logger from the context. If no logger is +// available, the default logger is returned. +func GetLogger(ctx context.Context) *log.Entry { + return log.GetLogger(ctx) +} diff --git a/log/context_test.go b/log/context_test.go deleted file mode 100644 index 1b6d4a6cf..000000000 --- a/log/context_test.go +++ /dev/null @@ -1,63 +0,0 @@ -/* - Copyright The containerd 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 - -import ( - "context" - "reflect" - "testing" - - "github.com/sirupsen/logrus" -) - -func TestLoggerContext(t *testing.T) { - const expected = "one" - ctx := context.Background() - ctx = WithLogger(ctx, G(ctx).WithField("test", expected)) - if actual := GetLogger(ctx).Data["test"]; actual != expected { - t.Errorf("expected: %v, got: %v", expected, actual) - } - a := G(ctx) - b := GetLogger(ctx) - if !reflect.DeepEqual(a, b) || a != b { - t.Errorf("should be the same: %+v, %+v", a, b) - } -} - -func TestCompat(t *testing.T) { - expected := Fields{ - "hello1": "world1", - "hello2": "world2", - "hello3": "world3", - } - - l := G(context.TODO()) - l = l.WithFields(logrus.Fields{"hello1": "world1"}) - l = l.WithFields(Fields{"hello2": "world2"}) - l = l.WithFields(map[string]any{"hello3": "world3"}) - if !reflect.DeepEqual(Fields(l.Data), expected) { - t.Errorf("expected: (%[1]T) %+[1]v, got: (%[2]T) %+[2]v", expected, l.Data) - } - - l2 := L - l2 = l2.WithFields(logrus.Fields{"hello1": "world1"}) - l2 = l2.WithFields(Fields{"hello2": "world2"}) - l2 = l2.WithFields(map[string]any{"hello3": "world3"}) - if !reflect.DeepEqual(Fields(l2.Data), expected) { - t.Errorf("expected: (%[1]T) %+[1]v, got: (%[2]T) %+[2]v", expected, l2.Data) - } -} diff --git a/log/logtest/context_deprecated.go b/log/logtest/context_deprecated.go new file mode 100644 index 000000000..80e5724c7 --- /dev/null +++ b/log/logtest/context_deprecated.go @@ -0,0 +1,31 @@ +/* + Copyright The containerd 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 logtest + +import ( + "context" + "testing" + + "github.com/containerd/log/logtest" +) + +// WithT adds a logging hook for the given test +// Changes debug level to debug, clears output, and +// outputs all log messages as test logs. +func WithT(ctx context.Context, t testing.TB) context.Context { + return logtest.WithT(ctx, t) +} diff --git a/vendor/github.com/containerd/log/.golangci.yml b/vendor/github.com/containerd/log/.golangci.yml new file mode 100644 index 000000000..a695775df --- /dev/null +++ b/vendor/github.com/containerd/log/.golangci.yml @@ -0,0 +1,30 @@ +linters: + enable: + - exportloopref # Checks for pointers to enclosing loop variables + - gofmt + - goimports + - gosec + - ineffassign + - misspell + - nolintlint + - revive + - staticcheck + - tenv # Detects using os.Setenv instead of t.Setenv since Go 1.17 + - unconvert + - unused + - vet + - dupword # Checks for duplicate words in the source code + disable: + - errcheck + +run: + timeout: 5m + skip-dirs: + - api + - cluster + - design + - docs + - docs/man + - releases + - reports + - test # e2e scripts diff --git a/vendor/github.com/containerd/log/LICENSE b/vendor/github.com/containerd/log/LICENSE new file mode 100644 index 000000000..584149b6e --- /dev/null +++ b/vendor/github.com/containerd/log/LICENSE @@ -0,0 +1,191 @@ + + Apache License + Version 2.0, January 2004 + https://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 + + Copyright The containerd 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 + + https://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. diff --git a/vendor/github.com/containerd/log/README.md b/vendor/github.com/containerd/log/README.md new file mode 100644 index 000000000..00e084988 --- /dev/null +++ b/vendor/github.com/containerd/log/README.md @@ -0,0 +1,17 @@ +# log + +A Go package providing a common logging interface across containerd repositories and a way for clients to use and configure logging in containerd packages. + +This package is not intended to be used as a standalone logging package outside of the containerd ecosystem and is intended as an interface wrapper around a logging implementation. +In the future this package may be replaced with a common go logging interface. + +## Project details + +**log** is a containerd sub-project, licensed under the [Apache 2.0 license](./LICENSE). +As a containerd sub-project, you will find the: + * [Project governance](https://github.com/containerd/project/blob/main/GOVERNANCE.md), + * [Maintainers](https://github.com/containerd/project/blob/main/MAINTAINERS), + * and [Contributing guidelines](https://github.com/containerd/project/blob/main/CONTRIBUTING.md) + +information in our [`containerd/project`](https://github.com/containerd/project) repository. + diff --git a/log/context.go b/vendor/github.com/containerd/log/context.go similarity index 100% rename from log/context.go rename to vendor/github.com/containerd/log/context.go diff --git a/log/logtest/context.go b/vendor/github.com/containerd/log/logtest/context.go similarity index 97% rename from log/logtest/context.go rename to vendor/github.com/containerd/log/logtest/context.go index 305bd8080..cbf3882f1 100644 --- a/log/logtest/context.go +++ b/vendor/github.com/containerd/log/logtest/context.go @@ -24,7 +24,7 @@ import ( "runtime" "testing" - "github.com/containerd/containerd/log" + "github.com/containerd/log" "github.com/sirupsen/logrus" ) diff --git a/log/logtest/log_hook.go b/vendor/github.com/containerd/log/logtest/log_hook.go similarity index 100% rename from log/logtest/log_hook.go rename to vendor/github.com/containerd/log/logtest/log_hook.go diff --git a/vendor/modules.txt b/vendor/modules.txt index 0fcace09e..3edaa188a 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -127,6 +127,10 @@ github.com/containerd/go-runc ## explicit; go 1.16 github.com/containerd/imgcrypt github.com/containerd/imgcrypt/images/encryption +# github.com/containerd/log v0.1.0 +## explicit; go 1.20 +github.com/containerd/log +github.com/containerd/log/logtest # github.com/containerd/nri v0.5.0 ## explicit; go 1.19 github.com/containerd/nri From 03b9ce56b51ee59025d1b7b449ca61143c25ea6b Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Wed, 13 Sep 2023 14:10:41 +0200 Subject: [PATCH 2/2] deprecate logs package, but disable linter (for transitioning) Deprecate the pacakge, but suppress linting errors for now. This is to allow backporting these changes to release branches, which may still need to transition. Signed-off-by: Sebastiaan van Stijn --- .golangci.yml | 9 +++++++ log/context_deprecated.go | 42 +++++++++++++++++++++++++++++++ log/logtest/context_deprecated.go | 2 ++ 3 files changed, 53 insertions(+) diff --git a/.golangci.yml b/.golangci.yml index fec369f6d..4848dc9fe 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -51,6 +51,15 @@ issues: - revive text: "redefines-builtin-id" + # FIXME temporarily suppress deprecation warnings for the logs package. See https://github.com/containerd/containerd/pull/9086 + - text: "SA1019: log\\.(G|L|Fields|Entry|RFC3339NanoFixed|Level|TraceLevel|DebugLevel|InfoLevel|WarnLevel|ErrorLevel|FatalLevel|PanicLevel|SetLevel|GetLevel|OutputFormat|TextFormat|JSONFormat|SetFormat|WithLogger|GetLogger)" + linters: + - staticcheck + - text: "SA1019: logtest\\.WithT" + linters: + - staticcheck + + linters-settings: gosec: # The following issues surfaced when `gosec` linter diff --git a/log/context_deprecated.go b/log/context_deprecated.go index 08bf2b748..9e9e8b491 100644 --- a/log/context_deprecated.go +++ b/log/context_deprecated.go @@ -23,85 +23,127 @@ import ( ) // G is a shorthand for [GetLogger]. +// +// Deprecated: use [log.G]. var G = log.G // L is an alias for the standard logger. +// +// Deprecated: use [log.L]. var L = log.L // Fields type to pass to "WithFields". +// +// Deprecated: use [log.Fields]. type Fields = log.Fields // Entry is a logging entry. +// +// Deprecated: use [log.Entry]. type Entry = log.Entry // RFC3339NanoFixed is [time.RFC3339Nano] with nanoseconds padded using // zeros to ensure the formatted time is always the same number of // characters. +// +// Deprecated: use [log.RFC3339NanoFixed]. const RFC3339NanoFixed = log.RFC3339NanoFixed // Level is a logging level. +// +// Deprecated: use [log.Level]. type Level = log.Level // Supported log levels. const ( // TraceLevel level. + // + // Deprecated: use [log.TraceLevel]. TraceLevel Level = log.TraceLevel // DebugLevel level. + // + // Deprecated: use [log.DebugLevel]. DebugLevel Level = log.DebugLevel // InfoLevel level. + // + // Deprecated: use [log.InfoLevel]. InfoLevel Level = log.InfoLevel // WarnLevel level. + // + // Deprecated: use [log.WarnLevel]. WarnLevel Level = log.WarnLevel // ErrorLevel level + // + // Deprecated: use [log.ErrorLevel]. ErrorLevel Level = log.ErrorLevel // FatalLevel level. + // + // Deprecated: use [log.FatalLevel]. FatalLevel Level = log.FatalLevel // PanicLevel level. + // + // Deprecated: use [log.PanicLevel]. PanicLevel Level = log.PanicLevel ) // SetLevel sets log level globally. It returns an error if the given // level is not supported. +// +// Deprecated: use [log.SetLevel]. func SetLevel(level string) error { return log.SetLevel(level) } // GetLevel returns the current log level. +// +// Deprecated: use [log.GetLevel]. func GetLevel() log.Level { return log.GetLevel() } // OutputFormat specifies a log output format. +// +// Deprecated: use [log.OutputFormat]. type OutputFormat = log.OutputFormat // Supported log output formats. const ( // TextFormat represents the text logging format. + // + // Deprecated: use [log.TextFormat]. TextFormat log.OutputFormat = "text" // JSONFormat represents the JSON logging format. + // + // Deprecated: use [log.JSONFormat]. JSONFormat log.OutputFormat = "json" ) // SetFormat sets the log output format. +// +// Deprecated: use [log.SetFormat]. func SetFormat(format OutputFormat) error { return log.SetFormat(format) } // WithLogger returns a new context with the provided logger. Use in // combination with logger.WithField(s) for great effect. +// +// Deprecated: use [log.WithLogger]. func WithLogger(ctx context.Context, logger *log.Entry) context.Context { return log.WithLogger(ctx, logger) } // GetLogger retrieves the current logger from the context. If no logger is // available, the default logger is returned. +// +// Deprecated: use [log.GetLogger]. func GetLogger(ctx context.Context) *log.Entry { return log.GetLogger(ctx) } diff --git a/log/logtest/context_deprecated.go b/log/logtest/context_deprecated.go index 80e5724c7..10bbea611 100644 --- a/log/logtest/context_deprecated.go +++ b/log/logtest/context_deprecated.go @@ -26,6 +26,8 @@ import ( // WithT adds a logging hook for the given test // Changes debug level to debug, clears output, and // outputs all log messages as test logs. +// +// Deprecated: use [logtest.WithT]. func WithT(ctx context.Context, t testing.TB) context.Context { return logtest.WithT(ctx, t) }