Show Navigation

grails-appinfo

A Grails plugin to provide applicaiton system information for health-check and runtime inspection

Owner: ikalizpet | 1.3 | Jul 12, 2018 | Package | Issues | Source | Documentation | License: Apache-2.0


dependencies {
    compile 'org.grails.plugins:grails-appinfo:1.3'
}

            

grails-appinfo

Grails plugin to check and monitor application status with a dashboard UI

Build Status

INTRODUCTION

Grails-appinfo Grails plugin is a set of convenient utilities for application system details, health-check, configuration and monitoring at runtime.

This Grails plugin builds on top of spring boot actuator API with Grails specific enhancements on stock actuator endpoints.

To consume actuator JSON endpoints, the testing Grails application also provides a monitoring dashboard inspired by grails-actuator-ui.

The dashboard UI is built on bootstrap with CSS framework from AdminLTE.

This repository contains source code of Grails-appinfo plugin, and a testing host Grails application.

INSTALL

In host Grails application's build.gradle file:

plugins {
    compile ':grails-appinfo:$version'
}

PREREQUISITES

Hosting Grails application version 3.0+.

CONFIGURATION

In host Grails application grails-app/conf/application.yml

# Appinfo grails plugin settings
appinfo:
    health:
        urlList:   # list of webservice endpoints to check
            - url: 'http://localhost:8080'
              name: 'web root'   # name of the endpoint
              method: 'GET'      # http method, default to 'HEAD' if not given
            - url: 'http://localhost:8080/info'
              name: 'web_info'
        aws:
            s3:
                # either:
                bucket: 'bucket-name'  # bucket name used in s3 health check
                # or: (for multiple buckets)
                #buckets:
                #    - 'bucket-name'
                #    - 'another-bucket-name'
    info:
        system: true
        runtime: true
        logging: true

CHANGELOG

v0.9

  • support both multi-dataSources and single dataSource in health check
  • support mongodb in health check

CONTRIBUTORS

Bin Le ([email protected])

LICENSE

Apache License Version 2.0. (http://www.apache.org/licenses/)