{"id":19312115,"url":"https://github.com/bigcommerce/gruf-profiler","last_synced_at":"2025-07-24T14:08:36.989Z","repository":{"id":49562227,"uuid":"96468190","full_name":"bigcommerce/gruf-profiler","owner":"bigcommerce","description":"Profiler for gruf-backed gRPC requests","archived":false,"fork":false,"pushed_at":"2021-06-14T14:45:25.000Z","size":35,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":17,"default_branch":"main","last_synced_at":"2024-10-18T03:09:12.720Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bigcommerce.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-07-06T20:12:13.000Z","updated_at":"2024-07-29T08:30:20.000Z","dependencies_parsed_at":"2022-09-02T21:21:33.015Z","dependency_job_id":null,"html_url":"https://github.com/bigcommerce/gruf-profiler","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fgruf-profiler","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fgruf-profiler/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fgruf-profiler/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fgruf-profiler/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bigcommerce","download_url":"https://codeload.github.com/bigcommerce/gruf-profiler/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223900372,"owners_count":17222028,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T00:32:55.395Z","updated_at":"2024-11-10T00:32:55.521Z","avatar_url":"https://github.com/bigcommerce.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gruf-profiler - Profiler for gruf\n\n[![CircleCI](https://circleci.com/gh/bigcommerce/gruf-profiler/tree/main.svg?style=svg)](https://circleci.com/gh/bigcommerce/gruf-profiler/tree/main) [![Gem Version](https://badge.fury.io/rb/gruf-profiler.svg)](https://badge.fury.io/rb/gruf-profiler) [![Inline docs](http://inch-ci.org/github/bigcommerce/gruf-profiler.svg?branch=main)](http://inch-ci.org/github/bigcommerce/gruf-profiler)\n\nAdds a profiler interceptor for [gruf](https://github.com/bigcommerce/gruf) 2.0.0 or later.\n\n## Installation\n\n```ruby\ngem 'gruf-profiler'\n```\n\nThen in an initializer or before use, after loading gruf:\n\n```ruby\nrequire 'gruf/profiler'\n\nGruf.configure do |c|\n  c.interceptors.use(Gruf::Profiler::Interceptor)\nend\n```\n\n## Usage\n\ngruf-profiler includes and requires the [rbtrace](https://github.com/tmm1/rbtrace/) \nand [memory_profiler](https://github.com/SamSaffron/memory_profiler) gems by default.\n \n### rbtrace\n\nrbtrace is automatically loaded for every gruf service. You can view the \n[README](https://github.com/tmm1/rbtrace/blob/main/README.md) for rbtrace for more information,\nbut the general idea is that you can run against a running gruf instance to see tracing \ninformation about a gruf server:\n\n```bash\nrbtrace -p \u003cPID_OF_GRUF\u003e --firehose\n```\n\nOther options for the rbtrace binary are detailed in the rbtrace documentation.\n\n### Memory Profiler\n\n[Memory Profiler](https://github.com/SamSaffron/memory_profiler) is a gem that allows you to get\na memory usage report of a block of Ruby code. gruf-profiler automatically wraps gruf service\nrequests with this and provides a report to the logger (at a default level of DEBUG).\n\nYou can adjust that log level to say, INFO, like so:\n\n```ruby\nGruf.configure do |c|\n  c.interceptors.use(Gruf::Profiler::Interceptor, log_level: :info)\nend\n```\n\n## License\n\nCopyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved \n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated \ndocumentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the \nrights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit \npersons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the \nSoftware.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE \nWARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR \nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR \nOTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigcommerce%2Fgruf-profiler","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbigcommerce%2Fgruf-profiler","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigcommerce%2Fgruf-profiler/lists"}