HealthBit 项目使用教程

HealthBit 项目使用教程

health_bitTiny health check of Rack apps like Rails, Sinatra for use with uptime checking systems like Kubernetes, Docker or Uptimerobot项目地址:https://gitcode.com/gh_mirrors/he/health_bit

目录结构及介绍

HealthBit 项目的目录结构如下：

health_bit/
├── bin/
├── doc/
├── lib/
│   ├── health_bit/
│   │   ├── check.rb
│   │   ├── formatter.rb
│   │   ├── health_bit.rb
│   │   └── version.rb
│   └── health_bit.rb
├── spec/
├── .gitignore
├── .rspec
├── .rubocop.yml
├── CHANGELOG.md
├── Gemfile
├── Gemfile.lock
├── LICENSE.txt
├── README.md
├── Rakefile
└── health_bit.gemspec

目录介绍

• bin/: 包含可执行文件。
• doc/: 包含项目文档。
• lib/: 包含项目的核心代码。
  • health_bit/: 包含 HealthBit 的主要功能文件。
    • check.rb: 定义健康检查的逻辑。
    • formatter.rb: 定义响应格式。
    • health_bit.rb: 主文件，包含配置和运行逻辑。
    • version.rb: 定义版本信息。
  • health_bit.rb: 加载 HealthBit 库的主文件。
• spec/: 包含测试文件。
• .gitignore: Git 忽略文件配置。
• .rspec: RSpec 配置文件。
• .rubocop.yml: RuboCop 代码风格检查配置。
• CHANGELOG.md: 变更日志。
• Gemfile: 依赖管理文件。
• Gemfile.lock: 依赖锁定文件。
• LICENSE.txt: 许可证文件。
• README.md: 项目说明文档。
• Rakefile: Rake 任务配置文件。
• health_bit.gemspec: 项目 gem 的规范文件。

项目的启动文件介绍

HealthBit 项目的启动文件是 lib/health_bit.rb。这个文件负责加载 HealthBit 库并提供启动点。

require 'health_bit'

# 配置 HealthBit
HealthBit.configure do |config|
  config.add('Check name') do
    true
  end
end

# 启动 HealthBit
run HealthBit

项目的配置文件介绍

HealthBit 的配置文件通常在项目的初始化文件中定义，例如在 Rails 项目中，可以在 config/initializers/health_bit.rb 中进行配置。

HealthBit.configure do |config|
  config.success_code = 200
  config.fail_code = 500
  config.show_backtrace = false
  config.formatter = HealthBit::Formatter.new

  config.add('PostgreSQL') do |env|
    ApplicationRecord.connection.select_value('SELECT 1') == 1
  end

  config.add('Custom') do |env|
    next(false) if 1 == 0
    true
  end
end

配置项介绍

• success_code: 成功响应的 HTTP 状态码，默认为 200。
• fail_code: 失败响应的 HTTP 状态码，默认为 500。
• show_backtrace: 是否显示错误回溯信息，默认为 false。
• formatter: 响应格式化器，默认为 HealthBit::Formatter.new。
• add: 添加健康检查项，每个检查项需要返回 true 或 false。

通过以上配置，可以灵活地定义 HealthBit 的行为和检查项。

health_bitTiny health check of Rack apps like Rails, Sinatra for use with uptime checking systems like Kubernetes, Docker or Uptimerobot项目地址:https://gitcode.com/gh_mirrors/he/health_bit