Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Logger module #164 #301

Merged
merged 15 commits into from
Nov 21, 2022
Merged

Logger module #164 #301

merged 15 commits into from
Nov 21, 2022

Conversation

okdas
Copy link
Member

@okdas okdas commented Oct 11, 2022

Description

Logger module addition. The module will allow us to utilize structured logs for better observability.

Issue

Fixes #164

Type of change

Please mark the relevant option(s):

  • New feature, functionality or library
  • Bug fix
  • Code health or cleanup
  • Major breaking change
  • Documentation
  • Other

List of changes

  • New module addition

Testing

  • make develop_test
  • LocalNet w/ all of the steps outlined in the README

Required Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have tested my changes using the available tooling
  • I have updated the corresponding CHANGELOG

If Applicable Checklist

  • I have updated the corresponding README(s); local and/or global
  • I have added tests that prove my fix is effective or that my feature works
  • I have added, or updated, mermaid.js diagrams in the corresponding README(s)
  • I have added, or updated, documentation and mermaid.js diagrams in shared/docs/* if I updated shared/*README(s)

@okdas okdas requested a review from a team as a code owner October 11, 2022 23:43
@okdas okdas self-assigned this Oct 11, 2022
@okdas okdas added core Core infrastructure - protocol related code health Nice to have code improvement priority:medium tooling tooling to support development, testing et al observability labels Oct 11, 2022
@deblasis deblasis self-requested a review October 12, 2022 07:13
Copy link
Contributor

@deblasis deblasis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like where this is going, just a few comments and happy to help if you have questions

app/client/main.go Outdated Show resolved Hide resolved
build/config/config1.json Show resolved Hide resolved
shared/modules/logger_module.go Show resolved Hide resolved
@codecov-commenter
Copy link

codecov-commenter commented Oct 18, 2022

Codecov Report

Base: 38.53% // Head: 38.53% // No change to project coverage 👍

Coverage data is based on head (4131d40) compared to base (fbb14a4).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #301   +/-   ##
=======================================
  Coverage   38.53%   38.53%           
=======================================
  Files          33       33           
  Lines        2629     2629           
=======================================
  Hits         1013     1013           
  Misses       1556     1556           
  Partials       60       60           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@Olshansk
Copy link
Member

@okdas Let me know if/when you need another set of 👀 at this

@okdas okdas force-pushed the issues/164/observability-logs branch from e3d682c to afb2b75 Compare October 19, 2022 01:17
@okdas
Copy link
Member Author

okdas commented Oct 19, 2022

@okdas Let me know if/when you need another set of 👀 at this

I wanted to ask Alessandro for a second review, but if you're available then sure, I'd love to get your feedback!

@okdas okdas requested a review from Olshansk October 19, 2022 01:19
Copy link
Member

@Olshansk Olshansk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a couple small comments, but overall it's looking really clean!

logger/proto/logger_config.proto Show resolved Hide resolved
logger/proto/logger_config.proto Show resolved Hide resolved
shared/modules/logger_module.go Outdated Show resolved Hide resolved
shared/modules/logger_module.go Outdated Show resolved Hide resolved
shared/modules/module.go Outdated Show resolved Hide resolved
logger/module.go Show resolved Hide resolved
@okdas okdas force-pushed the issues/164/observability-logs branch from 8dc7c6b to 0ed85d4 Compare October 25, 2022 00:41
@okdas okdas changed the title [WIP] logging module #164 [WIP] logger module #164 Oct 25, 2022
@okdas okdas requested a review from Olshansk October 25, 2022 00:42
consensus/consensus_tests/utils_test.go Outdated Show resolved Hide resolved
shared/modules/logger_module.go Show resolved Hide resolved
shared/modules/module.go Outdated Show resolved Hide resolved
logger/module.go Show resolved Hide resolved
logger/proto/logger_config.proto Show resolved Hide resolved
logger/proto/logger_config.proto Show resolved Hide resolved
@okdas okdas requested a review from Olshansk November 4, 2022 00:58
Copy link
Member

@Olshansk Olshansk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@deblasis Could you take a look at this when you have a chance as well?

shared/modules/types.go Outdated Show resolved Hide resolved
shared/modules/types.go Outdated Show resolved Hide resolved
runtime/config.go Show resolved Hide resolved
logger/proto/logger_config.proto Outdated Show resolved Hide resolved
app/client/cli/debug.go Outdated Show resolved Hide resolved
logger/module.go Outdated Show resolved Hide resolved
@okdas okdas force-pushed the issues/164/observability-logs branch 2 times, most recently from 0ecbe4d to cc465fa Compare November 4, 2022 21:36
@Olshansk
Copy link
Member

Olshansk commented Nov 7, 2022

@okdas Please re-request a review when this is ready again.

Also, please update the description of title in this PR since it's in review and not just a WIP anymore.

@okdas okdas changed the title [WIP] logger module #164 Logger module #164 Nov 7, 2022
@okdas okdas force-pushed the issues/164/observability-logs branch from cc465fa to 137ca8e Compare November 8, 2022 18:28
@okdas okdas requested a review from Olshansk November 8, 2022 18:32
@okdas
Copy link
Member Author

okdas commented Nov 8, 2022

@deblasis please take a look at this if you've got a moment. I want to make sure I'm utilizing the foundation you've built correctly.

Copy link
Contributor

@deblasis deblasis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Solid work, just a question that potentially is not an action item, please let me know if you think that I am getting it wrong.

Everything else, I believe that when the rubber hits the road in #288 there might be (or not) some small changes to this but the foundation looks pretty good to me.

shared/modules/logger_module.go Show resolved Hide resolved
Copy link
Member

@Olshansk Olshansk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👀 👌

Really appreciate the scoping of this so we could extend it elsewhere afterwards!

@okdas okdas merged commit a53a104 into main Nov 21, 2022
@okdas okdas deleted the issues/164/observability-logs branch November 21, 2022 22:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code health Nice to have code improvement core Core infrastructure - protocol related observability tooling tooling to support development, testing et al
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[Telemetry] Design shared logging module
5 participants