https://github.com/jmnarloch/gocd-health-check-plugin

GO Continuous Delivery Health Check plugin
https://github.com/jmnarloch/gocd-health-check-plugin

Last synced: 4 days ago
JSON representation

GO Continuous Delivery Health Check plugin

• Host: GitHub
• URL: https://github.com/jmnarloch/gocd-health-check-plugin
• Owner: jmnarloch
• License: apache-2.0
• Created: 2015-09-24T15:35:34.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-04-24T17:34:12.000Z (over 8 years ago)
• Last Synced: 2023-07-04T14:06:58.142Z (over 1 year ago)
• Language: Java
• Size: 428 KB
• Stars: 7
• Watchers: 5
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Go Continuous Delivery Health Check plugin

> Go Continuous Delivery task for awaiting until your application is healthy

[![Build Status](https://travis-ci.org/jmnarloch/gocd-health-check-plugin.svg)](https://travis-ci.org/jmnarloch/gocd-health-check-plugin)

[![Coverage Status](https://coveralls.io/repos/jmnarloch/gocd-health-check-plugin/badge.svg?branch=master&service=github)](https://coveralls.io/github/jmnarloch/gocd-health-check-plugin?branch=master)

## Installation

Download the plugin and copy it into `$GO_SERVER_HOME/plugins/external` and restart the Go server.

The plugin should appear on Plugins page.

## Usage

Add Health Check task to your build stage. The task with delay the execution of your pipeline according 

to the configured setting in the same time performing fixed delay HTTP request to the provided health url.

The application health information is expected to be returned in a form of JSON with configurable expected status.

![Health Check task](screen.png)

## Options

### Url

The url to the application health information. (required)

Example: http://localhost:8080/health

### Attribute

The name of attribute indicating the application status. (required)

Example: status

Will match fallowing response:

```json

{"status": "UP"}

```

You can use dot-object notation to navigate over response JSON.

Example: health.status

```json

{

    "health": {

        "status": "green"

     }

}

```

### Expected status

The expected application health status. (required)

Example: UP

### Delay

Time in seconds after a retry check will be performed after unsuccessful request. (required)

Example: 15

### Timeout

Maximum number of seconds to wait for the application to become healthy. (required)

Example: 60

## License

Apache 2.0