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 MetricInterceptor #152

Merged
merged 1 commit into from
Jun 21, 2024
Merged

Add MetricInterceptor #152

merged 1 commit into from
Jun 21, 2024

Conversation

hackerwins
Copy link
Member

@hackerwins hackerwins commented Jun 21, 2024

What this PR does / why we need it?

Add MetricInterceptor

Any background context you want to provide?

What are the relevant tickets?

Fixes #

Checklist

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

Summary by CodeRabbit

  • New Features

    • Added a new interceptor to track metrics, including the x-yorkie-user-agent header for each API request.
  • Version Update

    • Updated application version from 0.1.0 to 0.4.23.

Copy link

coderabbitai bot commented Jun 21, 2024

Warning

Review failed

The pull request is closed.

Walkthrough

This update includes a version bump for the project and the addition of a new interceptor to the API configuration. The new interceptor enhances request handling by adding custom headers using information from the package.json file. This ensures better tracking and monitoring of API usage patterns by appending metadata to each request.

Changes

Files Change Summary
package.json - Version updated from 0.1.0 to 0.4.23
src/api/index.ts - Added interceptor.createMetricInterceptor() to the interceptors array in the transport configuration
src/api/interceptor.ts - Added import for package.json
- Implemented createMetricInterceptor in InterceptorBuilder class

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant InterceptorBuilder
    participant Transport
    participant PackageJson

    Client->>InterceptorBuilder: Initialize and configure interceptors
    InterceptorBuilder->>PackageJson: Import version information
    InterceptorBuilder->>InterceptorBuilder: createMetricInterceptor() returns interceptor
    InterceptorBuilder-->>Transport: Interceptor including 'x-yorkie-user-agent' header
    Transport->>Client: Configured transport ready for use
Loading

Poem

In a land where code does flow,
A version boost, our work does show. 🌟
Headers added to requests we send,
Yorkie's user-agent, a helping friend! 🐾
Our project grows with care and might,
Making data paths both clear and bright. ✨


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 merged commit 7c44e7c into main Jun 21, 2024
2 checks passed
@hackerwins hackerwins deleted the add-metric-interceptor branch June 21, 2024 05: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