GraphQL-Rails Logger 使用教程

GraphQL-Rails Logger 使用教程

graphql-rails_loggerDisplay GraphQL queries in a more readable format项目地址:https://gitcode.com/gh_mirrors/gr/graphql-rails_logger

项目介绍

GraphQL-Rails Logger 是一个专为 Ruby on Rails 应用设计的 gem，它提供了一个更易读的方式来显示 GraphQL 查询日志。此项目由 JetRuby Agency 维护，旨在优化开发者在处理 GraphQL 请求时的日志查看体验。通过配置，你可以选择性地过滤查询、调整控制台输出的主题，并且能够更好地管理客户端测试期间的大量 GraphQL 情报查询。该 gem 遵循 MIT 许可证，并期望所有贡献者遵守 Contributor Covenant 的行为准则。

项目快速启动

安装步骤

1. 添加到 Gemfile 在你的 Ruby on Rails 项目的 Gemfile 中加入以下行：

   gem 'graphql-rails_logger'
   

2. 执行 Bundle Install 执行命令安装新添加的 gem：

   bundle install
   

3. 基础配置 为了使 gem 生效，通常不需要额外的配置，但如果想限制只在特定控制器的动作中记录 GraphQL 查询，或者想排除情报查询，可以在初始化文件中设置。例如，在 config/initializers/graphql_rails_logger.rb 添加如下配置：

   GraphQL::RailsLogger.configure do |config|
     # 白名单示例
     config.white_list = ['QueriesController' => %w[create]]
   
     # 隐藏情报查询
     config.skip_introspection_query = true
   
     # 更改主题（假设你想使用 Pastie 主题）
     config.theme = Rouge::Themes::Pastie.new
   end
   

日常使用

一旦配置完成，当你在指定的控制器和动作下执行 GraphQL 查询时，日志将以更加清晰的格式呈现。

应用案例和最佳实践

• 日志分析：利用改进后的日志格式，可以更容易地进行错误排查和性能监控。
• 开发调试：在开发过程中，白名单配置确保只有相关查询被记录，减少干扰。
• 生产环境配置：在生产环境中，推荐仔细筛选记录的请求以避免敏感数据暴露，并考虑日志滚动和归档策略。

典型生态项目结合

虽然本项目专注于提高 GraphQL 日志的可读性，它与Ruby on Rails生态中的其他工具如GraphiQL或Rails Admin相结合，可以进一步增强开发和管理GraphQL API的体验。例如， GraphiQL作为图形化的GraphQL查询构建器，可以帮助开发者测试和调试GraphQL端点，而结合了精确的GraphQL日志记录，可以加速问题定位和优化过程。

---

以上就是关于 GraphQL-Rails Logger 的基本介绍、快速启动指南及一些建议。合理运用这个工具，可以显著提升你在处理 GraphQL 相关日志时的工作效率。

graphql-rails_loggerDisplay GraphQL queries in a more readable format项目地址:https://gitcode.com/gh_mirrors/gr/graphql-rails_logger