https://github.com/envek/graphql-flamegraph
Collects data for visualizing performance of your GraphQL request resolving for applications built with GraphQL-Ruby
https://github.com/envek/graphql-flamegraph
Last synced: 8 months ago
JSON representation
Collects data for visualizing performance of your GraphQL request resolving for applications built with GraphQL-Ruby
- Host: GitHub
- URL: https://github.com/envek/graphql-flamegraph
- Owner: Envek
- License: mit
- Created: 2020-03-20T19:43:53.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-20T19:46:29.000Z (almost 6 years ago)
- Last Synced: 2025-05-07T17:52:08.140Z (8 months ago)
- Language: Ruby
- Size: 8.79 KB
- Stars: 11
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this 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:
```ruby
gem 'graphql-flamegraph'
```
And then execute:
```shell script
$ bundle install
```
2. Plug it into your GraphQL schema:
```ruby
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.
```ruby
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](https://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](https://opensource.org/licenses/MIT).
[GraphQL-Ruby]: https://graphql-ruby.org/ "Ruby implementation of GraphQL"