lb-telemetry

一个用于记录关于LHCb软件包的遥测数据的工具，数据可在MONIT上查看。每个软件包的特定使用数据图可在MONIT Grafana上查看。

该软件包不可由用户调用。它旨在被其他LHCb软件包，如PIDCalib2导入并调用。

设置

从PyPI安装

该软件包可在PyPI上找到。可以通过运行pip（最好在虚拟环境中）安装到任何计算机上。

pip install lb-telemetry

使用方法

添加到软件包中

from lb_telemetry import Logger

# Time execution (optional)
start_time = time.perf_counter()
do_some_task()
exec_time = time.perf_counter() - start_time

telemetry = {
    "exec_time": exec_time,
    "version": VERSION,
    "some_field": "field_value",
    "some_tag": "tag_value",
}

Logger().log_to_monit(
    "NameOfThisPackage",  # Or other readable identifier
    telemetry,
    tags=["version", "some_tag"],  # `exec_time` and `some_field` interpreted as fields
)

运行命令行界面

--table的默认值为'CLI'。

lb-telemetry send '{"test_field": "test_value"}' --include-host-info

可以通过以下方式指定标签

lb-telemetry send '{"field1": 0, "tag1": 5, "tag2": 2}' --table some_table --tags tag1 tag2

查看遥测数据

已记录的遥测数据通常在不到一分钟内可见，可以通过此Grafana仪表板访问。如果需要，可从LHCb Grafana org管理员那里请求编辑仪表板的权限。然后在仪表板上为您的软件包创建新的行并添加所需的图表。