{"id":17133691,"url":"https://github.com/mjc-gh/sucker_punch-statsd","last_synced_at":"2025-03-24T05:44:15.187Z","repository":{"id":138589911,"uuid":"189495211","full_name":"mjc-gh/sucker_punch-statsd","owner":"mjc-gh","description":"Seamlessly integrate statsd with your sucker_punch jobs","archived":false,"fork":false,"pushed_at":"2020-02-29T17:15:32.000Z","size":11,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-15T08:33:34.757Z","etag":null,"topics":["background-jobs","monitoring","ruby","statsd"],"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/mjc-gh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-30T23:23:10.000Z","updated_at":"2019-06-25T20:08:46.000Z","dependencies_parsed_at":null,"dependency_job_id":"a73a366f-ab48-4d29-86e7-85e28bcd4c48","html_url":"https://github.com/mjc-gh/sucker_punch-statsd","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjc-gh%2Fsucker_punch-statsd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjc-gh%2Fsucker_punch-statsd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjc-gh%2Fsucker_punch-statsd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjc-gh%2Fsucker_punch-statsd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mjc-gh","download_url":"https://codeload.github.com/mjc-gh/sucker_punch-statsd/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245217789,"owners_count":20579297,"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":["background-jobs","monitoring","ruby","statsd"],"created_at":"2024-10-14T19:42:46.681Z","updated_at":"2025-03-24T05:44:15.169Z","avatar_url":"https://github.com/mjc-gh.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SuckerPunch::Statsd\n\nThis gem makes it easy to use statsd with\n[sucker_punch](https://github.com/brandonhilkert/sucker_punch).\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'sucker_punch-statsd'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install sucker_punch-statsd\n\n## Usage\n\nFirst, configure `SuckerPunch::Statsd` with a `:client` and optional\n`:namespace`.\n\n```ruby\nSuckerPunch::Statsd.configure client: statsd_client, prefix: 'my_app'\n```\n\nNow, include the module in any job class that you want to measure\n\n```ruby\nclass LogJob\n  include SuckerPunch::Job\n  include SuckerPunch::Statsd\n\n  # The perform method is automatically wrapped in a Statsd measure\n  # block.\n  def perform\n    Log.new(event).track\n  end\nend\n```\n\n### Configuration Arguments\n\nThe `:client` argument should be a Statsd instance that\nresponds to a `measure` method. Any of the following should work:\n\n- [statsd](https://github.com/reinh/statsd)\n- [statsd-instrument](https://github.com/Shopify/statsd-instrument)\n- [dogstatsd-ruby](https://github.com/DataDog/dogstatsd-ruby)\n\nThe measure metrics produced by this gem will use the Job's class name\nas the metric name. The optional `:namespace` argument will be prepended\nto every metric name when this argument is provided.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT\nLicense](https://opensource.org/licenses/MIT).\n\nIt was built in my spare time to support my work at\n[Knotch](https://www.knotch.it), where we help make brands smarter!\n\n## Code of Conduct\n\nEveryone interacting in the SuckerPunch::Statsd project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mjc-gh/sucker_punch-statsd/blob/master/CODE_OF_CONDUCT.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmjc-gh%2Fsucker_punch-statsd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmjc-gh%2Fsucker_punch-statsd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmjc-gh%2Fsucker_punch-statsd/lists"}