Skip to content

Problem: Archivematica doesn't have a dedicated health check endpoint #1794

@liam-lloyd

Description

@liam-lloyd

Please describe the problem you'd like to be solved
Currently Archivematica has no health check endpoint. My team would like to set up alerting so we can quickly be informed if our Archivematica instance goes down, but right now there's not an endpoint we can hit that accurately reflects the health of the system.

Describe the solution you'd like to see implemented
For my use case, I'd like to have /health endpoint as part of the dashboard API that reports a healthy state if the dashboard, storage service, MCP server, MCP client(s), and MySQL database are all running and can talk to each other as needed.

Describe alternatives you've considered
Simply hitting the dashboard's administration/accounts/login/ path works for checking that the dashboard is up, but doesn't give any information about other parts of the system. Any endpoints that do use other parts of the system require authentication, which is inconvenient for a health check.

Additional context


For Artefactual use:

Before you close this issue, you must check off the following:

  • All pull requests related to this issue are properly linked
  • All pull requests related to this issue have been merged
  • A testing plan for this issue has been implemented and passed (testing plan information should be included in the issue body or comments)
  • Documentation regarding this issue has been written and merged
  • Details about this issue have been added to the release notes

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions