菜单
文档面包屑箭头 Beyla面包屑箭头 快速入门面包屑箭头 Ruby 快速入门
Grafana Cloud

快速入门:使用 Beyla 检测 Ruby 服务

1. 运行可检测的 Ruby 服务

运行一个可检测的 Ruby 服务,或下载并运行一个简单的 Ruby HTTP 服务示例。

curl -OL https://raw.githubusercontent.com/grafana/beyla/main/examples/quickstart/ruby/quickstart.rb
ruby quickstart.rb

2. 下载 Beyla

Beyla 发行页面下载最新的 Beyla 可执行文件。解压缩并将 Beyla 可执行文件复制到您的 $PATH 环境变量中的任何位置。

3. (可选) 获取 Grafana Cloud 凭据

Beyla 可以将指标和追踪导出到任何 OpenTelemetry 端点,也可以将指标作为 Prometheus 端点暴露。然而,我们建议使用 Grafana Cloud 中的 OpenTelemetry 端点。您可以在 Grafana 网站上获取一个免费的 Grafana Cloud 账户。

在 Grafana Cloud Portal 中,找到 OpenTelemetry 框并点击 配置

OpenTelemetry Grafana Cloud portal

密码 / API token 下点击 立即生成 并按照说明创建一个默认的 API token。

环境变量 将会填充一组标准的 OpenTelemetry 环境变量,它们将为 Beyla 提供连接端点和凭据信息。

OTLP connection headers

复制 环境变量 并保留用于下一步。

4. 使用最少配置运行 Beyla

要运行 Beyla,首先设置以下环境变量

  • 从上一步复制的 OTEL_EXPORTER_OTLP_PROTOCOL, OTEL_EXPORTER_OTLP_ENDPOINTOTEL_EXPORTER_OTLP_HEADERS 变量。
  • BEYLA_OPEN_PORT:被检测的服务正在使用的端口(例如,80443)。如果使用本指南第一部分中的示例服务,将此变量设置为 8080

为了方便本地测试,设置 BEYLA_TRACE_PRINTER=text 环境变量。当设置此选项时,Beyla 会将追踪信息以文本格式打印到标准输出。

同时设置 BEYLA_SERVICE_NAME=quickstart 来覆盖追踪和指标中报告的服务名称。如果不设置,Beyla 将自动报告进程可执行文件的名称:ruby

注意:Beyla 需要管理员 (sudo) 权限,或者至少需要被授予 CAP_SYS_ADMIN 能力。

sh
export BEYLA_SERVICE_NAME=quickstart
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 ruby 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 请求大小(头部和正文的总和)
  • svc=[{quickstart ruby lima-ubuntu-lts-5074}]quickstart 服务,运行在 Ruby 中,服务实例名称 lima-ubuntu-lts-5074 是自动创建的
  • 由父请求接收到的 traceparent,如果父请求未指定则为新的随机值

几分钟后,追踪信息将出现在 Grafana Cloud 中。例如,在追踪浏览器中

Beyla traces explorer

6. 配置路由

Grafana Cloud 中显示的 Span 名称是通用的 GET /**,而它应该显示类似于 GET /foo(测试请求 URL 的路径)的信息。

Beyla 将所有未知的 URL 路径归类为 /**,以避免意外的基数爆炸。

配置路由来告诉 Beyla 预期的路由。

对于本快速入门,让 Beyla 启发式地对路由进行分组。

首先,创建一个包含以下内容的 config.yml 文件

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 grouped traces

下一步