{"id":19312123,"url":"https://github.com/bigcommerce/gruf-lightstep","last_synced_at":"2025-09-11T16:08:33.838Z","repository":{"id":32956727,"uuid":"132672178","full_name":"bigcommerce/gruf-lightstep","owner":"bigcommerce","description":"LightStep tracing for gruf","archived":false,"fork":false,"pushed_at":"2025-06-23T16:33:50.000Z","size":114,"stargazers_count":4,"open_issues_count":0,"forks_count":3,"subscribers_count":16,"default_branch":"main","last_synced_at":"2025-08-25T13:01:22.322Z","etag":null,"topics":["gruf","lightstep","tracing"],"latest_commit_sha":null,"homepage":"","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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-08T22:32:51.000Z","updated_at":"2025-06-23T16:33:54.000Z","dependencies_parsed_at":"2024-02-05T23:43:41.194Z","dependency_job_id":null,"html_url":"https://github.com/bigcommerce/gruf-lightstep","commit_stats":{"total_commits":67,"total_committers":3,"mean_commits":"22.333333333333332","dds":0.04477611940298509,"last_synced_commit":"a2bfee30baba053eefa0a03ec59847f38e2dd3a1"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/bigcommerce/gruf-lightstep","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fgruf-lightstep","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fgruf-lightstep/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fgruf-lightstep/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fgruf-lightstep/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bigcommerce","download_url":"https://codeload.github.com/bigcommerce/gruf-lightstep/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fgruf-lightstep/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274665343,"owners_count":25327174,"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","status":"online","status_checked_at":"2025-09-11T02:00:13.660Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["gruf","lightstep","tracing"],"created_at":"2024-11-10T00:32:56.314Z","updated_at":"2025-09-11T16:08:33.805Z","avatar_url":"https://github.com/bigcommerce.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gruf-lightstep - LightStep tracing for gruf\n\n[![CircleCI](https://circleci.com/gh/bigcommerce/gruf-lightstep/tree/main.svg?style=svg)](https://circleci.com/gh/bigcommerce/gruf-lightstep/tree/main) [![Gem Version](https://badge.fury.io/rb/gruf-lightstep.svg)](https://badge.fury.io/rb/gruf-lightstep) [![Inline docs](http://inch-ci.org/github/bigcommerce/gruf-lightstep.svg?branch=main)](http://inch-ci.org/github/bigcommerce/gruf-lightstep)\n\nAdds LightStep tracing support for [gruf](https://github.com/bigcommerce/gruf) 2.0.0+.\n\n## Installation\n\n```ruby\ngem 'gruf-lightstep'\n```\n\nThen in an initializer or before use, after loading gruf:\n\n```ruby\nrequire 'gruf/lightstep'\n```\n\n### Configuration\n\nYou can use the following ENV vars to configure lightstep:\n\n| Name | Description |\n| ---- | ---- |\n|LIGHTSTEP_ACCESS_TOKEN|LightStep access token, if used in your satellites|\n|LIGHTSTEP_COMPONENT_NAME|The name of your service| \n|LIGHTSTEP_HOST|The host of your lightstep satellites|\n|LIGHTSTEP_PORT|The port of your lightstep satellites|\n\nSee more configuration here: https://github.com/bigcommerce/bc-lightstep-ruby#environment-config\n\n### Server Interceptors\n\nIn your gruf initializer:\n\n```ruby\nGruf.configure do |c|\n  c.interceptors.use(Gruf::Lightstep::ServerInterceptor)\nend\n```\n\nIt comes with a few more options as well:\n\n| Option | Description | Default |\n| ------ | ----------- | ------- |\n| allowlist | An array of parameter key names to log to lightstep. E.g. `[uuid kind]` | `[]` |\n| ignore_methods | An array of method names to ignore from logging. E.g. `['namespace.health.check']` | `[]` |\n\nIt's important to maintain a safe allowlist should you decide to log parameters; gruf does no\nparameter sanitization on its own. We also recommend do not allowlist parameters that may contain\nvery large values (such as binary or json data).\n\n### Client Interceptors\n\nTo automatically propagate the trace context outbound, in your Gruf clients, pass the client interceptor\nto your `Gruf::Client` initializer:\n\n```ruby\nGruf::Client.new(\n  service: MyService,\n  client_options: {\n    interceptors: [Gruf::Lightstep::ClientInterceptor.new]\n  }\n)\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-lightstep","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbigcommerce%2Fgruf-lightstep","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigcommerce%2Fgruf-lightstep/lists"}