收尾工作
编辑收尾工作编辑
措辞编辑
清单文件技巧
-
配置选项的描述应该尽可能简短。
请记住只保留关于配置选项的有意义的信息。
- 合适的候选者：产品配置的参考、可接受的字符串值、说明。
- 不合适的候选者：从 A、B、C、D、…X、Y、Z 数据集中收集指标。
-
描述应该易于人类理解。
尝试将类似“收集 foo_Bar3 指标”这样的句子改写成“收集 Foo Bar 指标”。
-
描述应该易于理解。
简化句子，不要提供不必要的信息。
- 不合适的候选者：收集应用程序日志（日志输入）
- 合适的候选者：收集应用程序日志，收集应用程序的标准日志
添加图标编辑
集成图标在 Kibana 中的不同位置显示，因此最好定义自定义图标以使 UI 更易于导航。
添加屏幕截图编辑
Kibana 集成管理器显示与集成相关的屏幕截图。屏幕截图包括可视化指标和日志数据的 Kibana 仪表板。
创建 README 文件编辑
README 模板用于渲染最终的 README 文件，包括导出的字段。模板应放置在 package/<integration-name>/_dev/build/docs/README.md 中。如果该目录不存在，请创建它。
要查看如何使用模板函数（例如 {{fields "data-stream-name"}}），请查看 MySQL 文档模板。如果指标和日志都使用相同的 data stream 名称，请在模板中添加 -metrics 和 -logs。例如，ELB 是日志的 data stream，也是指标的 data stream。在 README.md 模板中，使用 {{fields "elb_logs"}} 和 {{fields "elb_metrics"}} 将它们分开。
查看工件编辑
定义变量属性编辑
变量属性自定义 Kibana UI 中配置选项的可视化。确保它们在所有清单文件中定义。
vars:
- name: paths
required: true
show_user: true
title: Access log paths
description: Paths to the apache access log file.
type: text
multi: true
hide_in_deployment_modes:
- agentless
default:
- /var/log/httpd/access.log*
|
选项是必需的 |
|
|
不要隐藏配置选项（折叠菜单） |
|
|
易于人类理解的变量名称 |
|
|
变量描述（可能包含一些详细信息） |
|
|
字段类型（根据参考：text、password、bool、integer） |
|
|
该字段具有多个值 |
|
|
在无代理模式下隐藏变量（有关更多信息，请参阅 |