-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This is useful for objects where zap would prefer to log as string or when reflection doesn't pick up the desired fields (unexported or too many).
- Loading branch information
Showing
6 changed files
with
73 additions
and
21 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
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
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,50 @@ | ||
| /* | ||
| Copyright 2021 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. | ||
| */ | ||
|
|
||
| package types | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/go-logr/logr" | ||
| ) | ||
|
|
||
| // ObjectRef references a Kubernetes object | ||
| type ObjectRef struct { | ||
| Name string `json:"name"` | ||
| Namespace string `json:"namespace,omitempty"` | ||
| } | ||
|
|
||
| func (ref ObjectRef) String() string { | ||
| if ref.Namespace != "" { | ||
| return fmt.Sprintf("%s/%s", ref.Namespace, ref.Name) | ||
| } | ||
| return ref.Name | ||
| } | ||
|
|
||
| // MarshalLog ensures that loggers with structured output ignore the String method. | ||
| // | ||
| // We implement fmt.Stringer for non-structured logging, but we want the | ||
| // raw struct when using structured logs. Some logr implementations call | ||
| // String if it is present, so we want to convert this struct to something | ||
| // that doesn't have that method. | ||
| func (ref ObjectRef) MarshalLog() interface{} { | ||
| // Methods do not survive type definitions. | ||
| type forLog ObjectRef | ||
| return forLog(ref) | ||
| } | ||
|
|
||
| var _ logr.Marshaler = ObjectRef{} |
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