{"id":20806315,"url":"https://github.com/nodesource/nsolid-graphite","last_synced_at":"2025-05-11T17:31:44.747Z","repository":{"id":57145958,"uuid":"85760789","full_name":"nodesource/nsolid-graphite","owner":"nodesource","description":"A daemon that sends N|Solid metrics to a graphite-compatible endpoint","archived":true,"fork":false,"pushed_at":"2017-07-10T21:34:23.000Z","size":43,"stargazers_count":0,"open_issues_count":0,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-02-25T21:37:02.795Z","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":"2017-03-21T22:40:40.000Z","updated_at":"2025-01-30T21:17:32.000Z","dependencies_parsed_at":"2022-09-03T17:41:36.480Z","dependency_job_id":null,"html_url":"https://github.com/nodesource/nsolid-graphite","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodesource%2Fnsolid-graphite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodesource%2Fnsolid-graphite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodesource%2Fnsolid-graphite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodesource%2Fnsolid-graphite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nodesource","download_url":"https://codeload.github.com/nodesource/nsolid-graphite/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253604846,"owners_count":21934906,"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:16.327Z","updated_at":"2025-05-11T17:31:44.435Z","avatar_url":"https://github.com/nodesource.png","language":"JavaScript","readme":"nsolid-graphite - a daemon that sends N|Solid metrics to graphite\n================================================================================\n\nThis package provides a daemon which will monitor [N|Solid][] Storage and send\nthe metrics from the N|Solid runtimes to [graphite][] via the Graphite protocol\nover UDP.\n\ninstallation\n================================================================================\n\n    npm install nsolid-graphite\n\n\nusage\n================================================================================\n\n    nsolid-graphite [options] [graphite-address [storage-address]]\n\nwhere:\n\n    graphite-address - the {address} of the graphite UDP server\n                     default: localhost:2003\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 graphite metric names with the specified value\n                           default: 'nsolid'\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 graphite-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 2003 for graphite-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\nexamples\n================================================================================\n\n    nsolid-graphite example.com\n\nPoll metrics from the N|Solid storage at `localhost:4000` and send them to the\ngraphite server at `example.com:2003`.\n\ndocker\n================================================================================\n\nNodeSource provides a Docker image to easily get add `nsolid-graphite` to an\nenvironment already using containers.\n\n    docker pull nodesource/nsolid-graphite\n\nRunning the `nsolid-graphite` image\n\n    docker run -d --name=\"nsolid-graphite\" nsolid-graphite graphite:2003 storage:4000 \n\nPoll metrics every second from the N|Solid storage at `storage:4000` and send them to the\ngraphite server at `graphite:2003`. \n\n`nsolid-graphite` also supports using environment variables for providing the N|Solid\nStorage and graphite endpoints\n\n    docker run -d --name=\"nsolid-graphite\" -e NSOLID_ADDRESS=storage:4000 -e GRAPHITE_ADDRESS=graphite:2003 nsolid-graphite\n\n\n\ngraphite metric names\n================================================================================\n\nN|Solid gathers an extensive list of metrics from the N|Solid Runtime to provide\nthe greatest insight into your Node.js applications.\n\nThe full list of metrics with descriptions can be found at [N|Solid Metrics][].\n\nThe default format of the metric names is: \n\n{prefix}.{app}.{hostname}.{statName}\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\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 graphite 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 hostname\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\"\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\"\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\"\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-graphite** is Copyright (c) 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[graphite]: https://graphiteapp.org/\n[npm rc module]: https://www.npmjs.com/package/rc\n[issue at GitHub]: https://github.com/nodesource/nsolid-graphite/issues\n[CONTRIBUTING.md]: CONTRIBUTING.md\n[LICENSE.md]: LICENSE.md\n[N|Solid Metrics]: https://docs.nodesource.com/nsolid/2.2/docs#metrics-in-detail","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodesource%2Fnsolid-graphite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnodesource%2Fnsolid-graphite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodesource%2Fnsolid-graphite/lists"}