Yabeda 开源项目教程

Yabeda 开源项目教程

yabeda Extendable framework for collecting and exporting metrics from your Ruby application 项目地址: https://gitcode.com/gh_mirrors/ya/yabeda

1. 项目介绍

Yabeda 是一个可扩展的框架，用于从 Ruby 应用程序中收集和导出指标。它旨在简化 Ruby 应用程序的监控设置，提供了一种模块化的方式来定义和收集各种指标。Yabeda 支持多种监控系统适配器，如 Prometheus、Datadog、NewRelic 等，并且可以通过插件快速集成到常见的 Ruby 框架和库中，如 Rails、Sidekiq、ActiveRecord 等。

2. 项目快速启动

安装

在 Gemfile 中添加 Yabeda 及其插件：

gem 'yabeda'
gem 'yabeda-rails'
gem 'yabeda-prometheus'

然后执行以下命令安装：

bundle install

配置

在应用程序中声明你的指标：

Yabeda.configure do
  group :your_app do
    counter :bells_rang_count, comment: "Total number of bells being rang", tags: %i[bell_size]
    gauge :whistles_active, comment: "Number of whistles ready to whistle"
    histogram :whistle_runtime do
      comment "How long whistles are being active"
      unit :seconds
    end
    summary :bells_ringing_duration, unit: :seconds, comment: "How long bells are ringing"
  end
end

在应用程序初始化后，应用 Yabeda 配置：

Yabeda.configure!

使用

在应用程序中使用定义的指标：

def ring_the_bell(id)
  bell = Bell.find(id)
  bell.ring
  Yabeda.your_app.bells_rang_count.increment(bell_size: bell.size, by: 1)
end

def whistle
  Yabeda.your_app.whistle_runtime.measure do
    # 运行你的代码
  end
end

3. 应用案例和最佳实践

案例1：Rails 应用监控

在 Rails 应用中，可以使用 Yabeda 插件 yabeda-rails 来快速收集基本的请求指标。通过配置 Yabeda，可以轻松监控每个请求的响应时间、请求数量等关键指标。

案例2：Sidekiq 任务监控

对于使用 Sidekiq 的后台任务处理，yabeda-sidekiq 插件可以帮助你监控任务的执行情况，包括任务的执行时间、失败次数等。

最佳实践

1. 模块化配置：将不同的指标分组，便于管理和扩展。
2. 适配器选择：根据实际需求选择合适的监控系统适配器，如 Prometheus 适合实时监控，Datadog 适合日志和事件分析。
3. 插件使用：充分利用 Yabeda 提供的插件，减少自定义代码的编写。

4. 典型生态项目

主要适配器

• yabeda-prometheus：集成 Prometheus 监控系统，提供实时监控和报警功能。
• yabeda-datadog：集成 Datadog，支持日志、事件和指标的统一管理。
• yabeda-newrelic：集成 NewRelic，提供全面的 APM 和监控解决方案。

主要插件

• yabeda-rails：为 Rails 应用提供基本的请求监控。
• yabeda-sidekiq：监控 Sidekiq 任务的执行情况。
• yabeda-activerecord：监控 ActiveRecord 的数据库查询性能。

通过这些适配器和插件，Yabeda 可以轻松集成到各种 Ruby 应用中，提供全面的监控和性能分析。

yabeda Extendable framework for collecting and exporting metrics from your Ruby application 项目地址: https://gitcode.com/gh_mirrors/ya/yabeda