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 项目的目录结构如下：

graphql-rails_logger/
├── bin/
├── lib/
│   ├── graphql/
│   └── graphql_rails_logger.rb
├── misc/
├── .gitignore
├── CODE_OF_CONDUCT.md
├── Gemfile
├── LICENSE.txt
├── README.md
├── Rakefile
└── graphql-rails_logger.gemspec

目录介绍

• bin/: 包含可执行文件。
• lib/: 包含项目的核心代码。
  • graphql/: 包含与 GraphQL 相关的代码。
  • graphql_rails_logger.rb: 主文件，包含主要的逻辑和配置。
• misc/: 包含其他杂项文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• CODE_OF_CONDUCT.md: 贡献者行为准则。
• Gemfile: 依赖管理文件。
• LICENSE.txt: 许可证文件。
• README.md: 项目说明文档。
• Rakefile: Rake 任务配置文件。
• graphql-rails_logger.gemspec: 项目 gem 的规范文件。

项目的启动文件介绍

项目的启动文件主要是 lib/graphql_rails_logger.rb，这个文件包含了主要的逻辑和配置。在 Rails 应用中，当你安装并配置了这个 gem 后，这个文件会被加载，从而使 GraphQL 查询的日志格式化生效。

项目的配置文件介绍

项目的配置文件主要是 config/initializers/graphql_rails_logger.rb，这个文件用于自定义 GraphQL Rails Logger 的行为。以下是一个示例配置：

GraphQL::RailsLogger.configure do |config|
  config.white_list = [
    'QueriesController' => %w(create)
  ]
  config.skip_introspection_query = true
  config.theme = Rouge::Themes::Pastie.new
end

配置项介绍

• white_list: 指定哪些控制器和动作会被记录。
• skip_introspection_query: 是否跳过 GraphQL 内省查询的记录。
• theme: 日志输出的主题样式，使用 Rouge gem 提供的主题。

通过这些配置，你可以根据需要自定义 GraphQL 查询的日志输出格式和内容。

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