Refactoring the Logging Logic #557

v0lkan · 2024-02-22T07:31:49Z

Refactoring the Logging Logic

Description

This PR moves the gRPC log to the core package and introduces a bunch of documentation updates and minor code fixes.

Test Policy Compliance

I have added or updated unit tests for my changes.
I have included integration tests where applicable.
All new and existing tests pass successfully.

Code Quality

I have followed the coding standards for this project.
I have performed a self-review of my code.
My code is well-commented, particularly in areas that may be difficult
to understand.

Documentation

I have made corresponding changes to the documentation (if applicable).
I have updated any relevant READMEs or wiki pages.

Checklist

Before you submit this PR, please make sure:

You have read the contributing guidelines and
especially the test policy.
You have thoroughly tested your changes.
You have followed all the contributing guidelines for this project.
You understand and agree that your contributions will be publicly available
under the project’s license.

By submitting this pull request, you confirm that my contribution is made under
the terms of the project’s license and that you have the authority to grant
these rights.

Thank you for your contribution to VMware Secrets Manager
🐢⚡️!

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

consolidated logging and moved rpc logging to core Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

grpc generation was failing Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

vmwclabot · 2024-02-22T07:31:52Z

@v0lkan, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 8060bbc must be signed by ovolkan@vmware.com

v0lkan · 2024-02-22T16:20:49Z

README.md

@@ -4,7 +4,7 @@
 [![Version](https://img.shields.io/github/v/release/vmware-tanzu/secrets-manager?color=blueviolet)](https://github.com/vmware-tanzu/secrets-manager/releases)
 [![Contributors](https://img.shields.io/github/contributors/vmware-tanzu/secrets-manager.svg?color=orange)](https://github.com/vmware-tanzu/secrets-manager/graphs/contributors)
 [![Slack](https://img.shields.io/badge/slack-vsecm-brightgreen.svg?logo=slack)](https://join.slack.com/t/a-101-103-105-s/shared_invite/zt-287dbddk7-GCX495NK~FwO3bh_DAMAtQ)
-[![Twitch](https://img.shields.io/twitch/status/zerotoherodev)](https://twitch.tv/ZeroToHeroDev)
+[![Twitch](https://img.shields.io/twitch/status/vadidekivolkan)](https://twitch.tv/vadidekivolkan)


This is my new Twitch (and Twitter) alias; older links were resulting in 404 (instead of a permanent redirect)

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

vmwclabot · 2024-02-22T18:01:02Z

@v0lkan, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 8060bbc must be signed by ovolkan@vmware.com

v0lkan · 2024-02-22T18:29:19Z

app/safe/cmd/main.go

 "github.com/vmware-tanzu/secrets-manager/core/probe"
 )

 func main() {
- id := "VSECMSAFE"
+ id, err := crypto.RandomString(8)


Create a random id and assign it to the context to pass through the chain of requests and responses.

this id will preserve through the sequence of actions related to this particular command execution.

v0lkan · 2024-02-22T18:30:23Z

app/safe/internal/server/route/delete.go

@@ -30,7 +32,7 @@ func isSentinel(j audit.JournalEntry, cid string, w http.ResponseWriter, spiffei
 return true
 }

- j.Event = audit.EventBadSvid
+ j.Event = event.BadSpiffeId


The number of these event constants were increasing; and also we started using some common logging utilities; so I felt it’s time to move even-related constants to their own package too.

move context of the init command a level up in the hierarchy Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

vmwclabot · 2024-02-22T18:39:50Z

@v0lkan, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 8060bbc must be signed by ovolkan@vmware.com

fixed Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

vmwclabot · 2024-02-22T19:43:06Z

@v0lkan, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 8060bbc must be signed by ovolkan@vmware.com

v0lkan · 2024-02-22T20:10:24Z

app/safe/cmd/main.go

+ }
+
+ ctx, cancel := context.WithCancel(
+ context.WithValue(context.Background(), "correlationId", &id),


Passing the correlation id as soon as the execution chain starts, and reusing it via the context.

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

vmwclabot · 2024-02-22T20:51:43Z

@v0lkan, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 8060bbc must be signed by ovolkan@vmware.com

v0lkan added 13 commits February 19, 2024 23:29

🌟 enhancement(VSecM): Added correlation id to Sentinel logs

3b94db0

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

test fix

4574fec

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

Merge branch 'main' into ovolkan/changes

8060bbc

🔨 refactor(VSecM): consolidated logging

4f2eb6c

consolidated logging and moved rpc logging to core Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

🐛 fix(VSecM Sentinel): build fix

5ff4fee

grpc generation was failing Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

🐛 fix(VSecM Sentinel): fix build error

0c0f933

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

🐛 fix(VSecM): fix failing unit tests

3ba41bb

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

🐛 fix(VSecM): fix failing unit tests

504d7f1

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

minor changes

5b1002d

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

checking tests

d8a6952

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

🐛 fix(VSecM): fix tests related to log level setting

6a75047

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

🐛 fix(VSecM): fix tests

75ac015

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

🐛 fix(VSecM): fix log server test

8220197

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

v0lkan requested a review from farhan-pasha as a code owner February 22, 2024 07:31

vmwclabot added the dco-required label Feb 22, 2024

v0lkan removed the dco-required label Feb 22, 2024

v0lkan commented Feb 22, 2024

View reviewed changes

v0lkan requested review from st96d045, abhishek44sharma and ats0stv February 22, 2024 16:27

💄 cosmetic(VSecM): ordering imports and minor fixes

355ccf9

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

vmwclabot added the dco-required label Feb 22, 2024

v0lkan commented Feb 22, 2024

View reviewed changes

💄 cosmetic(VSecM): moved context a level up

50f9579

move context of the init command a level up in the hierarchy Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

💄 cosmetic(VSecM): code had type errors

d565917

fixed Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

v0lkan removed the dco-required label Feb 22, 2024

v0lkan commented Feb 22, 2024

View reviewed changes

💄 cosmetic(VSecM): import reorganization

e9ac75e

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

vmwclabot added the dco-required label Feb 22, 2024

v0lkan merged commit 6c4f699 into main Feb 22, 2024

v0lkan deleted the ovolkan/changes branch February 22, 2024 20:52

v0lkan removed the dco-required label Feb 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactoring the Logging Logic #557

Refactoring the Logging Logic #557

v0lkan commented Feb 22, 2024

vmwclabot commented Feb 22, 2024

v0lkan Feb 22, 2024

vmwclabot commented Feb 22, 2024

v0lkan Feb 22, 2024

v0lkan Feb 22, 2024

vmwclabot commented Feb 22, 2024

vmwclabot commented Feb 22, 2024

v0lkan Feb 22, 2024

vmwclabot commented Feb 22, 2024

Refactoring the Logging Logic #557

Refactoring the Logging Logic #557

Conversation

v0lkan commented Feb 22, 2024

Refactoring the Logging Logic

Description

Test Policy Compliance

Code Quality

Documentation

Checklist

vmwclabot commented Feb 22, 2024

v0lkan Feb 22, 2024

Choose a reason for hiding this comment

vmwclabot commented Feb 22, 2024

v0lkan Feb 22, 2024

Choose a reason for hiding this comment

v0lkan Feb 22, 2024

Choose a reason for hiding this comment

vmwclabot commented Feb 22, 2024

vmwclabot commented Feb 22, 2024

v0lkan Feb 22, 2024

Choose a reason for hiding this comment

vmwclabot commented Feb 22, 2024