**Active Record Query Trace 使用指南**

Active Record Query Trace 使用指南

active-record-query-traceRails plugin that logs/displays a backtrace of all SQL queries executed by Active Record项目地址:https://gitcode.com/gh_mirrors/ac/active-record-query-trace

本指南旨在帮助您了解并高效地使用 active-record-query-trace 这一Ruby社区中的宝贵工具，该工具专为Rails应用设计，用于增强数据库查询的可追踪性。

1. 项目目录结构及介绍

active-record-query-trace 的仓库遵循Ruby gem的标准结构。以下是主要目录及其功能简介：

• Gemfile: 定义了宝石依赖关系。
• lib: 核心代码所在，包含了gem的主要逻辑实现，如active_record_query_trace模块。
• spec: 单元测试和集成测试的存放区，确保gem的功能完整无误。
• .gitignore: 指定了Git应该忽略哪些文件或目录，通常包括编译产物或个人开发配置等。
• ruby-version: 指定项目推荐使用的Ruby版本。
• travis.yml: Travis CI的配置文件，用于自动化测试流程。
• active_record_query_trace.gemspec: 宝石规范文件，描述了gem的名称、版本、作者、依赖项等重要信息。
• README.md: 项目快速入门和主要特性的说明文档，是新用户开始探索项目的起点。
• LICENSE: 软件许可协议，此项目采用MIT许可证。

2. 项目的启动文件介绍

在本gem的上下文中，没有一个特定的“启动文件”需要手动处理以启用功能。安装并配置好gem后，其功能通过Rails框架自动激活。但若要将gem纳入您的项目，您需在Rails应用程序的Gemfile中添加以下行：

gem 'active_record_query_trace'

随后执行bundle install来安装宝石。

3. 项目的配置文件介绍

配置active-record-query-trace主要是通过在Rails应用的配置文件中设置选项。这通常是在config/environments/development.rb或其他适用环境配置文件中进行。以下是一些关键配置选项示例：

config.active_record.query_trace.ignore_cached_queries = true # 避免缓存查询的堆栈跟踪被打印，默认为false
config.active_record.query_trace.lines = 10 # 控制显示的堆栈跟踪行数，默认5，设为0则显示全部
config.active_record.query_trace.colorize = :light_purple # 开启颜色高亮，默认关闭，可以指定颜色
config.active_record.query_trace.query_type = :read # 只显示读操作（SELECT）的堆栈跟踪，可选值有:read, :write, :all，默认为:all
config.active_record.query_trace.suppress_logging_of_db_reads = true # 是否抑制所有读取（SELECT）操作的日志记录，默认false

这些配置允许您定制日志输出的行为，以更好地适应开发和调试的需求。确保在实际部署前，理解每项配置的效果，以免无意间泄露敏感的堆栈信息到生产环境日志中。

---

通过以上指导，您可以顺利地将active-record-query-trace集成到您的Rails项目中，有效追踪和优化数据库查询，提升开发效率和应用性能。

active-record-query-traceRails plugin that logs/displays a backtrace of all SQL queries executed by Active Record项目地址:https://gitcode.com/gh_mirrors/ac/active-record-query-trace