No commit activity in last 3 years
No release in over 3 years
Measure and visualize resolve runtime of every GraphQL field
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 13.0
~> 3.0

Runtime

~> 1.9
 Project Readme

GraphQL::Flamegraph

Collects data for visualizing performance of your GraphQL request resolving for applications built with GraphQL-Ruby.

Installation

  1. Add this line to your application's Gemfile:

    gem 'graphql-flamegraph'

    And then execute:

    $ bundle install
  2. Plug it into your GraphQL schema:

    class YourAppSchema < GraphQL::Schema
      use GraphQL::Flamegraph, path: Rails.root.join("tmp")
    end

Usage

To generate flamegraph for some query, set flamegraph option to true in your context.

result = YourAppSchema.execute(
  query: "query { products { id title quantity … } }",
  context: { flamegraph: true },
  variables: {},
)

Path to the generated file will be printed to standard output like this:

Check your flamegraph at /tmp/graphql-flamegraph-20200320-90923-px3494.txt
Open it in https://www.speedscope.app/ or in local speedscope:

    speedscope /tmp/graphql-flamegraph-20200320-90923-px3494.txt

Also you will be able to access collected data via result.context[:flamegraph].to_s

You can view it with your favorite flamegraph visualizer.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Envek/graphql-flamegraph.

License

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