require 'pyroscope'

Pyroscope.configure do |config|
  config.application_name = "my.ruby.app" # replace this with some name for your application
  config.server_address   = "http://my-pyroscope-server:4040" # replace this with the address of your Pyroscope server
end

如何向 Ruby 应用程序添加剖析标签

Pyroscope Ruby 集成提供了多种方式来标记剖析数据。例如，您可以在初始化 profiler 时提供标签：

require 'pyroscope'

Pyroscope.configure do |config|
  config.application_name = "my.ruby.app"
  config.server_address   = "http://my-pyroscope-server:4040"

  config.tags = {
    "hostname" => ENV["HOSTNAME"],
  }
end

或者，您可以动态地标记代码的某些部分：

Pyroscope.tag_wrapper({ "controller": "slow_controller_i_want_to_profile" }) do
  slow_code
end

Rails 剖析自动插桩

默认情况下，如果您将 Pyroscope 添加到 Rails 应用程序，它将自动为您的 action 标记一个 action="<controller_name>/<action_name>" 标签。

要禁用 Rails 自动插桩，请将 autoinstrument_rails 设置为 false。

Pyroscope.configure do |config|
  config.autoinstrument_rails = false
  # more configuration
end

使用 Ruby SDK 将数据发送到 Pyroscope OSS 或 Grafana Cloud Profiles

require "pyroscope"

Pyroscope.configure do |config|
  config.application_name = "example.ruby.app"
  config.server_address = "<URL>"
  config.basic_auth_username='<User>'
  config.basic_auth_password='<Password>'
  # Optional Pyroscope tenant ID (only needed if using multi-tenancy). Not needed for Grafana Cloud.
  # config.tenant_id='<TenantID>'
end

要配置 Ruby SDK 将数据发送到 Pyroscope，请将占位符 <URL> 替换为相应的服务器 URL。这可以是 Grafana Cloud URL 或您自己的自定义 Pyroscope 服务器 URL。

如果您需要将数据发送到 Grafana Cloud，您必须配置 HTTP Basic 认证。将 <User> 替换为您的 Grafana Cloud stack 用户，将 <Password> 替换为您的 Grafana Cloud API 密钥。

如果您的 Pyroscope 服务器启用了多租户，您需要配置一个租户 ID。将 <TenantID> 替换为您的 Pyroscope 租户 ID。