Ruby PG Extras 使用指南

Ruby PG Extras 使用指南

ruby-pg-extrasRuby PostgreSQL database performance insights. Locks, index usage, buffer cache hit ratios, vacuum stats and more.项目地址:https://gitcode.com/gh_mirrors/ru/ruby-pg-extras

1. 项目目录结构及介绍

Ruby PG Extras 是一个用于深入分析 PostgreSQL 数据库性能的 Ruby 扩展，特别适合那些不使用 Heroku 的 PostgreSQL 插件的 Ruby on Rails 应用程序。以下是其基本的目录结构及关键文件介绍：

• Gemfile: 项目依赖管理文件，列出所有必需的gem包。

• lib: 存放核心代码库，包括 ruby-pg-extras 的主要逻辑实现。

• spec: 单元测试与规范文件夹，确保代码质量。

• Rakefile: 定义了自定义的任务，如数据库相关的维护任务或数据分析。

• LICENSE.txt: 许可证文件，规定软件使用的条款。

• README.md: 项目的主要说明文档，提供快速入门和概述信息。

• ruby-pg-extras.gemspec: Gem 规范文件，包含了版本号、依赖性和其他元数据，用于构建和发布gem。

• github/workflows: 包含自动化工作流的配置，比如CI/CD流程。

• sample/docker-compose.yml: 示例配置文件，用于在Docker环境中运行应用。

2. 项目的启动文件介绍

Ruby PG Extras 本身不是一个独立运行的应用，它通过集成到Ruby on Rails项目中发挥作用。虽然没有传统意义上的“启动文件”，但关键在于将其添加至你的Rails项目的Gemfile中以启用功能：

gem 'rails-pg-extras'

之后，通过执行bundle install来安装这个gem。对于功能的启动，关键在于调用它的API方法或者运行rake任务。例如，使用rake pg_extras:diagnose命令进行数据库诊断。

3. 项目的配置文件介绍

Ruby PG Extras 并没有特定的配置文件，其配置主要是通过环境变量或代码中的配置来完成的。主要配置可以通过以下几种方式调整：

• 环境变量:

  • RAILS_PG_EXTRAS_DATABASE_URL: 指定要连接的数据库URL，以便查询不在默认ActiveRecord连接上的数据库。
  • RAILS_PG_EXTRAS_USER, RAILS_PG_EXTRAS_PASSWORD: 启用UI时设置HTTP Basic认证。
  • RAILS_PG_EXTRAS_PUBLIC_DASHBOARD=true: 可选地，使仪表板公开无需认证访问。

• 代码配置: 在Ruby代码中，可以通过初始化或配置块来定制行为，尽管具体的接口细节需查阅最新的文档或源码注释，因为具体配置方法可能在不同版本间有所变化。

要启用更复杂的配置，如指定额外的web界面动作或修改默认行为，通常需要通过初始化脚本或特定的配置文件（如在Rails中可能创建或修改的config/initializers/rails_pg_extras.rb）来进行。

通过以上介绍，开发者应该能够理解如何在项目中整合并配置Ruby PG Extras，进而利用其提供的强大功能进行PostgreSQL数据库性能分析。

ruby-pg-extrasRuby PostgreSQL database performance insights. Locks, index usage, buffer cache hit ratios, vacuum stats and more.项目地址:https://gitcode.com/gh_mirrors/ru/ruby-pg-extras