Add SafePtr wrapper #393

kaisoz · 2023-11-12T22:24:25Z

What this PR does / why we need it:

If a nil pointer value is provided when logging, it will be dereferenced leading to a panic message. This PR adds a simple wrapper called SafePtr which helps preventing this by returning a nil interface in case the provided pointer is nil, or the same pointer if it's not nil.

This function is available when compiling with Go >= 1.18 since it uses generics.

Release note:

Add SafePtr wrapper

k8s-ci-robot · 2023-11-12T22:24:34Z

Welcome @kaisoz!

It looks like this is your first PR to kubernetes/klog 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/klog has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

pohly

Some small nits, looks good overall.

safeptr.go

kaisoz · 2023-11-13T09:57:36Z

Some small nits, looks good overall.

Thanks for the review @pohly , I've added your suggestions 😊

safeptr.go

kaisoz · 2023-11-13T12:43:25Z

Done @pohly, I've rewritten the function description, let me know what you think 😊

safeptr.go

pohly

/lgtm
/approve

harshanarayana · 2023-11-15T07:38:02Z

/lgtm

pohly · 2023-11-15T11:02:36Z

/assign @dims

For approval. Should we update the OWNERS so that I can approve and remove @serathius?

dims · 2023-11-15T11:06:48Z

/lgtm
/approve

dims · 2023-11-15T11:07:05Z

For approval. Should we update the OWNERS so that I can approve and remove @serathius?

Yes please @pohly

kaisoz · 2023-11-16T09:09:42Z

I'll fix the lint fails. Not sure why the check is failing with 1.19 though, I'll have a closer look

dgrisonnet · 2023-11-16T17:43:39Z

/assign @pohly
/triage accepted

kaisoz · 2023-11-17T16:12:29Z

I fixed the lint problem but the lgtm got removed and is not running the rest of the tests. @pohly @dims could you please re-lgtm it? Thanks!

pohly

/lgtm

We might need to do something about the Go version dependency, but let's see whether this triggers another test run.

k8s-ci-robot · 2023-11-17T16:14:09Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dims, harshanarayana, kaisoz, pohly

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [dims,pohly]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

pohly · 2023-11-17T16:14:39Z

