{"id":33179015,"url":"https://github.com/Netflix/runtime-health","last_synced_at":"2025-11-20T21:03:12.082Z","repository":{"id":47694711,"uuid":"50961051","full_name":"Netflix/runtime-health","owner":"Netflix","description":null,"archived":true,"fork":false,"pushed_at":"2024-12-10T21:05:09.000Z","size":249,"stargazers_count":46,"open_issues_count":1,"forks_count":23,"subscribers_count":372,"default_branch":"master","last_synced_at":"2025-07-01T23:36:24.616Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Netflix.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}},"created_at":"2016-02-03T00:03:45.000Z","updated_at":"2025-04-04T02:06:01.000Z","dependencies_parsed_at":"2025-07-01T23:43:17.199Z","dependency_job_id":null,"html_url":"https://github.com/Netflix/runtime-health","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/Netflix/runtime-health","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Netflix%2Fruntime-health","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Netflix%2Fruntime-health/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Netflix%2Fruntime-health/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Netflix%2Fruntime-health/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Netflix","download_url":"https://codeload.github.com/Netflix/runtime-health/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Netflix%2Fruntime-health/sbom","scorecard":{"id":100349,"data":{"date":"2025-08-11","repo":{"name":"github.com/Netflix/runtime-health","commit":"89a897ad7958551f439fe019d5436665e3a510a0"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.5,"checks":[{"name":"Code-Review","score":2,"reason":"Found 3/14 approved changesets -- score normalized to 2","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":"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":"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":"Maintained","score":0,"reason":"project is archived","details":["Warn: Repository is archived."],"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/nebula-ci.yml:1","Warn: no topLevel permission defined: .github/workflows/nebula-publish.yml:1","Warn: no topLevel permission defined: .github/workflows/nebula-snapshot.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":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: gradle/wrapper/gradle-wrapper.jar:1"],"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":"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/nebula-ci.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/Netflix/runtime-health/nebula-ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nebula-ci.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/Netflix/runtime-health/nebula-ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nebula-ci.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/Netflix/runtime-health/nebula-ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nebula-ci.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/Netflix/runtime-health/nebula-ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nebula-publish.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/Netflix/runtime-health/nebula-publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nebula-publish.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/Netflix/runtime-health/nebula-publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nebula-publish.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/Netflix/runtime-health/nebula-publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nebula-publish.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/Netflix/runtime-health/nebula-publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nebula-snapshot.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/Netflix/runtime-health/nebula-snapshot.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nebula-snapshot.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/Netflix/runtime-health/nebula-snapshot.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nebula-snapshot.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/Netflix/runtime-health/nebula-snapshot.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nebula-snapshot.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/Netflix/runtime-health/nebula-snapshot.yml/master?enable=pin","Info:   0 out of  12 GitHub-owned 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":"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"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: Apache License 2.0: 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":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"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":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 27 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"}}]},"last_synced_at":"2025-08-15T09:59:51.385Z","repository_id":47694711,"created_at":"2025-08-15T09:59:51.386Z","updated_at":"2025-08-15T09:59:51.386Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":285511775,"owners_count":27184237,"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","status":"online","status_checked_at":"2025-11-20T02:00:05.334Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2025-11-16T03:00:36.817Z","updated_at":"2025-11-20T21:03:12.077Z","avatar_url":"https://github.com/Netflix.png","language":"Java","funding_links":[],"categories":["容错组件"],"sub_categories":[],"readme":"Health check\n----------------\nInstance health is an important aspect of any cloud ready application. It is used for service discovery as well as bad instance termination. Through HealthCheck API an application can expose a REST endpoint for external monitoring to ping for health status or integrate with Eureka for service discovery registration based on instance health state. An instance can be in one of 2 lifecycle states: Healthy and Unhealthy. \n\nThe HealthCheck API is broken up into two abstractions to allow for maximum customization.  \n* HealthIndicator - boolean health indicator for a specific application features/aspect.  For example, CPU usage.\n* HealthCheckAggregator - combines indicators to derive a meaningful health state. Responsible caching of HealthIndicators, basic error handling and HealthIndicator timeouts. Also enriches Health information with details such as the indicator name and whether or not a Health entry was cached. \n\n### Artifacts\nRuntime-health is published as the following artifacts:\n```\n# api package for libraries\ncom.netflix.runtime:health-api\n\n# core implementation of runtime-health for applications and services\ncom.netflix.runtime:health-core\n\n# guice integration with module HealthModule() and netflix archaius2 integration for configuration\ncom.netflix.runtime:health-guice\n\n# integration with netflix eureka and bridging of health state and eureka status\ncom.netflix.runtime:health-integrations\n```\n\n### Using HealthCheck in a Jersey resource\n```java\n    @Path(\"/health\")\n    public class HealthCheckResource {\n        @Inject\n        public HealthCheckResource(HealthCheckAggregator healthCheck) {\n            this.healthCheck = healthCheck;\n        }\n\n        @GET\n        public HealthCheckStatus doCheck() {\n            return healthCheck.check().get();\n        }\n    }\n```\n\n### Custom health check\nTo create a custom health indicator simply implement HealthIndicator, inject any objects that are needed to determine the health state, and implement you logic in check().  Note that check returns a future so that the healthcheck system can implement a timeout.  The check() implementation is therefore expected to be well behaved and NOT block.\n\n```java\n    public class MyHealthIndicator implements HealthIndicator {\n        @Inject\n        public MyHealthIndicator(MyService service) {\n            this.service = service;\n        }\n\n        @Override\n        public void check(HealthIndicatorCallback healthCallback) {\n            if (service.getErrorRate() \u003e 0.1) {\n                healthCallback.inform(Health.unhealthy().withDetails(\"errorRate\", service.getErrorRate()));\n            }\n            else {\n                healthCallback.inform(Health.healthy());\n            }\n        }\n    }\n```\n\nTo register a HealthIndicator simply provide it when installing HealthModule.  It will automatically be picked up by the default HealthCheckAggregator\n```java\n InjectorBuilder.fromModules(new HealthModule() {\n      protected void configureHealth() {\n          bindAdditionalHealthIndicator().to(MyHealthIndicator.class);\n          bindAdditionalHealthIndicator().to(AnotherHealthIndicator.class);  //e.g. if you have a second indicator defined\n      }\n }).createInjector()\n```\n\n### Additional Integrations\nSee [health-integrations](https://github.com/Netflix/runtime-health/tree/master/health-integrations) for additional integrations (e.g. with eureka)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNetflix%2Fruntime-health","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FNetflix%2Fruntime-health","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNetflix%2Fruntime-health/lists"}