{"id":19312114,"url":"https://github.com/bigcommerce/gruf-sentry","last_synced_at":"2025-06-25T19:03:02.339Z","repository":{"id":40476790,"uuid":"251730400","full_name":"bigcommerce/gruf-sentry","owner":"bigcommerce","description":"Sentry integration for gruf","archived":false,"fork":false,"pushed_at":"2025-06-23T17:27:54.000Z","size":62,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-06-23T18:33:01.938Z","etag":null,"topics":["grpc","gruf","ruby","sentry"],"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":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-31T21:00:12.000Z","updated_at":"2025-06-23T17:27:57.000Z","dependencies_parsed_at":"2024-02-05T23:31:26.442Z","dependency_job_id":"d3e754f0-e7d8-4e8e-80e4-3b68e759b2c1","html_url":"https://github.com/bigcommerce/gruf-sentry","commit_stats":{"total_commits":37,"total_committers":3,"mean_commits":"12.333333333333334","dds":"0.16216216216216217","last_synced_commit":"1f75a877a744b7802cfaf9760a44b331bf90d2ef"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/bigcommerce/gruf-sentry","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fgruf-sentry","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fgruf-sentry/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fgruf-sentry/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fgruf-sentry/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bigcommerce","download_url":"https://codeload.github.com/bigcommerce/gruf-sentry/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fgruf-sentry/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261538301,"owners_count":23174097,"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":["grpc","gruf","ruby","sentry"],"created_at":"2024-11-10T00:32:55.137Z","updated_at":"2025-06-25T19:03:02.313Z","avatar_url":"https://github.com/bigcommerce.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gruf-sentry - Sentry reporting for gruf\n\n[![CircleCI](https://circleci.com/gh/bigcommerce/gruf-sentry/tree/main.svg?style=svg)](https://circleci.com/gh/bigcommerce/gruf-sentry/tree/main) [![Gem Version](https://badge.fury.io/rb/gruf-sentry.svg)](https://badge.fury.io/rb/gruf-sentry) [![Inline docs](http://inch-ci.org/github/bigcommerce/gruf-sentry.svg?branch=main)](http://inch-ci.org/github/bigcommerce/gruf-sentry) [![Maintainability](https://api.codeclimate.com/v1/badges/530757a403a4a596dda0/maintainability)](https://codeclimate.com/github/bigcommerce/gruf-sentry/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/530757a403a4a596dda0/test_coverage)](https://codeclimate.com/github/bigcommerce/gruf-sentry/test_coverage)\n\nAdds Sentry error reporting support for [gruf](https://github.com/bigcommerce/gruf) 2.7.0+\nand [sentry-ruby](https://github.com/getsentry/sentry-ruby) 4.3+.\n\nThis gem will automatically report grpc failures and Gruf errors into Sentry as they happen in servers and clients.\n\n## Installation\n\nSimply install the gem:\n\n```ruby\ngem 'gruf-sentry'\n```\n\nThen after, in your gruf initializer:\n\n```ruby\nGruf.configure do |c|\n  c.interceptors.use(Gruf::Sentry::ServerInterceptor)\nend\n```\n\nIt comes with a few more options as well:\n\n| Option             | Description                                                                                    | Default                                                                                                                         | ENV Key                          |\n|--------------------|------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|----------------------------------|\n| ignore_methods     | A list of method names to ignore from logging. E.g. `['namespace.health.check']`               | `[]`                                                                                                                            | GRUF_SENTRY_IGNORE_METHODS       |\n| grpc_error_classes | A list of gRPC error classes that will be used for detecting errors (as opposed to validation) | `GRPC::Unknown,GRPC::Internal,GRPC::DataLoss,GRPC::FailedPrecondition,GRPC::Unavailable,GRPC::DeadlineExceeded,GRPC::Cancelled` | GRUF_SENTRY_GRPC_ERROR_CLASSES   |\n| default_error_code | The default gRPC error code to use (int value)                                                 | `GRPC::Core::StatusCodes::INTERNAL`                                                                                             | `GRUF_SENTRY_DEFAULT_ERROR_CODE` |                                                                               \n\n### Client Interceptors\n\nTo automatically report errors in your Gruf clients, pass the client interceptor to your `Gruf::Client` initializer:\n\n```ruby\nGruf::Client.new(\n  service: MyService,\n  client_options: {\n    interceptors: [Gruf::Sentry::ClientInterceptor.new]\n  }\n)\n```\n\n## License\n\nCopyright (c) 2020-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-sentry","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbigcommerce%2Fgruf-sentry","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigcommerce%2Fgruf-sentry/lists"}