{"id":21948267,"url":"https://github.com/instrumental/statsd-instrumental-backend","last_synced_at":"2025-04-23T00:18:09.902Z","repository":{"id":4754837,"uuid":"5904846","full_name":"Instrumental/statsd-instrumental-backend","owner":"Instrumental","description":"StatsD Backend for Instrumental Application Monitoring","archived":false,"fork":false,"pushed_at":"2020-04-14T21:56:51.000Z","size":114,"stargazers_count":18,"open_issues_count":1,"forks_count":2,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-04-23T00:17:59.202Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://instrumentalapp.com","language":"JavaScript","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/Instrumental.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-09-21T17:21:50.000Z","updated_at":"2020-04-14T21:56:54.000Z","dependencies_parsed_at":"2022-09-11T03:40:27.378Z","dependency_job_id":null,"html_url":"https://github.com/Instrumental/statsd-instrumental-backend","commit_stats":null,"previous_names":["expectedbehavior/statsd-instrumental-backend"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Instrumental%2Fstatsd-instrumental-backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Instrumental%2Fstatsd-instrumental-backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Instrumental%2Fstatsd-instrumental-backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Instrumental%2Fstatsd-instrumental-backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Instrumental","download_url":"https://codeload.github.com/Instrumental/statsd-instrumental-backend/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250343960,"owners_count":21415042,"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-29T05:12:50.558Z","updated_at":"2025-04-23T00:18:09.871Z","avatar_url":"https://github.com/Instrumental.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# StatsD Instrumental Backend\n\n\n## Overview\n\nInstrumental is a [application monitoring platform](https://instrumentalapp.com) built for developers who want a better understanding of their production software. Powerful tools, like the [Instrumental Query Language](https://instrumentalapp.com/docs/query-language), combined with an exploration-focused interface allow you to get real answers to complex questions, in real-time.\n\nThis is a pluggable StatsD backend for sending metrics to Instrumental.\n\n## Requirements\n\n* [StatsD][statsd] versions \u003e= 0.3.0.\n* An [Instrumental](https://instrumentalapp.com) account.\n\n## Installation\n\n    $ cd /path/to/statsd\n    $ npm install statsd-instrumental-backend\n\n## Configuration\n\nSee our [example config file](exampleConfig.js) for a complete StatsD configuration.\n\nOtherwise, add the following basic configuration information to your\nStatsD config file.\n\n```js\n{\n  instrumental: {\n    key: \"[project token]\",       // REQUIRED\n    secure: true,                 // OPTIONAL (boolean), whether or not to use secure protocol to connect to Instrumental, default true\n    verifyCert: true,             // OPTIONAL (boolean), should we attempt to verify the server certificate before allowing communication, default true\n    timeout: 10000,               // OPTIONAL (integer), number of milliseconds to wait for establishing a connection to Instrumental before giving up, default 10s\n    recordCounterRates: true,     // OPTIONAL (boolean) whether or not to send \".rate\" metrics with counters, default true\n    metricPrefix: \"\",             // OPTIONAL (string) this will be prepended (with a dot) to ALL of your metrics\n    metricFiltersExclude: [],     // OPTIONAL (array of regexes) any metrics matching these filters will be dropped. e.g, [/\\.rate$/, /\\.[^\\.]*_99$/] would filter out counter rates and extra metrics for stats like upper_99, mean_99, etc.\n    metricFiltersInclude: []      // OPTIONAL (array of regexes) any metrics _NOT_ matching at least one of these filters will be dropped\n  }\n}\n```\n\n### Filtering Metrics\n\nMetrics can be filtered with either the `metricFiltersExclude` or `metricFiltersInclude` options. Note that for a metric to be sent, it must match at least one include *and* no excludes.  An empty or missing metricFiltersInclude option will allow all metrics (assuming the exclusion filter does not exclude any).\n\n## Enabling\n\nThis is already done if you are using our [example configuration](exampleConfig.js).\n\nOtherwise, add `statsd-instrumental-backend` backend to the list of StatsD\nbackends in the StatsD configuration file:\n\n```js\n{\n  backends: [\"statsd-instrumental-backend\"]\n}\n```\n\nStart/restart the statsd daemon and your StatsD metrics should now be\npushed to your Instrumental account.\n\n## NPM Dependencies\n\nNone\n\n## Development\n\n- [Instrumental Backend](https://github.com/expectedbehavior/statsd-instrumental-backend)\n\nContributing:\n\n* Fork the project\n* Make your feature addition or bug fix\n* Commit. Do not mess with package.json, version, or history.\n* Send a pull request. Bonus points for topic branches.\n\n[statsd]: https://github.com/etsy/statsd\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finstrumental%2Fstatsd-instrumental-backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finstrumental%2Fstatsd-instrumental-backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finstrumental%2Fstatsd-instrumental-backend/lists"}