https://github.com/xenit-eu/alfresco-actuators

Health endpoint(s)
https://github.com/xenit-eu/alfresco-actuators

actuators alfresco alfresco-addon alfresco-module healthcheck monitoring

Last synced: 6 days ago
JSON representation

Health endpoint(s)

• Host: GitHub
• URL: https://github.com/xenit-eu/alfresco-actuators
• Owner: xenit-eu
• License: lgpl-3.0
• Created: 2021-01-25T15:49:45.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2023-12-21T12:27:23.000Z (about 1 year ago)
• Last Synced: 2024-04-16T13:05:13.592Z (9 months ago)
• Topics: actuators, alfresco, alfresco-addon, alfresco-module, healthcheck, monitoring
• Language: Java
• Size: 152 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Alfresco actuators

Health endpoint, unauthenticated, to be used as docker and load balancer health check.

The webscript is available at:

```

    alfresco/s/xenit/actuators/health

    alfresco/s/xenit/actuators/health/details

```

with both having request parameter disabled with values :

* `SystemInfoService`

* `AlfrescoInfoService`

* `ContentInfoService`

* `LicenseInfoService`

* `StatusInfoService`

example:

* `alfresco/s/xenit/actuators/health?disabled=SystemInfoService,LicenseInfoService`

* `alfresco/s/xenit/actuators/health/details?disabled=SystemInfoService`

## Usage

Status code is to be used for the health check.

The output of the health check is:

```

{"status":"UP"}

```

or

```

{"status":"DOWN" , "message":"error message"}

```

Currently the check looks at:

* system

    * os

    * java

    * cpu

* alfresco

    * id

    * version

    * edition

    * license

    * warManifest

    * modules

    * status

    * content store

# Development

## Todo

See [TODO.md](TODO.md)

## How to run integration tests

```

./gradlew integrationTest

```