https://github.com/mickleroy/aem-healthcheck-servlet

Servlet used to expose JMX health check results via HTTP
https://github.com/mickleroy/aem-healthcheck-servlet

aem healthcheck servlet sling

Last synced: 10 days ago
JSON representation

Servlet used to expose JMX health check results via HTTP

• Host: GitHub
• URL: https://github.com/mickleroy/aem-healthcheck-servlet
• Owner: mickleroy
• Created: 2016-12-20T03:53:31.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2016-12-21T04:05:56.000Z (about 8 years ago)
• Last Synced: 2024-10-31T13:17:55.824Z (about 2 months ago)
• Topics: aem, healthcheck, servlet, sling
• Language: Java
• Homepage:
• Size: 16.6 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Project now maintained at: [https://github.com/shinesolutions/aem-healthcheck](https://github.com/shinesolutions/aem-healthcheck)

# HealthCheck Servlet for AEM

[![Build Status](https://travis-ci.org/mickleroy/aem-healthcheck-servlet.svg?branch=master)](https://travis-ci.org/mickleroy/aem-healthcheck-servlet)

This servlet makes the JMX health check results accessible via HTTP.

It is used to execute Sling Health Checks based on provided tags (if no tags are provided, all registered health checks will be executed).

For the full list of provided health checks in AEM, go to [http://localhost:4502/system/console/healthcheck](http://localhost:4502/system/console/healthcheck).

Sample requests:

 * http://host:port/system/health

 * http://host:port/system/health?tags=devops

 * http://host:port/system/health?tags=devops,security

 * http://host:port/system/health?tags=devops,security&combineTagsOr=false

Sample response:

```

{

  "results": [

    {

      "name": "Smoke Health Check",

      "status": "OK",

      "timeInMs": 1

    }

  ]

}

```

A `200` status code will be returned if ALL health checks return the status OK. Otherwise a `503` is returned.

Note: It is assumed that all `/system/*` paths are only accessible from a local network and not routed to the Internet.

## Building

This project uses Maven for building. Common commands:

From the root directory, run ``mvn -PautoInstallPackage clean install`` to build the bundle and content package and install to a CQ instance.

From the bundle directory, run ``mvn -PautoInstallBundle clean install`` to build *just* the bundle and install to a CQ instance.

## Specifying CRX Host/Port

The CRX host and port can be specified on the command line with:

mvn -Dcrx.host=otherhost -Dcrx.port=5502