Go Continous Delivery Health check plugin


License

License

GroupId

GroupId

io.jmnarloch
ArtifactId

ArtifactId

gocd-health-check-plugin
Last Version

Last Version

1.0.2
Release Date

Release Date

Type

Type

jar
Description

Description

Go Continous Delivery Health check plugin
Go Continous Delivery Health check plugin
Project URL

Project URL

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

Source Code Management

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

Download gocd-health-check-plugin

How to add to project

<!-- https://jarcasting.com/artifacts/io.jmnarloch/gocd-health-check-plugin/ -->
<dependency>
    <groupId>io.jmnarloch</groupId>
    <artifactId>gocd-health-check-plugin</artifactId>
    <version>1.0.2</version>
</dependency>
// https://jarcasting.com/artifacts/io.jmnarloch/gocd-health-check-plugin/
implementation 'io.jmnarloch:gocd-health-check-plugin:1.0.2'
// https://jarcasting.com/artifacts/io.jmnarloch/gocd-health-check-plugin/
implementation ("io.jmnarloch:gocd-health-check-plugin:1.0.2")
'io.jmnarloch:gocd-health-check-plugin:jar:1.0.2'
<dependency org="io.jmnarloch" name="gocd-health-check-plugin" rev="1.0.2">
  <artifact name="gocd-health-check-plugin" type="jar" />
</dependency>
@Grapes(
@Grab(group='io.jmnarloch', module='gocd-health-check-plugin', version='1.0.2')
)
libraryDependencies += "io.jmnarloch" % "gocd-health-check-plugin" % "1.0.2"
[io.jmnarloch/gocd-health-check-plugin "1.0.2"]

Dependencies

compile (6)

Group / Artifact Type Version
io.jmnarloch : gocd-task-plugin-api jar 1.0.0
commons-io : commons-io jar 2.4
com.google.code.gson : gson jar 2.3.1
io.reactivex : rxnetty jar 0.4.11
org.apache.commons : commons-lang3 jar 3.4
io.reactivex : rxjava jar 1.0.14

test (2)

Group / Artifact Type Version
org.mockito : mockito-all jar 1.10.19
junit : junit jar 4.12

Project Modules

There are no modules declared in this project.

Go Continuous Delivery Health Check plugin

Go Continuous Delivery task for awaiting until your application is healthy

Build Status Coverage Status

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

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:

{"status": "UP"}

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

Example: health.status

{
    "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

Versions

Version
1.0.2
1.0.1
1.0.0