Swingletree Nebula Plugin

Nebula is a collection of plugins for Gradle. The Gradle Metrics Plugin provides metrics to a webservice endpoint after each build performed by Gradle.

Features

The Swingletree Plugin offers following functionalites:

• Collects information about tests running in your Gradle build
• Collects performance metrics of your builds
• Collects general information about your build
  • Gradle version
  • Java version
  • Project version
  • Project name
  • Executed Tasks

Processed data is persisted to ElasticSearch (if enabled) and can be processed to reports using Kibana or Grafana. Information, which could contain sensitive information (like environment variables) are not processed and persisted.

Build Status decision

Swingletree blocks Pull Requests if tests are failing in the Gradle build.

Sending a metrics report to Swingletree

The Nebula webhook is published when the Nebula Plugin is enabled. It accepts a Nebula Gradle Metrics Plugin report as a payload and needs some additional http headers to link the report to a GitHub repository.

gate:
  plugins:
    - id: nebula
      base: # enter base url of plugin-nebula instance

Gate publishes an endpoint which is connected to the plugin. You will need to attach information about the target repository using the provided methods of Gate (for example HTTP Headers or query parameters):

buildscript {
  dependencies {
    classpath "com.netflix.nebula:gradle-metrics-plugin:9.0.1"
  }
}

if (thisIsCiBuild) { // needs to be specified by you
  apply plugin: "nebula.metrics"

  metrics {
      dispatcherType = 'REST'
      restUri = 'https://swingletree/reports/nebula' // can be injected by CI server using properties or env vars

      // header values need to be extracted and set
      headers['swingletree-org'] = <GitHub Organization>
      headers['swingletree-repo'] = <GitHub Repository Name>
      headers['swingletree-sha'] = <Git commit sha>
      headers['swingletree-branch'] = <Git branch>
  }
}

It is recommended to protect your Gate webhook endpoint. If you enabled Gate API authentication you will need to provide the authentication credentials via Basic Authentication. The CI server can pass the credentials using inline credentials in the restUri-property (like https://webhook:secret@swingletreeurl/webhook/nebula)

Swingletree will process the report and send a Check Run Status with the context gradle/nebula to the given GitHub coordinates.