{"id":20038491,"url":"https://github.com/yahoo/mod_statuspage","last_synced_at":"2025-05-05T06:32:13.181Z","repository":{"id":10776762,"uuid":"13042923","full_name":"yahoo/mod_statuspage","owner":"yahoo","description":"Simple express/connect middleware to provide a status page with following details of the nodejs host.","archived":false,"fork":false,"pushed_at":"2023-07-19T07:03:07.000Z","size":273,"stargazers_count":30,"open_issues_count":1,"forks_count":7,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-05-01T17:33:52.884Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yahoo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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":"2013-09-23T18:01:45.000Z","updated_at":"2024-04-19T11:05:10.000Z","dependencies_parsed_at":"2024-10-30T22:51:37.047Z","dependency_job_id":null,"html_url":"https://github.com/yahoo/mod_statuspage","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/yahoo%2Fmod_statuspage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yahoo%2Fmod_statuspage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yahoo%2Fmod_statuspage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yahoo%2Fmod_statuspage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yahoo","download_url":"https://codeload.github.com/yahoo/mod_statuspage/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252451750,"owners_count":21749974,"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-13T10:29:29.554Z","updated_at":"2025-05-05T06:32:12.862Z","avatar_url":"https://github.com/yahoo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"mod_statuspage for Node\n===================\n\nSimple express/connect middleware to provide a status page with following details of the nodejs host.\n\n   * Various Versions - Prints NodeJS Version, OS Version, OS Release\n   * CPU - Average Load on CPU\n   * Memory - Total Memory, Free Memory\n   * Traffic - Total Num of Requests, Requests per second, Total KBs Transferred, Total KBs Out etc.\n   * Workers - List all the worker processes and the information listed above for each of the worker processes\n   \nThis module reads the above data from a unix socket generated from the npm module process-watcher.\nFor more details on process-watcher, please refer https://github.com/yahoo/process-watcher.\n\nThis module is recommended to be used only in a cluster environment. Also this module is designed to\nwork together with monitr (https://github.com/yahoo/monitr) and process-watcher. For an example of them\nworking together please check examples/sample_cluster.js.\n\nInstallation\n------------\n\n`npm install mod_statuspage`\n\nUsage\n-----\n\n```javascript\nvar express = require('express'),\n    status = require('../lib/index.js');\n\nvar app = express();\n\napp.use(status({\n    url: '/status',\n    check: function(req) {\n        if (req.something == false) {\n            return false; //Don't show status\n        }\n        return true; //Show status\n    },\n    responseContentType : 'html'\n}));\n\nconsole.log('Go to: http://127.0.0.1:8000/status');\napp.listen(8000);\n```\n\nConfiguration\n-------------\n\n   * `url` - The URL to respond to, defaults to `/status` \n   * `check` - A function to check the request to see if the status page should be shown. Default: `returns true to always show`\n   * `responseContentType` - The Content-Type of the Response, can be html or json, defaults to `html`\n   * `ejsTemplate` - EJS Template file for html rendering if responseContentType is html, defaults to `status.ejs` bundled with the module\n   * `socketPath` - The socket path written by watchr, defaults to `/tmp/watcher.sock`\n   \n\n\nBuild Status\n------------\n\n[![Build Status](https://secure.travis-ci.org/yahoo/mod_statuspage.png?branch=master)](http://travis-ci.org/yahoo/mod_statuspage)\n\n\nNode Badge\n----------\n\n[![NPM](https://nodei.co/npm/mod_statuspage.png)](https://nodei.co/npm/mod_statuspage/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyahoo%2Fmod_statuspage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyahoo%2Fmod_statuspage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyahoo%2Fmod_statuspage/lists"}