Skip to content

Y26-035 - Add health endpoints to applications #700

@StephenHulme

Description

@StephenHulme

Describe the Housekeeping
Each app should have a minimal /health endpoint for basic service monitoring.
This has three main benefits:

  • It's easy to distinguish monitoring requests from user requests in logs
  • Monitoring requests response as fast as possible, to reduce overall load
  • Monitoring requests specifically don't use external resources that might be stipulated in the application controller

Blocking issues
None

Additional context
This has already been successfully implemented in Limber - sanger/limber#2331

Here is the existing list of monitored endpoints - the Nagios check_http plugin is used to perform the checks, more details of the command arguments can be found on man page. The default path to check is /.

Host name Service description Check command Health Endpoint PR
asset-audits.psd.sanger.ac.uk HTTPS Asset Audits
baracoda.psd.sanger.ac.uk HTTPS Baracoda -u /health
cgap.psd.sanger.ac.uk HTTPS CGAP LIMS -u /cgap/
gatekeeper.psd.sanger.ac.uk HTTPS Gatekeeper sanger/gatekeeper#654
kibana.psd.sanger.ac.uk HTTPS Kibana
labwhere.psd.sanger.ac.uk HTTPS LabWhere -s 'LabWhere' sanger/labwhere#1069
lighthouse.psd.sanger.ac.uk HTTPS Lighthouse Service -u /health
limber.psd.sanger.ac.uk HTTPS Limber -u /health sanger/limber#2331
mixtio.psd.sanger.ac.uk HTTPS Mixtio
monit.psd.sanger.ac.uk HTTPS Monit -u /index.csp
portainer.psd.sanger.ac.uk HTTPS Portainer
portainer.tol.psd.sanger.ac.uk HTTPS TOL Portainer -u /timeout.html#!/auth
print-my-barcode.psd.sanger.ac.uk HTTPS Print-My- Barcode -u /v1 sanger/print_my_barcode#571
quanthub.psd.sanger.ac.uk HTTPS QuantHub
rabbitmq.tol.psd.sanger.ac.uk HTTPS Tol RabbitMQ
redpanda.psd.sanger.ac.uk HTTPS Redpanda Service -u /subjects
redpanda.psd.sanger.ac.uk HTTPS Redpanda UI -u /console
sequencescape.psd.sanger.ac.uk HTTPS SequenceScape FCE -u /login -s 'Username' sanger/sequencescape#5550
sm-workflow.psd.sanger.ac.uk HTTPS SM-Workflow MiniLIMS
sprint.psd.sanger.ac.uk HTTPS SPrint
sss0-prod.psd.sanger.ac.uk HTTPS Seqscape SSS0-RMQ -u /#
sss1-prod.psd.sanger.ac.uk HTTPS Seqscape SSS1-RMQ -u /#
ssw0-prod.psd.sanger.ac.uk HTTPS Seqscape-Worker SSW0-RMQ -u /#
stan.psd.sanger.ac.uk HTTPS Stan-Spatial Genomics
storelight.psd.sanger.ac.uk HTTPS Storelight -u /graphiql/
traction.psd.sanger.ac.uk HTTPS Traction RabbitMQ
traction.psd.sanger.ac.uk HTTPS Traction Service -u /v1/printers sanger/traction-service#1795
traction.psd.sanger.ac.uk HTTPS Traction UI
uat.limber.psd.sanger.ac.uk HTTPS UAT Limber -u /health
ware-prod.psd.sanger.ac.uk HTTPS Warehouse RMQ

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions