跳到主要内容
版本:0.11

Python

Host metrics 是指从运行应用程序的主机的操作系统收集的指标,这些指标包括 CPU、内存、磁盘和网络使用情况。 了解主机指标至关重要,因为它可以帮助你识别可能影响应用程序整体性能的潜在问题或瓶颈。 在本教程中,我们将向你展示如何收集 Host metrics,将它们发送到 GreptimeDB 并进行数据可视化。

创建服务

为了充分体验 GreptimeCloud 的强大功能,你需要创建一个包含身份验证数据库的服务。打开 GreptimeCloud 控制台,注册并登录。然后单击 New Service 按钮并配置以下内容:

  • Service Name: 服务名称。
  • Description: 有关该服务的更多信息。
  • Region: 选择数据库所在的区域。
  • Plan: 选择要使用的定价计划。

现在创建服务,准备向其写入一些数据。

写入数据

准备

示例 Demo

在本节中,我们将创建一个快速开始的 Demo,并展示收集 host 指标并发送到 GreptimeDB 的核心代码。该 Demo 基于OTLP/HTTP。你可以在 GitHub 上获取整个 Demo 以作参考。

首先,创建一个名为 quick-start-python 的新目录来托管我们的项目,然后创建文件 requirements.txt 并添加以下内容:

opentelemetry-api==1.19.0
opentelemetry-exporter-otlp-proto-common==1.19.0
opentelemetry-exporter-otlp-proto-http==1.19.0
opentelemetry-instrumentation==0.40b0
opentelemetry-instrumentation-system-metrics==0.40b0
opentelemetry-proto==1.19.0
opentelemetry-sdk==1.19.0

安装依赖:

pip install -r requirements.txt

安装所需的包后,创建名为 main.py 的新文件并编写代码创建一个 metric exporter 对象,将 metrics 发送到 GreptimeDB。 请参考 GreptimeDBGreptimeCloud 中的 OTLP 集成文档获取 exporter 的相关配置。

from opentelemetry import metrics
from opentelemetry.instrumentation.system_metrics import SystemMetricsInstrumentor
from opentelemetry.sdk.resources import SERVICE_NAME, Resource
from opentelemetry.exporter.otlp.proto.http.metric_exporter import OTLPMetricExporter

auth = f"{username}:{password}"
b64_auth = base64.b64encode(auth.encode()).decode("ascii")
endpoint = f"https://{host}/v1/otlp/v1/metrics"
exporter = OTLPMetricExporter(
endpoint=endpoint,
headers={"Authorization": f"Basic {b64_auth}", "x-greptime-db-name": db},
timeout=5)

将 exporter 附加到 MeterProvider 并开始收集 host metrics:

metric_reader = PeriodicExportingMetricReader(exporter, 5000)
provider = MeterProvider(resource=resource, metric_readers=[metric_reader])

# Sets the global default meter provider
metrics.set_meter_provider(provider)
configuration = {
"system.memory.usage": ["used", "free", "cached"],
"system.cpu.time": ["idle", "user", "system", "irq"],
"process.runtime.memory": ["rss", "vms"],
"process.runtime.cpu.time": ["user", "system"],
}
SystemMetricsInstrumentor(config=configuration).instrument()

请参考 OpenTelemetry 文档 获取有关代码的更多详细信息。

恭喜你完成了 Demo 的核心部分!现在可以按照 GitHub 库README.md 文件中的说明运行完整的 Demo。

连接信息可以在 GreptimeCloud 控制台中找到。

数据可视化

在开发人员的日常工作中,可视化面板中的数据和监控指标非常重要。在 GreptimeCloud 控制台中,单击 Open Prometheus Workbench,然后单击 + New RulesetAdd Group,将组命名为 host-monitor 并添加面板。

要为关注的所有 Table 添加面板,请选择相应的 Table 并逐个单击 Add Panel。添加完所有必要的面板后,单击 save 按钮保存它们。之后你可以在日常工作中通过查看面板来监控指标。此外你可以为 Panel 设置警报规则,以便在指标超过阈值时收到通知。