Collects Gradle build metrics and log events and and persists them to an external datastore.
To include, add the following to your build.gradle:
If newer than Gradle 2.1 you may use
plugins {
id 'nebula.metrics' version '4.0.1'
}
or
buildscript {
repositories { jcenter() }
dependencies {
classpath 'com.netflix.nebula:gradle-metrics-plugin:4.0.1'
}
}
apply plugin: 'nebula.metrics'
The metrics plugin can persist data into Elasticsearch or a generic REST endpoint. By default, the plugin will attempt to persist onto a local Elasticsearch instance on port 9200 with the templates under templates/ applied.
{
"project": {
"name": "test-metrics",
"version": "1.0"
},
"events": [
{
"description": "startup",
"type": "init",
"elapsedTime": 954
},
{
"description": "settings",
"type": "configure",
"elapsedTime": 151
},
{
"description": "projectsLoading",
"type": "configure",
"elapsedTime": 196
},
{
"description": ":",
"type": "configure",
"elapsedTime": 1163
},
{
"description": ":classpath",
"type": "resolve",
"elapsedTime": 359
},
{
"description": "task",
"type": "execution",
"elapsedTime": 59
}
],
"tasks": [
{
"description": ":projects",
"result": {
"status": "success"
},
"startTime": "2015-11-04T18:32:04.917Z",
"elapsedTime": 59
}
],
"tests": [],
"info": {
"build": {
"gradle": {
"version": "2.8",
"parameters": {
"taskRequests": [
{
"args": [
"projects"
]
}
],
"excludedTaskNames": [],
"buildProjectDependencies": true,
"currentDir": "/Users/user/dev/tests/test-metrics-plugin",
"searchUpwards": true,
"projectProperties": [],
"gradleUserHomeDir": "/Users/user/.gradle",
"useEmptySettings": false,
"initScripts": [],
"dryRun": false,
"rerunTasks": false,
"profile": false,
"continueOnFailure": false,
"offline": false,
"refreshDependencies": false,
"recompileScripts": false,
"parallelThreadCount": 0,
"configureOnDemand": false
}
},
"type": "gradle"
},
"scm": {
"type": "unknown"
},
"ci": {
"type": "unknown"
},
"environmentVariables": [ ],
"systemProperties": [ ],
"javaVersion": "unknown"
},
"result": {
"status": "success"
},
"startTime": "2015-11-04T18:32:02.086Z",
"elapsedTime": 3852,
"testCount": 0,
"eventsCount": 6,
"eventsElapsedTime": 2882,
"tasksElapsedTime": 59,
"testElapsedTime": 0,
"finishedTime": "2015-11-04T18:32:05.938Z",
"taskCount": 1
}If configured to use Elasticsearch, the plugin uses the default indices build-metrics-default and logstash-build-metrics-default-yyyyMM for build and log events respectively. The log index rotates on a monthly basis.
For the REST configuration, both types of data are POSTed to the same endpoint, but the payload varies based on the type:
build data:
{
"eventName" : "build_metrics",
"payload" : {
"buildId": "generated build id",
"build": "escaped build json"
}
}logs:
[
{
"eventName": "build_logs",
"payload": {
"buildId": "generated build id",
"log": "log data"
}
},
{
"eventName": "build_logs",
"payload": {
"buildId": "generated build id",
"log": "log data 2"
}
}
]Configuration should be done via the metrics Gradle extension.
metrics {
hostname = 'myescluster' // default is 'localhost'
httpPort = 59300 // default is 9200
indexName = 'myindexname' // default is 'build-metrics-default'
dispatcherType = 'ES_HTTP' // default is the Elasticsearch HTTP client. ES_CLIENT is also available.
}
metrics {
restUri = 'https://server.com/rest/endpoint' // default is 'http://localhost/metrics'
restBuildEventName = 'my_build_events' // default is 'build_metrics'
restLogEventName = 'my_log_events' // default is 'build_logs'
dispatcherType = 'REST'
}
Metrics include:
- Info - Gradle start parameters, system properties and environment variables. SCM and GIT information if the gradle-info-plugin has been applied
- Project - name and version
- Events - configuration, dependency resolution, task execution
- Task executions - result, elapsed time per task
- Tests - result, elapsed time per test
- Result - success, failure with throwable, elapsed time
GET /build-metrics/build/_search?search_type=count
{
"aggs" : {
"build_results" : {
"terms" : { "field" : "result.status" }
}
}
}
GET /build-metrics/build/_search?search_type=count
{
"filter": {
"term": { "result.status": "failure" }
}
}
GET /build-metrics/build/_search?search_type=count
{
"filter": {
"term": { "result.status": "unknown" }
}
}
GET /build-metrics/build/_search?search_type=count
{
"filter": {
"nested": {
"path": "tasks",
"filter": {
"term": { "tasks.result.status": "failure" }
}
}
}
}
GET /build-metrics/build/_search?search_type=count
{
"filter": {
"nested": {
"path": "tests",
"filter": {
"term": { "tests.result.status": "failure" }
}
}
}
}
GET build-metrics/build/_search?search_type=count
{
"aggs" : {
"elapsedByType" : {
"nested" : {
"path" : "events"
},
"aggs" : {
"eventsByType" : {
"terms": { "field": "events.type" },
"aggs": {
"elapsedTime": {
"avg" : { "field" : "events.elapsedTime" }
}
}
}
}
}
}
}
GET build-metrics/build/_search?search_type=count
{
"aggs" : {
"elapsedByType" : {
"nested" : {
"path" : "events"
},
"aggs" : {
"eventsByType" : {
"filter": {
"term": { "events.type": "<TYPE>" }
},
"aggs": {
"elapsedTime": {
"sum" : { "field" : "events.elapsedTime" }
}
}
}
}
}
}
}
Where <TYPE> is one of init, configure, resolve, execution or the exceptional case, unknown.
Copyright 2015 Netflix, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.