GraphQL::RailsLogger

About

This gem allows you to inspect graphql queries in a more readable format.

This...

becomes this ...

Installation

Add this line to your application's Gemfile:

gem 'graphql-rails_logger'

And then execute:

$ bundle

Configuration

By default this gem formats params only for GraphqlController#execute.

If you want to change this behaviour, add config/initializers/graphql_rails_logger.rb file and set proper controller and actions like this:

GraphQL::RailsLogger.configure do |config|
  config.white_list = {
    'QueriesController' => %w(create)
  }
end

There is an option to suppress (hide) the GraphQL Introspection Query from the console output. This may be helpful to declutter the console during client testing as these can be rather lengthy.

GraphQL::RailsLogger.configure do |config|
  config.skip_introspection_query = true
end

The theme can be configured as well. The theme is applied using the rouge gem, where all available options can be found. The default value is Rouge::Themes::ThankfulEyes.new.

GraphQL::RailsLogger.configure do |config|
  config.theme = Rouge::Themes::Pastie.new
end

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jetruby/graphql-rails_logger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the GraphQL::RailsLogger project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About JetRuby

GraphQL::RailsLogger is maintained and founded by JetRuby Agency.

We love open source software! See our projects or contact us to design, develop, and grow your product.