/ok-to-test

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [k8s.io/klog/v2](https://togithub.com/kubernetes/klog) | `v2.110.1` -> `v2.120.1` | [![age](https://developer.mend.io/api/mc/badges/age/go/k8s.io%2fklog%2fv2/v2.120.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/go/k8s.io%2fklog%2fv2/v2.120.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/go/k8s.io%2fklog%2fv2/v2.110.1/v2.120.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/go/k8s.io%2fklog%2fv2/v2.110.1/v2.120.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>kubernetes/klog (k8s.io/klog/v2)</summary> ### [`v2.120.1`](https://togithub.com/kubernetes/klog/releases/tag/v2.120.1): Prepare klog release for Kubernetes v1.30 (Take 2) [Compare Source](https://togithub.com/kubernetes/klog/compare/v2.120.0...v2.120.1) #### What's Changed - textlogger: allow caller to override stack unwinding by [@pohly](https://togithub.com/pohly) in [kubernetes/klog#397 **Full Changelog**: kubernetes/klog@v2.120.0...v2.120.1 ### [`v2.120.0`](https://togithub.com/kubernetes/klog/releases/tag/v2.120.0): Prepare klog release for Kubernetes v1.30 (Take 1) [Compare Source](https://togithub.com/kubernetes/klog/compare/v2.110.1...v2.120.0) #### What's Changed - OWNERS: remove serathius, add mengjiao-liu, promote pohly by [@pohly](https://togithub.com/pohly) in [kubernetes/klog#394 - docs: clarify relationship between different features by [@pohly](https://togithub.com/pohly) in [kubernetes/klog#395 - Add SafePtr wrapper by [@kaisoz](https://togithub.com/kaisoz) in [kubernetes/klog#393 - logr v1.4.1 + SetSlogLogger by [@pohly](https://togithub.com/pohly) in [kubernetes/klog#396 #### New Contributors - [@kaisoz](https://togithub.com/kaisoz) made their first contribution in [kubernetes/klog#393 **Full Changelog**: kubernetes/klog@v2.110.1...v2.120.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "on tuesday" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/open-telemetry/opentelemetry-collector-contrib).  --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: opentelemetrybot <107717825+opentelemetrybot@users.noreply.github.com>

…1721) [![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [k8s.io/klog/v2](https://togithub.com/kubernetes/klog) | `v2.110.1` -> `v2.120.1` | [![age](https://developer.mend.io/api/mc/badges/age/go/k8s.io%2fklog%2fv2/v2.120.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/go/k8s.io%2fklog%2fv2/v2.120.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/go/k8s.io%2fklog%2fv2/v2.110.1/v2.120.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/go/k8s.io%2fklog%2fv2/v2.110.1/v2.120.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>kubernetes/klog (k8s.io/klog/v2)</summary> ### [`v2.120.1`](https://togithub.com/kubernetes/klog/releases/tag/v2.120.1): Prepare klog release for Kubernetes v1.30 (Take 2) [Compare Source](https://togithub.com/kubernetes/klog/compare/v2.120.0...v2.120.1) #### What's Changed - textlogger: allow caller to override stack unwinding by [@&open-telemetry#8203;pohly](https://togithub.com/pohly) in [kubernetes/klog#397 **Full Changelog**: kubernetes/klog@v2.120.0...v2.120.1 ### [`v2.120.0`](https://togithub.com/kubernetes/klog/releases/tag/v2.120.0): Prepare klog release for Kubernetes v1.30 (Take 1) [Compare Source](https://togithub.com/kubernetes/klog/compare/v2.110.1...v2.120.0) #### What's Changed - OWNERS: remove serathius, add mengjiao-liu, promote pohly by [@&open-telemetry#8203;pohly](https://togithub.com/pohly) in [kubernetes/klog#394 - docs: clarify relationship between different features by [@&open-telemetry#8203;pohly](https://togithub.com/pohly) in [kubernetes/klog#395 - Add SafePtr wrapper by [@&open-telemetry#8203;kaisoz](https://togithub.com/kaisoz) in [kubernetes/klog#393 - logr v1.4.1 + SetSlogLogger by [@&open-telemetry#8203;pohly](https://togithub.com/pohly) in [kubernetes/klog#396 #### New Contributors - [@&open-telemetry#8203;kaisoz](https://togithub.com/kaisoz) made their first contribution in [kubernetes/klog#393 **Full Changelog**: kubernetes/klog@v2.110.1...v2.120.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "on tuesday" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/open-telemetry/opentelemetry-collector-contrib).  --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: opentelemetrybot <107717825+opentelemetrybot@users.noreply.github.com>

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 12, 2023

k8s-ci-robot requested review from harshanarayana and pohly November 12, 2023 22:24

k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Nov 12, 2023

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Nov 12, 2023

kaisoz mentioned this pull request Nov 12, 2023

Check if time is nil before logging kubernetes/kubernetes#121554

Merged

pohly suggested changes Nov 13, 2023

View reviewed changes

safeptr.go Outdated Show resolved Hide resolved

safeptr.go Outdated Show resolved Hide resolved

safeptr.go Outdated Show resolved Hide resolved

pohly reviewed Nov 13, 2023

View reviewed changes

safeptr.go Show resolved Hide resolved

kaisoz force-pushed the add-safeptr branch from 592a1a2 to 567f8f8 Compare November 13, 2023 12:41

pohly reviewed Nov 13, 2023

View reviewed changes

safeptr.go Outdated Show resolved Hide resolved

kaisoz force-pushed the add-safeptr branch from 567f8f8 to e70759b Compare November 14, 2023 12:53

pohly approved these changes Nov 14, 2023

View reviewed changes

k8s-ci-robot assigned pohly Nov 14, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 14, 2023

k8s-ci-robot assigned harshanarayana Nov 15, 2023

k8s-ci-robot assigned dims Nov 15, 2023

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 15, 2023

k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Nov 16, 2023

Add SafePtr wrapper

881fa0b

kaisoz force-pushed the add-safeptr branch from e70759b to 881fa0b Compare November 17, 2023 16:07

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 17, 2023

pohly approved these changes Nov 17, 2023

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 17, 2023

k8s-ci-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Nov 17, 2023

k8s-ci-robot merged commit 2086216 into kubernetes:main Nov 17, 2023
2 checks passed

This was referenced Nov 20, 2023

Job controller keeps logging panics kubernetes/kubernetes#121392

Closed

REQUEST: New membership for kaisoz kubernetes/org#4592

Closed

kaisoz deleted the add-safeptr branch December 20, 2023 10:56

pacoxu mentioned this pull request Jan 11, 2024

bump klog to v2.120.0 kubernetes/kubernetes#122706

Merged

cluster-stack-bot bot mentioned this pull request Apr 18, 2024

🌱 Update Update Golang Dependencies group (minor) SovereignCloudStack/cluster-stack-operator#127

Open

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add SafePtr wrapper #393

Add SafePtr wrapper #393

kaisoz commented Nov 12, 2023 •

edited

k8s-ci-robot commented Nov 12, 2023

pohly left a comment

kaisoz commented Nov 13, 2023

kaisoz commented Nov 13, 2023

pohly left a comment

harshanarayana commented Nov 15, 2023

pohly commented Nov 15, 2023

dims commented Nov 15, 2023

dims commented Nov 15, 2023

kaisoz commented Nov 16, 2023

dgrisonnet commented Nov 16, 2023

kaisoz commented Nov 17, 2023

pohly left a comment

k8s-ci-robot commented Nov 17, 2023

pohly commented Nov 17, 2023

Add SafePtr wrapper #393

Add SafePtr wrapper #393

Conversation

kaisoz commented Nov 12, 2023 • edited

k8s-ci-robot commented Nov 12, 2023

pohly left a comment

Choose a reason for hiding this comment

kaisoz commented Nov 13, 2023

kaisoz commented Nov 13, 2023

pohly left a comment

Choose a reason for hiding this comment

harshanarayana commented Nov 15, 2023

pohly commented Nov 15, 2023

dims commented Nov 15, 2023

dims commented Nov 15, 2023

kaisoz commented Nov 16, 2023

dgrisonnet commented Nov 16, 2023

kaisoz commented Nov 17, 2023

pohly left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Nov 17, 2023

pohly commented Nov 17, 2023

kaisoz commented Nov 12, 2023 •

edited