{"id":20806337,"url":"https://github.com/nodesource/nsolid-statsd","last_synced_at":"2025-05-11T17:31:50.010Z","repository":{"id":57312317,"uuid":"47350267","full_name":"nodesource/nsolid-statsd","owner":"nodesource","description":"a daemon that sends N|Solid metrics to statsd","archived":true,"fork":false,"pushed_at":"2017-06-15T22:53:58.000Z","size":57,"stargazers_count":4,"open_issues_count":0,"forks_count":6,"subscribers_count":32,"default_branch":"master","last_synced_at":"2025-04-30T01:04:51.871Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nodesource.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":null,"security":null,"support":null}},"created_at":"2015-12-03T18:02:42.000Z","updated_at":"2025-02-01T14:01:05.000Z","dependencies_parsed_at":"2022-08-27T16:50:43.993Z","dependency_job_id":null,"html_url":"https://github.com/nodesource/nsolid-statsd","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodesource%2Fnsolid-statsd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodesource%2Fnsolid-statsd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodesource%2Fnsolid-statsd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodesource%2Fnsolid-statsd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nodesource","download_url":"https://codeload.github.com/nodesource/nsolid-statsd/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253604882,"owners_count":21934913,"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-17T19:19:24.198Z","updated_at":"2025-05-11T17:31:49.761Z","avatar_url":"https://github.com/nodesource.png","language":"JavaScript","readme":"nsolid-statsd - a daemon that sends N|Solid metrics to statsd\n================================================================================\n\nThis package provides a daemon which will monitor [N|Solid][] runtimes and send\nthe metrics from the runtimes to [statsd][].  The runtimes that are monitored\nare selected based on the command-line parameters.\n\n\ninstallation\n================================================================================\n\n    npm install nsolid-statsd\n\n\nusage\n================================================================================\n\n    nsolid-statsd [options] [statsd-address [storage-address]]\n\nwhere:\n\n    statsd-address - the {address} of the statsd UDP server\n                     default: localhost:8125\n\n    storage-address  - the {address} of the N|Solid storage server's API port\n                     default: localhost:4000\n\nSee {address} below for the expected format of these addresses.\n\noptions are:\n\n    -h --help            - print some help text\n    -v --version         - print the program version\n    --app \u003capp name\u003e     - the N|Solid application name to monitor\n                           default: monitor all applications\n    --prefix \u003cvalue\u003e     - prefix statsd metric names with the specified value\n                           default: 'nsolid'\n    --tags \u003cboolean\u003e     - append N|Solid tags to the metrics\n                           default: false\n\nOptions are parsed with the [npm rc module][], and so options can be set in\nenvironment variables or files, as supported by rc.  For example, you can\nspecify options in a file named `.nsolid-statsdrc`.\n\nThe {address} parameter of the statsd-address and storage-address parameters\nshould be in one of the following formats:\n\n    :\n    port\n    host\n    host:port\n\nIf port is not specified, the default is 8125 for statsd-address, and 4000 for\nstorage-address. If host is not specified, the default is localhost.  The host\nmay be a hostname or IPv4 address.\n\nWhen the `--tags` option is used, the metrics sent to statsd will be modified\nto include the tags value associated with the N|Solid instance the metric\noriginated from.  If the tags associated with an N|Solid instance are `tag-A`,\n`tag-B`, and `tag-C`, the metrics will have the following string appended to\nthem:\n\n    |#tag-A,tag-B,tag-C\n\nTag suffixes are an extension to statsd and not supported by all statsd servers.\n\n\nexamples\n================================================================================\n\n    nsolid-statsd example.com\n\nPoll metrics from the N|Solid storage at `localhost:4000` and send them to the\nstatsd server at `example.com:8125`.\n\n    nsolid-statsd --tags true -- : example.com\n\nPoll metrics every second from the N|Solid storage at `example.com:4000` and\nsend them to the statsd server at `localhost:8125`.  Send the N|Solid\napplication tags as suffixes on the metrics.\n\ndocker\n================================================================================\n\nNodeSource provides a Docker image to easily get add `nsolid-statsd` to an\nenvironment already using containers.\n\n    docker pull nodesource/nsolid-statsd\n\nRunning the `nsolid-statsd` image\n\n    docker run -d --name=\"nsolid-statsd\" nsolid-statsd --tags storage:4000 statsd:8125\n\nPoll metrics every second from the N|Solid storage at `storage:4000` and send them to the\nstatsd server at `statsd:8125`. It also sends the N|Solid application tags as suffixes\non the metrics.\n\n`nsolid-statsd` also supports using environment variables for providing the N|Solid\nStorage and statsd endpoints\n\n    docker run -d --name=\"nsolid-statsd\" -e NSOLID_ADDRESS=storage:4000 -e STATSD_ADDRESS=statsd:8125 nsolid-statsd\n\n\n\nstatsd metric names\n================================================================================\n\nThe association of N|Solid metrics to statsd metrics is as follows:\n\nN-Solid metric   | statsd metric\n---------------  | -------------\nactiveHandles    | {prefix}.{app}.process.activeHandles\nactiveRequests   | {prefix}.{app}.process.activeRequests\ncpu              | {prefix}.{app}.process.cpu\ncpuSpeed         | {prefix}.{app}.system.cpuSpeed\nfreeMem          | {prefix}.{app}.system.freeMem\nheapTotal        | {prefix}.{app}.process.heapTotal\nheapUsed         | {prefix}.{app}.process.heapUsed\nload15m          | {prefix}.{app}.system.load15m\nload1m           | {prefix}.{app}.system.load1m\nload5m           | {prefix}.{app}.system.load5m\nrss              | {prefix}.{app}.process.rss\n\nThe `{prefix}` value can be specified via command-line option, and defaults to\n`nsolid`.  The `{app}` value is the name of the N|Solid application.\n\nFor more information about the N|Solid metrics, see the\n[N|Solid Process and System Statistics documentation][].\n\n\nstring value normalization\n================================================================================\n\nString values which are provided by N|Solid will be normalized in the following\nfashion before being used in a statsd metric\n\n* characters which are not alpha-numeric or \"-\" or \"_\" will be converted to \"-\"\n* strings that are greater than 200 characters will be truncated to 200 characters\n\nThe values which are affected are:\n\n* N|Solid application name\n* N|Solid tags\n\n\ncontributing\n================================================================================\n\nTo submit a bug report, please create an [issue at GitHub][].\n\nIf you'd like to contribute code to this project, please read the\n[CONTRIBUTING.md][] document.\n\nAuthors and Contributors\n================================================================================\n\n\u003ctable\u003e\u003ctbody\u003e\n  \u003ctr\u003e\n    \u003cth align=\"left\"\u003ePatrick Mueller\u003c/th\u003e\n    \u003ctd\u003e\u003ca href=\"https://github.com/pmuellr\"\u003eGitHub/pmuellr\u003c/a\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ca href=\"https://twitter.com/pmuellr\"\u003eTwitter/@pmuellr\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003cth align=\"left\"\u003eDave Olszewski\u003c/th\u003e\n    \u003ctd\u003e\u003ca href=\"https://github.com/cxreg\"\u003eGitHub/cxreg\u003c/a\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ca href=\"https://twitter.com/cxreg\"\u003eTwitter/@cxreg\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003cth align=\"left\"\u003eJoe Doyle\u003c/th\u003e\n    \u003ctd\u003e\u003ca href=\"https://github.com/joedoyle23\"\u003eGitHub/JoeDoyle23\u003c/a\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ca href=\"https://twitter.com/JoeDoyle23\"\u003eTwitter/@JoeDoyle23\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003cth align=\"left\"\u003eJohannes Würbach\u003c/th\u003e\n    \u003ctd\u003e\u003ca href=\"https://github.com/johanneswuerbach\"\u003eGitHub/johanneswuerbach\u003c/a\u003e\u003c/td\u003e\n    \u003ctd\u003e\u0026nbsp;\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/tbody\u003e\u003c/table\u003e\n\n\nLicense \u0026 Copyright\n================================================================================\n\n**nsolid-statsd** is Copyright (c) 2016-2017 NodeSource and licensed under the\nMIT license. All rights not explicitly granted in the MIT license are reserved.\nSee the included [LICENSE.md][] file for more details.\n\n\n[N|Solid]: https://nodesource.com/products/nsolid\n[statsd]: https://github.com/etsy/statsd\n[npm rc module]: https://www.npmjs.com/package/rc\n[N|Solid Process and System Statistics documentation]: https://docs.nodesource.com/docs/using-the-cli\n[issue at GitHub]: https://github.com/nodesource/nsolid-statsd/issues\n[CONTRIBUTING.md]: CONTRIBUTING.md\n[LICENSE.md]: LICENSE.md\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodesource%2Fnsolid-statsd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnodesource%2Fnsolid-statsd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodesource%2Fnsolid-statsd/lists"}