Skip to content

docs(opc): support server address failover#33318

Open
bitcapybara wants to merge 5 commits into
mainfrom
docs/TS-7477-main
Open

docs(opc): support server address failover#33318
bitcapybara wants to merge 5 commits into
mainfrom
docs/TS-7477-main

Conversation

@bitcapybara

Copy link
Copy Markdown
Contributor

No description provided.

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @bitcapybara, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request updates the Chinese documentation for OPC-UA data ingestion within TDengine TSDB. The primary goal is to improve the clarity and robustness of OPC-UA server connections by detailing the configuration of both primary and failover server addresses. This enhancement ensures users can better manage their OPC-UA data sources, especially in scenarios requiring high availability.

Highlights

  • OPC-UA Service Address Clarification: The documentation for the "OPC-UA 服务地址" (OPC-UA Service Address) has been updated to provide a more detailed example (127.0.0.1:6666/OPCUA/ServerPath) and clarify accessibility requirements, specifying whether the address must be reachable from an Agent or the TDengine system server.
  • Failover Service Address Support: A new configuration option, "故障切换服务地址" (Failover Service Address), has been introduced, allowing users to specify multiple OPC server failover endpoints, separated by commas, to enhance connection resilience.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

本次 PR 更新了中文文档,增加了对 OPC-UA 服务地址故障切换的支持说明。整体修改清晰明了。我提出了一些具体的修改建议,以改善文档的排版和清晰度。另外,我注意到相应的英文文档尚未更新,建议在本次 PR 中一并更新,以保证多语言文档的同步。

Comment thread docs/zh/06-advanced/05-data-in/05-opcua.md Outdated
Comment thread docs/zh/06-advanced/05-data-in/05-opcua.md Outdated
@zitsen

zitsen commented Oct 22, 2025

Copy link
Copy Markdown
Contributor

/gemini review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

The pull request adds support for server address failover to the OPC-UA documentation in Chinese. The changes introduce a new configuration option for specifying multiple failover server endpoints, separated by commas. This enhancement improves the robustness of OPC-UA data ingestion by allowing the system to switch to a backup server if the primary server becomes unavailable. The documentation update provides clear instructions on how to configure the failover service address and ensures that users understand how to leverage this feature for increased reliability.

Comment on lines +37 to +41
在 **连接配置** 区域:

1. **OPC-UA 服务地址**:OPC UA 服务器端点,如:127.0.0.1:6666/OPCUA/ServerPath。
如果使用了 Agent,该地址必须能够从 Agent 访问。如果没有使用 Agent, 该地址必须能够从 TDengine 系统所在服务器访问。
2. **故障切换服务地址**:OPC 服务器的故障切换服务器端点,可以指定多个,用逗号(`,`)分割。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The description of the OPC-UA service address and the failover service address could be clearer. Consider restructuring this section to improve readability and ensure users understand the purpose of each address.

Specifically, consider using bullet points to delineate the two address types, and clarify the network accessibility requirements for each in a separate sentence.

Comment on lines +37 to +41
在 **连接配置** 区域:

1. **OPC-UA 服务地址**:OPC UA 服务器端点,如:127.0.0.1:6666/OPCUA/ServerPath。
如果使用了 Agent,该地址必须能够从 Agent 访问。如果没有使用 Agent, 该地址必须能够从 TDengine 系统所在服务器访问。
2. **故障切换服务地址**:OPC 服务器的故障切换服务器端点,可以指定多个,用逗号(`,`)分割。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The phrase "故障切换服务地址" could benefit from a more descriptive translation to enhance clarity for non-Chinese speakers who may be reading the documentation with translation tools. Consider providing an alternative translation in parentheses or a tooltip.


1. **OPC-UA 服务地址**:OPC UA 服务器端点,如:127.0.0.1:6666/OPCUA/ServerPath。
如果使用了 Agent,该地址必须能够从 Agent 访问。如果没有使用 Agent, 该地址必须能够从 TDengine 系统所在服务器访问。
2. **故障切换服务地址**:OPC 服务器的故障切换服务器端点,可以指定多个,用逗号(`,`)分割。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Consider adding a note about the order in which failover addresses are attempted. Is it sequential? Is there a prioritization mechanism? This information is crucial for users to understand how the failover mechanism works.

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants