Skip to content

DRYD-1193: Sysinfo endpoint healthcheck#529

Open
mglyrasis wants to merge 2 commits intodevelopfrom
feat/health-check-endpoint
Open

DRYD-1193: Sysinfo endpoint healthcheck#529
mglyrasis wants to merge 2 commits intodevelopfrom
feat/health-check-endpoint

Conversation

@mglyrasis
Copy link
Copy Markdown

What does this do?
Adds a health check endpoint at /health that returns JSON describing the health status. Makes a very basic attempt at determining which data sources matter and degrades to a warning state if non-required components fail.

{
  "checks":{
    "database:cspace":{
      "componentType":"datastore",
      "status":"pass",
      "observedValue":"PostgreSQL 17.5 (Debian 17.5-1.pgdg120+1)"
    },
    "database:csadmin":{
      "componentType":"datastore",
      "status":"pass",
      "observedValue":"PostgreSQL 17.5 (Debian 17.5-1.pgdg120+1)"
    },
    "database:nuxeo:default":{
      "componentType":"datastore",
      "status":"pass",
      "observedValue":"PostgreSQL 17.5 (Debian 17.5-1.pgdg120+1)"
    },
    "nuxeo:repository":{
      "componentType":"component",
      "status":"pass",
      "observedValue":"default"
    },
    "database:nuxeo_reader:default":{
      "componentType":"datastore",
      "status":"pass",
      "observedValue":"PostgreSQL 17.5 (Debian 17.5-1.pgdg120+1)"
    },
    "database:csadmin_nuxeo:default":{
      "componentType":"datastore",
      "status":"pass",
      "observedValue":"PostgreSQL 17.5 (Debian 17.5-1.pgdg120+1)"
    },
    "elasticsearch":{
      "status":"disabled"
    }
  },
  "description":"CollectionSpace Services",
  "version":"8.3.0-RC.2",
  "releaseId":"99cd743",
  "serviceId":"_collectionspace",
  "status":"pass"
}

Why are we doing this? (with JIRA link)
https://collectionspace.atlassian.net/browse/DRYD-1193

Because hosting needs a way to determine if there's a failure communicating with the database or ElasticSearch.

How should this be tested? Do these changes have associated tests?
Bundled integration tests.

Dependencies for merging? Releasing to production?
No additional dependencies.

Has the application documentation been updated for these changes?
No.

Did someone actually run this code to verify it works?
Yes.

spirosdi and others added 2 commits April 24, 2026 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants