SignalFX检测器同步实用程序
signalfx-detector-syncer的Python项目详细描述
sfx sync detectors是一个命令行工具,有助于保持signalfx detectors 在版本控制中,并与signalfx同步。它在一个目录上运行 探测器文件树,每个代表一个探测器,并确保 是最新的。
安装
$ pip install signalfx-detector-syncer
用法
$ sfx-sync-detectors --token=$SFX_AUTH_TOKEN /path/to/detectors/
有关完整用法信息,请使用-h或--help运行。
工作原理
同步器按给定基目录下的文件路径工作。每个探测器 以自己的文件编写,可以是json或yaml格式,命名为 可识别的dash-separated-slug(.json或.yaml)。亲戚 来自给定基目录的文件路径标识检测器:更新到 相同的文件将更新现有的检测器。创建新文件创建新文件 检测器;移除文件会从signalfx中移除相应的检测器。
同步器管理的探测器在SignalFX中由多个标签标识:
- 一个signalfx-detector-syncer标记,出现在创建的所有检测器上,并且 由检测器同步器管理;
- 一个from:<filepath>标记,特定于一个特定的检测器,它将 在同步目录树中检测它来自的文件路径;
- 可选地,一个附加的scope:<scope>标识符标记 确定探测器的作用域(请参见下面的scoping)。
json
当文件包含json时,它应该包含直接json 将推送到SignalFX的检测器API的检测器模型。
山药布局
对于yaml(更具可读性!),每个文件包含两个yaml文档 由预期的---行分隔。第一个文档,前面的 matter,定义检测器的配置及其规则,以及 通知。第二个文档是 探测器。
---name:The detector namedescription:The detector descriptiontags:[latency,demo]rules:my label:severity:Criticaldescription:Something's wrong!notifications:-type:Emailemail:test@test.com---detect(when(data('demo.trans.latency') > 220, lasting='5s')).publish('my label')
规格
配置探测器的前端物质的规范是 几乎是detector API所期望的。唯一的期望是规则 如果您愿意,可以直接由它们映射到的检测标签设置关键帧。
您还需要查看detector Model以了解更多详细信息 关于通知、规则和可视化选项。
范围界定
如果需要,可以限制同步器将考虑的检测器范围 通过使用标识符指定--scope选项。这将用作 同步器在考虑 哪些探测器应该更新或移除。
这允许从不同的 同一个SignalFX组织中的基地位置,即使其中一个不使用 范围。