{"id":28183268,"url":"https://github.com/visualbean/healthcheckdashboard.net","last_synced_at":"2025-05-16T04:15:44.389Z","repository":{"id":288733719,"uuid":"844999883","full_name":"VisualBean/HealthCheckDashboard.NET","owner":"VisualBean","description":"A health dashboard built on top of `IHealthCheck`","archived":false,"fork":false,"pushed_at":"2025-05-14T12:01:30.000Z","size":37,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-14T12:31:36.459Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","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/VisualBean.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":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-08-20T11:41:30.000Z","updated_at":"2025-05-14T12:08:45.000Z","dependencies_parsed_at":"2025-05-14T12:31:46.855Z","dependency_job_id":"9b0a6641-6013-4ba2-aed3-5881bdf9485e","html_url":"https://github.com/VisualBean/HealthCheckDashboard.NET","commit_stats":null,"previous_names":["visualbean/betterhealth.net","visualbean/healthcheckdashboard.net"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VisualBean%2FHealthCheckDashboard.NET","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VisualBean%2FHealthCheckDashboard.NET/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VisualBean%2FHealthCheckDashboard.NET/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VisualBean%2FHealthCheckDashboard.NET/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VisualBean","download_url":"https://codeload.github.com/VisualBean/HealthCheckDashboard.NET/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254464875,"owners_count":22075572,"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":"2025-05-16T04:15:36.026Z","updated_at":"2025-05-16T04:15:44.382Z","avatar_url":"https://github.com/VisualBean.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HealthCheckDashboard.NET\nA health check dashboard built on top of `IHealthCheck`.  \nIt works by fetching the health status from each healthcheck through the healthservice (internal to the healthcheck library),  \nand exposing this as an endpoint.\n\n![image](https://github.com/user-attachments/assets/db688134-e2d8-495e-a208-a906ca2c7c5a)\n \n## Example\n```csharp\n\n// Add your healthchecks as usual. \nbuilder.Services.AddHealthChecks()\n    .AddCheck\u003cSimpleSuccessHealthCheck\u003e(\"Simple Success\", tags: new[] {\"Simple\", \"Success\"})\n    .AddCheck\u003cSimpleDegradedHealthCheck\u003e(\"Simple Degraded\", tags: new[] {\"Simple\", \"Degraded\"})\n    .AddCheck\u003cSimpleFailedHealthCheck\u003e(\"Simple Failed\", tags: new[] {\"Simple\", \"Failed\"})\n    .AddCheck\u003cSimpleExceptionHealthCheck\u003e(\"Simple Exception\", tags: new[] {\"Simple\", \"Exception\"});\n\nvar app = builder.Build();\napp.MapHealthChecks(\"/health\");\n\n// Use health dashboard and configure it as needed.\napp.MapHealthCheckDashboard(\"/health-dashboard\");\n\n/* Normal auth, controller etc. setup.\n...\n*/\n\napp.Run();\n```\n\nAnd that is it.\n\nThe dashboard follows mostly the same conventions that the health checks do.\n\n## Require authorization\nCall `RequireAuthorization` to run Authorization Middleware on the health dashboard endpoint. A `RequireAuthorization` overload accepts one or more authorization policies. \nIf a policy isn't provided, the default authorization policy is used:\n\n```csharp\n  app.MapHealthCheckDashboard(\"/health-dashboard\")\n      .RequireAuthorization();\n```\n## Filtering health checks\nBy default, the Health dashboard shows all registered health checks.\nTo show a subset of health checks, provide a function that returns a boolean to the `Predicate` option.\n\nThe following example filters the health checks so that only those tagged with sample run:\n```csharp\napp.MapHealthCheckDashboard(\"/health-dashboard\", new HealthDashboardOptions\n{\n    Predicate = healthCheck =\u003e healthCheck.Tags.Contains(\"sample\")\n});\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvisualbean%2Fhealthcheckdashboard.net","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvisualbean%2Fhealthcheckdashboard.net","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvisualbean%2Fhealthcheckdashboard.net/lists"}