{"id":13605609,"url":"https://github.com/rcruzper/express-actuator","last_synced_at":"2026-01-12T07:36:48.661Z","repository":{"id":37419058,"uuid":"74029823","full_name":"rcruzper/express-actuator","owner":"rcruzper","description":"Express middleware with endpoints to help you monitor and manage applications","archived":false,"fork":false,"pushed_at":"2024-10-19T12:14:24.000Z","size":852,"stargazers_count":96,"open_issues_count":5,"forks_count":22,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-10-21T02:56:12.936Z","etag":null,"topics":["actuator","express","health-check","metrics","middleware","monitor","nodejs"],"latest_commit_sha":null,"homepage":"","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/rcruzper.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"rcruzper"}},"created_at":"2016-11-17T13:33:09.000Z","updated_at":"2025-09-04T15:19:58.000Z","dependencies_parsed_at":"2023-02-13T22:45:28.610Z","dependency_job_id":"b134d8c6-e745-4017-8ce1-e89e9afd8ffd","html_url":"https://github.com/rcruzper/express-actuator","commit_stats":{"total_commits":107,"total_committers":9,"mean_commits":11.88888888888889,"dds":0.485981308411215,"last_synced_commit":"5a674b49a7274092e4e4d5e2cfc487020d37c80a"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/rcruzper/express-actuator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rcruzper%2Fexpress-actuator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rcruzper%2Fexpress-actuator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rcruzper%2Fexpress-actuator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rcruzper%2Fexpress-actuator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rcruzper","download_url":"https://codeload.github.com/rcruzper/express-actuator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rcruzper%2Fexpress-actuator/sbom","scorecard":{"id":764725,"data":{"date":"2025-08-11","repo":{"name":"github.com/rcruzper/express-actuator","commit":"5a674b49a7274092e4e4d5e2cfc487020d37c80a"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.5,"checks":[{"name":"Security-Policy","score":4,"reason":"security policy file detected","details":["Info: security policy file detected: SECURITY.md:1","Warn: no linked content found","Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1","Info: Found text in security policy: SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":0,"reason":"Found 0/13 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/rcruzper/express-actuator/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/rcruzper/express-actuator/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/rcruzper/express-actuator/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/rcruzper/express-actuator/codeql-analysis.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-drafter.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/rcruzper/express-actuator/release-drafter.yml/master?enable=pin","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1","Warn: no topLevel permission defined: .github/workflows/release-drafter.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":7,"reason":"SAST tool detected but not run on all commits","details":["Info: SAST configuration detected: CodeQL","Warn: 0 commits out of 26 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"18 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x","Warn: Project is vulnerable to: GHSA-h452-7996-h45h","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5","Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg","Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5","Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-23T00:26:43.950Z","repository_id":37419058,"created_at":"2025-08-23T00:26:43.951Z","updated_at":"2025-08-23T00:26:43.951Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28336582,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T06:09:07.588Z","status":"ssl_error","status_checked_at":"2026-01-12T06:05:18.301Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["actuator","express","health-check","metrics","middleware","monitor","nodejs"],"created_at":"2024-08-01T19:01:00.727Z","updated_at":"2026-01-12T07:36:48.647Z","avatar_url":"https://github.com/rcruzper.png","language":"JavaScript","funding_links":["https://github.com/sponsors/rcruzper"],"categories":["JavaScript","Middleware"],"sub_categories":[],"readme":"# Express Actuator\n\n[![npm version](https://img.shields.io/npm/v/express-actuator.svg?style=flat)](https://badge.fury.io/js/express-actuator)\n[![Build Status](https://api.travis-ci.com/rcruzper/express-actuator.svg?branch=master)](https://app.travis-ci.com/github/rcruzper/express-actuator)\n[![Coverage Status](https://coveralls.io/repos/github/rcruzper/express-actuator/badge.svg?branch=master)](https://coveralls.io/github/rcruzper/express-actuator?branch=master)\n[![Known Vulnerabilities](https://snyk.io/test/npm/express-actuator/badge.svg)](https://snyk.io/test/npm/express-actuator)\n[![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/express-actuator)](https://libraries.io/npm/express-actuator)\n[![npm](https://img.shields.io/npm/dm/express-actuator)](https://www.npmjs.com/package/express-actuator)\n\nThis middleware creates a series of endpoints to help you monitor and manage your application when it's pushed to production. It's useful when you run your application on kubernetes and you are in need of endpoints for [readiness/liveness](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/) probe.\n\nIt is based on [Spring Boot Actuator](http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#production-ready) and the [healthcheck-ping](https://github.com/holidaycheck/healthcheck-ping) module by Mathias Schreck.\n\nTable of Contents\n=================\n\n\u003c!-- toc --\u003e\n\n- [Express Actuator](#express-actuator)\n- [Table of Contents](#table-of-contents)\n  - [Endpoints](#endpoints)\n  - [Installation](#installation)\n      - [Typescript](#typescript)\n  - [Usage](#usage)\n  - [Configuring Actuator](#configuring-actuator)\n    - [Custom Endpoints](#custom-endpoints)\n    - [Deprecated mode](#deprecated-mode)\n  - [Endpoints Examples](#endpoints-examples)\n    - [info](#info)\n    - [metrics](#metrics)\n    - [health](#health)\n  - [Application Information](#application-information)\n    - [Git Commit Information](#git-commit-information)\n  - [Contributing](#contributing)\n\n\u003c!-- tocstop --\u003e\n\n## Endpoints\n\nID | Description\n--- | ---\n`info` | Displays application information.\n`metrics` | Shows metrics information for the current application.\n`health` | Shows application health information.\n\n## Installation\n\n```bash\n$ npm install --save express-actuator\n```\n\n#### Typescript\n```bash\n$ npm install --save-dev @types/express-actuator\n```\n\n## Usage\n\n```js\nconst actuator = require('express-actuator');\nconst app = express();\n\napp.use(actuator());\n```\n\n## Configuring Actuator\nAll defined options are optional:\n\n```js\nconst options = {\n    basePath: '/management', // It will set /management/info instead of /info\n    infoGitMode: 'simple', // the amount of git information you want to expose, 'simple' or 'full',\n    infoBuildOptions: null, // extra information you want to expose in the build object. Requires an object.\n    infoDateFormat: null, // by default, git.commit.time will show as is defined in git.properties. If infoDateFormat is defined, moment will format git.commit.time. See https://momentjs.com/docs/#/displaying/format/.\n    customEndpoints: [] // array of custom endpoints\n};\n\napp.use(actuator(options));\n```\n### Custom Endpoints\nYou can add your own validations using the `customEndpoints` option:\n\n```js\nconst options = {\n    customEndpoints: [\n        {\n            id: 'dependencies', // used as endpoint /dependencies or ${basePath}/dependencies\n            controller: (req, res) =\u003e { // Controller to be called when accessing this endpoint\n                // Your custom code here\n            }\n        }\n    ]\n};\n\napp.use(actuator(options));\n```\n\u003e **_IMPORTANT:_**\n\u003e1. If you call your custom endpoint `info` it **WILL** override the default info.\n\u003e2. If you provide `basePath`, your id will be available as `${basePath}/${id}`, otherwise, just `/${id}`.\n\u003e3. Consider lightweight code being processed by your endpoint controller or it will compete with your main application.\n\n### Deprecated mode\nTo have backward compatibility with previous versions (\u003c= 1.2.0) the legacy way is still available:\n\n```js\napp.use(actuator('/management')); // It will set /management/info instead of /info\n```\n\n\u003e **_IMPORTANT:_** Deprecated mode will be removed in the next major version.\n\n## Endpoints Examples\n### info\n```json\n{\n    \"build\": {\n        \"description\": \"This is my new app\",\n        \"name\": \"MyApp\",\n        \"version\": \"1.0.0\"\n    },\n    \"git\": {\n        \"branch\": \"master\",\n        \"commit\": {\n            \"id\": \"329a314\",\n            \"time\": \"2016-11-18 08:16:39-0500\"\n        }\n    }\n}\n```\n\u003e **_IMPORTANT:_** To get this information the middleware have some sort of logic:\n\u003e1. When the express app is executed with ```node app.js``` or ```npm start``` the module will look for a file named package.json where the node command was launched.\n\u003e2. Git information will show only if exists a ```git.properties``` file where the app was launched. You can use [node-git-info](https://www.npmjs.com/package/node-git-info) to generate this file.\n\n### metrics\n```json\n{\n    \"mem\": {\n        \"heapTotal\": 14659584,\n        \"heapUsed\": 10615072,\n        \"rss\": 30093312\n    },\n    \"uptime\": 19.797\n}\n```\n\n### health\n```json\n{\n  \"status\": \"UP\"\n}\n```\n\n## Application Information\n### Git Commit Information\nThe info endpoint has a feature to publish information about your git source code repository. If a git.properties file is available on your project path, the git.branch, git.commit.id, and git.commit.time properties are exposed.\n\n\u003e **_TIP:_** You can use [node-git-info](https://www.npmjs.com/package/node-git-info) to generate git.properties file on your project.\n\nIf you want to display the full git information (that is, the full content of git.properties), use the infoGitMode property, as follows:\n\n```js\nconst options = {\n    infoGitMode: 'full'\n};\n\napp.use(actuator(options));\n```\n\n## Contributing\n\nThird-party contributions are welcome! 🙏🏼 See [CONTRIBUTING.md](CONTRIBUTING.md) for step-by-step instructions.\n\nIf you need help or have a question, let me know via a GitHub issue.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frcruzper%2Fexpress-actuator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frcruzper%2Fexpress-actuator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frcruzper%2Fexpress-actuator/lists"}