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

Update the Chinese description in template.yaml of agent_configure for 2nd round. #7797

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

deepflow-lifei
Copy link
Contributor

The amounts of TODO are decreased from 227 to 126.

This PR is for:

The amounts of TODO are decreased from 227 to 126.
@deepflow-lifei deepflow-lifei changed the title Update the Chinese description for 2nd round. Update the Chinese description in template.yaml of agent_configure for 2nd round. Aug 13, 2024
@@ -1229,6 +1220,48 @@ inputs:
# # i.e., an regex `app:.+` can match all processes has a `app` tag
# match_type: tag
# ```
# ch: |-
# 1. deepflow-agent 会遍历序列中的所有进程匹配器,并且在序列中靠前的匹配器优先生效。
# 2. 当`match_type`选择`parent_process_name`时,会自动递归匹配父进程名,并且忽略`rewrite_name`字段。
Copy link
Member

Choose a reason for hiding this comment

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

反引号外侧(若反引号内部是英文)加个空格

@@ -1260,6 +1295,8 @@ inputs:
# description:
# en: |-
# The type of matcher.
# ch: |-
# 匹配进程所用的字段,默认值为`process_name`,可选项包括[process_name, cmdline, parent_process_name, tag]
Copy link
Member

Choose a reason for hiding this comment

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

左括号[左侧加个空格

# deepflow-agent 工作在`物理网络镜像`模式时:
# - `mirror-traffic-pcp`小于或等于`7`,表示仅对流量中 VLAN PCP 值与`mirror-traffic-pcp`相等的数据包进行处理;
# - `mirror-traffic-pcp`设置为`8`,表示通过数据包外层 VLAN 标签计算 TAP 值;
# - `mirror-traffic-pcp`设置为`9`,表示通过数据包内层 VLAN 标签计算 TAP 值。
Copy link
Member

Choose a reason for hiding this comment

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

这个配置项的 range 改为 [0, 9]

Copy link
Member

Choose a reason for hiding this comment

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

感觉可以给这个配置项增加一个 enum_optios,这样更好。

enum_options:
  - 0: PCP 0
  - 1: PCP 1
  - ...
  - 7: PCP 7
  - 8:
     en: xxx
     ch: xxx
  - 9:
     en: xxx
     ch: xxx

xxx 尽量短小,因为会出现在下拉框中

Copy link
Contributor Author

Choose a reason for hiding this comment

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

修改为如下内容:
# enum_options:
# - 0: PCP 0
# - 1: PCP 1
# - ...
# - 7: PCP 7
# - 8:
# en: Ignore PCP and identify outer VLAN
# ch: 忽略 PCP 并识别外层 VLAN
# - 9:
# en: Ignore PCP and identify inner VLAN
# ch: 忽略 PCP 并识别内层 VLAN

@@ -2860,9 +2912,8 @@ inputs:
# en: |-
# Set the maximum value of hash table entries for thread/coroutine tracking sessions.
# ch: |-
# TODO
# TODO: 线程/协程追踪的哈希表最大条目数。
Copy link
Member

Choose a reason for hiding this comment

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

TODO: 去掉

Copy link
Contributor Author

Choose a reason for hiding this comment

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

该中文释义还需要再做推敲,所以暂做保留。

# deepflow-agent 会周期性标记每一个 `<vpc, ip, protocol, port>` 四元组承载的应用协议类型,以加速
# 后续数据的应用协议采集过程。如果一个时间周期内,连续多次尝试解析 Packet 数据、Socket 数据无法推断
# 出该四元组承载的应用协议,agent 会将该四元组标记为 unknown 类型,并在本周期内暂停对后续数据的应用
# deepflow-agent 会周期性标记每一个`<vpc, ip, protocol, port>`四元组承载的应用协议类型,以加速
Copy link
Member

Choose a reason for hiding this comment

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

加一个空格能让 markdown 状态下中英文边界更明显一点

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

# 该参数值,该次调用将被识别为超时。该参数需大于会话合并的 SLOT_TIME (10s),并小于 3600s。
# deepflow-agent 采集 TCP 承载的应用调用时等待响应消息的最大时长,如果响应与请求之间的时间差超过该参数值,
# 该次调用将被识别为超时,并且不会参与平均时延、总时延的计算。
# 该参数值需大于会话合并的 SLOT_TIME (10s),并小于 3600s。
Copy link
Member

Choose a reason for hiding this comment

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

如果想要分段的话,中间需要有个空行。

如果不想分段的话,可以放在上一行(因为上一行宽度还没足够)

@@ -4739,7 +4912,9 @@ processors:
# force a double-sided MAC address match and only aggregate traffic with
# exactly equal MAC addresses.
# ch: |-
# TODO
# deepflow-agent 对云网络的数据包进行处理过程中,只有 MAC 地址与两端匹配的数据包才能正确聚合流。
# 将参数设置为 true,将强制比对双端的 MAC 地址,只有双端 MAC 均匹配的数据包才可以聚合为流。
Copy link
Member

Choose a reason for hiding this comment

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

配置为 true 表示不对比。配置为 false 表示对比

Copy link
Contributor Author

Choose a reason for hiding this comment

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

英文修改为:
Set this value to false to force a double-sided MAC address match and only aggregate traffic with exactly equal MAC addresses.

中文修改为:
将参数设置为 false 表示强制比对双端的 MAC 地址,只有双端 MAC 均匹配的数据包才可以聚合为流;设置为 true 表示忽略 MAC 地址校验。

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.

2 participants