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

Add Project field to YorkieService logs #911

Merged
merged 2 commits into from
Jul 2, 2024
Merged

Add Project field to YorkieService logs #911

merged 2 commits into from
Jul 2, 2024

Conversation

hackerwins
Copy link
Member

@hackerwins hackerwins commented Jul 2, 2024

What this PR does / why we need it:

Add Project field to YorkieService logs

This commit adds project field to the YorkieService logs for easier
project identification during debugging. Additionally, removes
LoggingInterceptor to allow each service to define its own log fields,
as YorkieService and AdminService logs may differ.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:


Additional documentation:


Checklist:

  • Added relevant tests or not required
  • Didn't break anything

Summary by CodeRabbit

  • New Features

    • Introduced unique request ID generation for requests.
    • Enhanced logging with new field creation functionality.
  • Improvements

    • Improved authentication handling for AdminService with a new AdminServiceInterceptor.
    • Updated YorkieServiceInterceptor for better context and logging management.
  • Refactor

    • Renamed several interceptors for clarity and consistency.
    • Reorganized import statements for improved code readability.
  • Documentation

    • Added and updated comments to improve code clarity and understanding.

Copy link

coderabbitai bot commented Jul 2, 2024

Warning

Review failed

The pull request is closed.

Walkthrough

The changes focus on enhancing logging capabilities, interceptors, and unique request ID handling within the Yorkie server. Key changes include updating the Logger interface, refining authentication interceptors, adding functionality for unique request ID generation, and renaming several structures and functions for better clarity and context handling.

Changes

File(s) Change Summary
server/logging/logging.go Updated New function in Logger interface to accept additional fields and added NewField function for key-value pairs.
server/rpc/connecthelper/status.go Added package comment to connecthelper package. No changes to exported entities.
server/rpc/interceptors/admin.go Renamed AdminAuthInterceptor to AdminServiceInterceptor, updated method signatures, and added new functions for admin authentication and context building. Introduced requestID handling.
server/rpc/interceptors/default.go Reordered import statements and updated the comment for DefaultInterceptor.
server/rpc/interceptors/requestid.go Introduced new file to handle unique request ID generation via requestID struct and associated methods.
server/rpc/interceptors/yorkie.go Renamed ContextInterceptor to YorkieServiceInterceptor, added requestID field, and updated related functions and context handling logic.
server/rpc/server.go Removed connecthelper import, updated NewServer function to use NewAdminServiceInterceptor and NewYorkieServiceInterceptor.

Poem

In code, changes dance and twirl,

Logging fields and IDs unfurl.

Intercepting with a keen new eye,

Authentication soaring high.

Yorkie’s pathways now more clear,

A brilliant upgrade, let us all cheer! 🌟


Tip

Early access features: enabled

We are currently testing the following features in early access:

  • OpenAI gpt-4o model for code reviews and chat: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues.
  • OSS projects are currently opted into early access features by default.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@hackerwins hackerwins marked this pull request as ready for review July 2, 2024 02:41
Copy link

codecov bot commented Jul 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 50.57%. Comparing base (4226417) to head (f1b4e0e).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #911      +/-   ##
==========================================
- Coverage   50.72%   50.57%   -0.15%     
==========================================
  Files          70       70              
  Lines       10479    10508      +29     
==========================================
- Hits         5315     5314       -1     
- Misses       4636     4666      +30     
  Partials      528      528              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@hackerwins hackerwins merged commit e4885cb into main Jul 2, 2024
4 checks passed
@hackerwins hackerwins deleted the revise-log branch July 2, 2024 02:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant