正在加载

最后的润色

词语

manifest 文件的提示

  • 配置选项的描述应尽可能简短。

    请记住只保留有关配置选项的有意义的信息。

    • 好的候选者：对产品配置的引用、接受的字符串值、解释。
    • 不好的候选者：从 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 文档模板。 如果在指标和日志中使用相同的数据流名称，请在模板中添加 -metrics 和 -logs。 例如，ELB 是日志的数据流，也是指标的数据流。 在 README.md 模板中，{{fields "elb_logs"}} 和 {{fields "elb_metrics"}} 用于分隔它们。

查看工件

变量属性自定义 Kibana UI 中配置选项的可视化。 确保它们已在所有 manifest 文件中定义。

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*
  1. 选项是必需的
  2. 不要隐藏配置选项（折叠菜单）
  3. 人类可读的变量名
  4. 变量描述（可能包含一些细节）
  5. 字段类型（根据参考：text、password、bool、integer）
  6. 该字段有多个值
  7. 在无代理模式下隐藏变量（有关更多信息，请参阅 hide_in_deployment_modes）
© . All rights reserved.