快速入门:使用 Beyla 检测 Rust 服务
1. 运行可检测的 Rust 服务
运行可检测的 Rust 服务,或下载并运行一个简单的示例 Rust HTTP 服务。
curl -OL https://raw.githubusercontent.com/grafana/beyla/main/examples/quickstart/rust/quickstart.rs
rustc quickstart.rs && ./quickstart
2. 下载 Beyla
从 Beyla 发布页面下载最新的 Beyla 可执行文件。解压并将 Beyla 可执行文件复制到您 $PATH
中的任何位置。
3. (可选) 获取 Grafana Cloud 凭据
Beyla 可以将指标和追踪数据导出到任何 OpenTelemetry 端点,也可以将指标作为 Prometheus 端点公开。但是,我们建议使用 Grafana Cloud 中的 OpenTelemetry 端点。您可以在 Grafana 网站上获取免费的 Grafana Cloud 账户。
在 Grafana Cloud Portal 中,找到 OpenTelemetry 框并点击 Configure。
在 Password / API token 下方,点击 Generate now 并按照说明创建一个默认的 API token。
Environment Variables 将填充一组标准的 OpenTelemetry 环境变量,这些变量将提供 Beyla 的连接端点和凭据信息。
复制 Environment Variables 并保留以备后续步骤使用。
4. 以最小配置运行 Beyla
要运行 Beyla,首先设置以下环境变量
- 在上一步中复制的
OTEL_EXPORTER_OTLP_PROTOCOL
、OTEL_EXPORTER_OTLP_ENDPOINT
和OTEL_EXPORTER_OTLP_HEADERS
变量。 BEYLA_OPEN_PORT
:被检测服务使用的端口(例如,80
或443
)。如果使用本指南第一部分中的示例服务,将此变量设置为8080
。
为了方便本地测试,设置 BEYLA_TRACE_PRINTER=text
环境变量。设置此选项后,Beyla 将以文本格式打印追踪数据到标准输出。
注意:Beyla 需要管理员 (sudo) 权限,或至少需要被授予 CAP_SYS_ADMIN
能力。
export BEYLA_OPEN_PORT=8080
export BEYLA_TRACE_PRINTER=text
export OTEL_EXPORTER_OTLP_PROTOCOL="http/protobuf"
export OTEL_EXPORTER_OTLP_ENDPOINT="https://otlp-gateway-prod-eu-west-0.grafana.net/otlp"
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Basic ...your-encoded-credentials..."
sudo -E beyla
5. 测试服务
在 Beyla 和服务运行后,向被检测服务发起 HTTP 请求
curl https://:8080/foo
Beyla 应将类似以下的追踪数据输出到标准输出
2024-01-09 10:31:33.19103133 (3.254486ms[3.254486ms]) 200 GET /foo [127.0.0.1]->[127.0.0.1:8080]
size:80B svc=[{quickstart rust lima-ubuntu-lts-5074}] traceparent=[00-46214bd23716280eef43cf798dbe5522-0000000000000000-01]
上面的追踪数据显示
2024-01-09 10:31:33.19103133
:追踪时间(3.254486ms[3.254486ms])
:请求的总响应时间200 GET /foo
:响应代码、HTTP 方法和 URL 路径[127.0.0.1]->[127.0.0.1:8080]
源和目标host:port
size:80B
:HTTP 请求的大小(headers 和 body 的总和)svc=[{quickstart rust lima-ubuntu-lts-5074}]
:quickstart
服务,用rust
编写,服务实例名称lima-ubuntu-lts-5074
为自动创建traceparent
:由父请求接收到的,如果父请求未指定,则为新生成的随机值
几分钟后,追踪数据将出现在 Grafana Cloud 中。例如,在追踪资源管理器中
6. 配置路由
在 Grafana Cloud 中公开的 span 名称是通用的 GET /**
,它应该显示类似 GET /foo
(测试请求 URL 的路径)的内容。
Beyla 将所有未知 URL 路径归类为 /**
,以避免意外的基数爆炸。
配置路由以告知 Beyla 预期的路由。
对于本快速入门,让 Beyla 启发式地对路由进行分组。
首先,创建一个包含以下内容的 config.yml
文件
routes:
unmatched: heuristic
然后,使用 -config
参数运行 Beyla(或改用 BEYLA_CONFIG_PATH
环境变量)
sudo -E beyla -config config.yml
最后,发起 HTTP 请求
curl https://:8080/foo
curl https://:8080/user/1234
curl https://:8080/user/5678
Grafana 现在将启发式地为每个追踪分配一个路由。/foo
获得了自己的路由,而 /user/1234
和 /user/5678
则被分组到 /user/*
路由中。
下一步
- 获取不同 Beyla 配置选项的更多详细信息。
- 了解如何将 Beyla 部署为 Docker 容器或 Kubernetes DaemonSet 或 sidecar。