GreptimeTeam / greptimedb

An open-source, cloud-native, distributed time-series database with PromQL/SQL/Python supported. Available on GreptimeCloud.
https://greptime.com/
Apache License 2.0
3.97k stars 281 forks source link

fix: wrong frontend registration address #4199

Closed killme2008 closed 1 week ago

killme2008 commented 1 week ago

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

4186

What's changed and what's your intention?

Fixed the wrong peer address that frontend registers.

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

[!WARNING]

Rate limit exceeded

@killme2008 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 46 minutes and 59 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between f58ed88b72b6a71342d765a7ace2ce09afaed536 and 4cbb4c85f54aeeb4f61dcc226e3504da01bdb3d1.

Walkthrough

The changes introduce a function resolve_addr to handle hostname and port resolution for network addresses. This affects the HeartbeatTask struct in datanode and frontend by using peer_addr instead of server_addr. Configuration files are updated to clarify the usage of hostnames for the gRPC server, enhancing documentation and code reliability. Code cleanliness is improved by removing redundant functions and test cases.

Changes

File Path Change Summary
src/datanode/src/heartbeat.rs Renamed server_addr to peer_addr, used resolve_addr for address resolution, and removed redundant resolve_addr function along with its test cases.
src/frontend/src/heartbeat.rs Similar updates to heartbeat.rs as in datanode, with peer_addr and resolve_addr usages.
src/servers/src/addrs.rs Introduced resolve_addr function and added tests for address resolution logic.
src/servers/src/lib.rs Added the new addrs module to the public scope for use in the project.
config/datanode.example.toml Updated comments to clarify the hostname field’s purpose for the gRPC server in the configuration file.
config/frontend.example.toml Added a new hostname field in the [grpc] section for specifying external host connections and advertisement to metasrv.
config/config.md Clarified the grpc.hostname configuration parameter with additional notes on its purpose and usage.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Datanode
    participant Frontend
    participant Servers as Servers::Addrs

    Client->>+Datanode: Sends request with server name
    Datanode->>+Servers: Resolve address using `resolve_addr`
    Servers-->>-Datanode: Returns `peer_addr`
    Datanode->>Frontend: Communicates with `peer_addr`
    Frontend->>Frontend: Uses resolved address
    Frontend-->>Client: Response with resolved peer information

Poem

In code’s vast land, a task arose,
With addresses both near and far, they chose.
From server to peer, the change was born,
To resolve with grace each early morn.
Now networks link with clearer sight,
A seamless dance from day to night.

🐇✨


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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 1 week ago

Codecov Report

Attention: Patch coverage is 93.54839% with 2 lines in your changes missing coverage. Please review.

Project coverage is 84.56%. Comparing base (cdd4baf) to head (4cbb4c8). Report is 13 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #4199 +/- ## ========================================== - Coverage 85.05% 84.56% -0.49% ========================================== Files 1031 1041 +10 Lines 181276 183023 +1747 ========================================== + Hits 154176 154772 +596 - Misses 27100 28251 +1151 ```
killme2008 commented 1 week ago

We should remove the port part when displaying peer_addr in cluster_info table, because those port serves different purpose, it's meaningless to list them in the same context.

As I said in https://github.com/GreptimeTeam/greptimedb/issues/4186#issuecomment-2187329797

I think using gRPC is good currently, and the gRPC is the main communication between nodes, it's part of cluster-info.

fengjiachun commented 1 week ago

Flow's heartbeat task also need to do the same thing: https://github.com/GreptimeTeam/greptimedb/blob/a44fe627ce6a16b703756e4ffb7e48559062b079/src/flow/src/heartbeat.rs#L38

sunng87 commented 1 week ago

@zyy17 In our operator, we will need to pass hostname argument to frontend after this patch merged.

killme2008 commented 1 week ago

@fengjiachun @sunng87 @v0y4g3r Please take another look.

fengjiachun commented 1 week ago

Flow's heartbeat task also need to do the same thing:

https://github.com/GreptimeTeam/greptimedb/blob/a44fe627ce6a16b703756e4ffb7e48559062b079/src/flow/src/heartbeat.rs#L38

Another heartbeat task, it is for flow engine. @killme2008

killme2008 commented 1 week ago

Flow's heartbeat task also need to do the same thing: https://github.com/GreptimeTeam/greptimedb/blob/a44fe627ce6a16b703756e4ffb7e48559062b079/src/flow/src/heartbeat.rs#L38

Another heartbeat task, it is for flow engine. @killme2008

Fixed