{"id":19874450,"url":"https://github.com/strongloop/strong-agent-statsd","last_synced_at":"2025-05-02T10:31:11.132Z","repository":{"id":17485181,"uuid":"20266876","full_name":"strongloop/strong-agent-statsd","owner":"strongloop","description":"publish strong-agent metrics to statsd","archived":false,"fork":false,"pushed_at":"2016-07-14T00:59:45.000Z","size":37,"stargazers_count":9,"open_issues_count":0,"forks_count":2,"subscribers_count":21,"default_branch":"master","last_synced_at":"2025-04-07T01:05:12.717Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/strongloop.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-05-28T17:51:13.000Z","updated_at":"2017-08-15T16:37:53.000Z","dependencies_parsed_at":"2022-08-04T19:15:50.834Z","dependency_job_id":null,"html_url":"https://github.com/strongloop/strong-agent-statsd","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strongloop%2Fstrong-agent-statsd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strongloop%2Fstrong-agent-statsd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strongloop%2Fstrong-agent-statsd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strongloop%2Fstrong-agent-statsd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/strongloop","download_url":"https://codeload.github.com/strongloop/strong-agent-statsd/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252023234,"owners_count":21682146,"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-12T16:23:20.548Z","updated_at":"2025-05-02T10:31:10.886Z","avatar_url":"https://github.com/strongloop.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# strong-agent-statsd\n\nstrong-agent middleware for publishing metrics via statsd protocol.\n\nThe statsd protocol is supported by large ecosystem of servers and plugins,\nallowing publishing into on-premise or custom infrastructure.\n\nSee [strong-agent](https://www.npmjs.org/package/strong-agent).\n\n## Integration points\n\nThere are a number of integration points where strong-agent metrics can be\npublished into hosted or on-premise monitoring and reporting infrastructure.\n\n1. strong-agent metrics can be collected directly using the\n   `require('strong-agent').use()` API, the strong-agent-statsd\n   [source](https://github.com/strongloop/strong-agent-statsd) may be used as an\n   example.\n2. strong-agent-statsd can publish metrics using the statsd protocol to any\n   of a number of\n   [servers](https://github.com/etsy/statsd/wiki#server-implementations)\n   1. [statsd](https://github.com/etsy/statsd) is the original server, it has:\n       1. a built-in [graphite](http://graphite.wikidot.com/) backend, where\n       graphite might be local or [hosted](https://www.hostedgraphite.com/)\n       2. other [backends](https://github.com/etsy/statsd/wiki/Backends),\n       such as for Zabbix, etc.\n       3. support for custom backends, they are easy to write, one of the above\n       backends can be used as an example\n   2. other metrics consumers, such as\n   [datadog](http://docs.datadoghq.com/guides/basic_agent_usage/), have agents\n   that support the statsd-protocol\n3. strong-agent-statd can publish into a custom server written to support\n   existing on-premise infrastructure, the statsd\n   [protocol](https://github.com/b/statsd_spec) is quite simple.\n\nMost metrics reported by strong-agent are 'gauges', a measured value, but a few\nmetrics are best reported as 'counts', values that count events. There are other\n[statsd data types](https://github.com/b/statsd_spec#metric-types--formats), but\nnone are relevant to the metrics currently published by strong-agent.\n\nThis publisher uses the [lynx](https://www.npmjs.org/package/lynx) client.\n\n## publisher = require('strong-agent-statsd')([options])\n\nModule returns a constructor for a publisher function. The publisher requires\nno options, but the following are allowed:\n\n- `options.host` (String) The host to connect to, the default is localhost,\n  as statsd servers usually run on the same host as the client.\n- `options.port` (Number) The port to connect to, the default is `8125`, the\n  default port used by the original statsd server and by most others.\n- `options.scope` (String) A scope to prepend to the metric name before\n  publication, default is none.\n  \n  \nMetrics names are hierarchical dot-seperated strings. When reported by statsd,\nthey will most likely need to fit into a larger hierarchy of all the\napplications, or perhaps an entire system or company.\n\nStatsd servers usually have the ability to scope metrics reported to them, but\nif there are multiple clients reporting to the same server, or if the scope\nshould contain information best known to the client (process ID, application\nname, cluster worker ID) the scoping can occur at source.\n\n## Example\n\nExample integration with strong-agent:\n\n    require('strong-agent').use(\n      require('strong-agent-statsd')()\n    );\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstrongloop%2Fstrong-agent-statsd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstrongloop%2Fstrong-agent-statsd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstrongloop%2Fstrong-agent-statsd/lists"}