创建并希望发布内容包时,请确保内容包满足基本的发布要求。

必须检查内容包要求和发布要求。

内容包要求

内容包必须满足一些内容、质量和标准要求。

内容要求包括:

  • 最少三个仪表板
  • 每个仪表板最少一个仪表板筛选器,理想情况下为三个,最多为五个
  • 每个仪表板最少三个仪表板小组件
  • 每个仪表板最多六个仪表板小组件
  • 每行最多三个仪表板小组件
  • 最少五个警示
  • 最少 20 个已提取字段

内容包的质量要求如下:

警示
对警示使用有意义的时间段。
仪表板组
  • 考虑从概览仪表板组开始。
  • 根据消息类型(例如,概览或性能)创建仪表板组,而不是根据组件类型(例如,计算、网络或存储)创建仪表板组。
  • 如果仪表板小组件适用于每个仪表板组,请在多个仪表板组中重复放置同一个仪表板小组件。
  • 至少在内容包中定位三个仪表板组。
  • 您不能对仪表板组和仪表板小组件进行重新排序(用户内容除外)。
  • 命名仪表板组时,设置通用型标题,并避免添加产品特定或应用程序特定的名称,除非名称以组件特定的方式使用。
仪表板小组件
  • 请勿在同一行中放置超过三个仪表板小组件。
  • 在以不同格式显示类似信息时,请确保每种格式都能引入值。
  • 将与堆栈相关的仪表板放在一起以方便查看。
  • 为仪表板小组件提供描述性名称。不要在小组件标题中使用字段名称。
  • 确保每个仪表板小组件都包含有关图表显示哪些内容及其为何十分重要的信息或链接。这些说明应回答诸如“为什么该小组件十分重要?”,以及“在哪里可以找到更多信息?”之类的问题。
查询
  • 每个查询至少具有一个全文关键字,最好具有三个或更多关键字。
  • 查询不基于环境特定的属性,如源、主机名或设备。
  • 仅当关键字和通配符匹配操作符不充足时,才在查询中使用正则表达式。使用正则表达式时,请提供尽可能多的关键字。
  • 使查询尽可能具体。内容包查询应仅匹配适用于符合内容包设计意图的产品或应用程序的事件。
字段提取
  • 对字段使用更多上下文筛选器可提高查询中的字段性能。
  • 尽可能减少所使用的正则表达式的数量。
  • 确认正则表达式值与所有适用的日志消息相匹配。
  • 提供尽可能多的前后关键字上下文。
  • 每个字段至少具有一个全文关键字,最好具有三个或更多关键字。
  • 字段特定于产品或应用程序,不会返回其他产品或应用程序日志的结果。
  • 尽可能使用代理来收集日志。使用代理解析字段,而不是在载入后提取字段。
字段命名
  • 使用以下命名标准:Prefix_Field_Name。前缀应适用于内容包。
  • 全部使用小写字母。
  • 在字段的其他上下文中使用关键字可提高查询中的字段性能。
筛选器
  • 使用筛选器时,请勿使用匹配“任意”运算符,除非在搜索栏中定义了一个或多个关键字。“任意”表示每个筛选器都是一个单独的查询。例如,如果在查询中将三个筛选器与“任意”运算符一起使用,该查询将被视为三个查询。查询越多,获得结果就越慢。您可以将“任意”视为“or”运算符,将“全部”视为“and”运算符。
  • 使用具有多个不同值的文本筛选器时,请确保在搜索栏中定义了一个或多个关键字。
内容包信息
  • 导出内容包时,请使用命名格式 CompanyProduct vVersion。理想情况下,内容包名称必须少于 30 个字符,以防止自动换行。
  • 使用命名空间导出时,请使用命名空间格式 Ext.Domain.Product
  • 导出内容包时,将导出内容包涉及的产品,以及内容包如何帮助监控产品的详细描述。
  • 在内容包的“设置说明”部分中添加信息。这些说明可帮助最终用户设置和使用内容包。
  • 在内容包的“升级说明”部分中添加信息。这些说明可帮助最终用户了解并使用内容包升级版中的所有功能。
  • 提供有关符合内容包设计意图的产品或设备的测试版本的详细信息。
  • 默认情况下,假设内容包向后兼容所有受支持的产品或设备版本,并且从商城中更新内容包后,新版本的内容包不会使先前的配置中断。否则,请确保提供单独的内容包。
  • 分离内容包时,请确保内容包具有不同的命名空间,并且无法从旧内容包升级到新内容包。此外,还要支持并行使用新旧解决方案,而不会让用户对不正确的数据或额外警示造成混淆。为两个内容包的“发行说明”部分和“已知问题”部分添加例外。
  • 为内容包提供版本号,格式为 Major.Minor.Revision。主要版本表示内容包中有多处更改,例如,添加一个或多个新仪表板。次要版本表示较小的更改,例如,修复错误,更改小组件类型或添加一个或两个小组件。修订版本是可选内容,内容包作者可以在准备将进行了修订的新版本发送到 VMware 时使用,但在发布已完成的版本后可能会跳过。对内容包仅使用两位数字的版本号。
代理组
VMware Aria Operations for Logs 支持 syslog 转发配置及通过其自已的代理提供日志。设计用于代理和代理组模板的内容包中包含建议的配置。有关更多信息,请参见每个内容包的说明。

发布要求

发布内容包之前,检查它是否满足发布要求。使用开发人员中心的内容包发布程序获取内容包建议并将要审核的版本上载到 VMware。https://developercenter.vmware.com/web/loginsight

发布要求 描述
内容包文件格式 VLCP 文件。
事件 验证内容包所需的相应事件。
概览 概述内容包的一到两段内容。
突出显示 三处突出显示,展示内容包的价值。
描述 描述内容包及其价值的两到三段内容。
技术规格 介绍最低系统要求,包括产品版本和配置以及 VMware Aria Operations for Logs 版本和配置。此外,还提供配置产品以登录 VMware Aria Operations for Logs 和填充内容包所需的所有指示。
屏幕截图 展示包含真实数据的内容包的三个或更多屏幕截图。
视频(可选) 内容包如何引入值的示例。
白皮书(可选) 如何配置产品或应用程序以将日志转发到 VMware Aria Operations for Logs