search

brenner-tobias / addon-cloudflared

Connect remotely to your Home Assistant instance without opening any ports using Cloudflared.
MIT License
879 stars 54 forks source link

Expose metrics port #729

Closed brenner-tobias closed 3 weeks ago

brenner-tobias commented 3 weeks ago

Proposed Changes

Expose Metrics Server Port and add WebUI URL in Configuration

Related Issues

725

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The changes involve modifications to multiple configuration files: .devcontainer.json, cloudflared/config.yaml, and several translation files. In .devcontainer.json, the port mapping for the development container has been updated, and the structure has been reorganized to group extensions and settings under a new customizations key. In cloudflared/config.yaml, a new web interface entry for metrics has been added along with a new ports section that defines TCP port mapping for the metrics interface. Additionally, new entries for the metrics web interface have been introduced in various translation files.

Changes

File Change Summary
.devcontainer.json Updated appPort from "81:81" to "36500:36500". Moved extensions and settings under customizations.vscode. Preserved mounts.
cloudflared/config.yaml Added new webui entry for metrics URL. Introduced ports section for TCP port 36500.
cloudflared/translations/de.yaml Added new entry 36500/tcp: Web-Interface für Metriken (36500/tcp) in the network section.
cloudflared/translations/en.yaml Added new entry 36500/tcp: Metrics Web Interface (36500/tcp) in the network section.
cloudflared/translations/he.yaml Added new entry 36500/tcp: ממשק אינטרנט למדדים (36500/tcp) in the network section.
cloudflared/translations/nl.yaml Added new entry 36500/tcp: Webinterface voor statistieken (36500/tcp) in the network section.

Sequence Diagram(s)

sequenceDiagram
    participant DevContainer
    participant VSCode
    participant Cloudflared

    DevContainer->>VSCode: Configure appPort
    VSCode-->>DevContainer: Update appPort to 36500
    DevContainer->>VSCode: Move extensions and settings under customizations
    VSCode-->>DevContainer: Confirm structure update

    Cloudflared->>Metrics: Access metrics web interface
    Metrics-->>Cloudflared: Display metrics on port 36500

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 , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration 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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
brenner-tobias commented 3 weeks ago

There is one issue with the way I implemented it: Since I added the webui: http://[HOST]:[PORT:36500]/metrics config, the link for the webui is visible in the add-on page. If you do not actively add the port though, clicking on the link loads a blank website about:blank#blocked

We do have three options:

  1. Leave as it is right now
  2. Remove the webui config, so the link is not shown and it is everyones own responsibility to configure the port and open the metrics link
  3. Set the port to be present by default, so there are no issues for most users who do not disable it

I am leaning towards option 2, since this is a niche use case anyways, but I could also live with 3.

@elcajon what do you think?

elcajon commented 3 weeks ago

I would also tend towards option two, as otherwise the question would arise as to whether you need to forward the port on your router in order to be able to use the add-on and the tunnel at all...