Fix application metrics and update documentation

Author: s7nio

README.md

@@ -2,15 +2,28 @@
 
 This is a simple [spring](https://spring.io) [boot](http://projects.spring.io/spring-boot/) showcase project, which based on [https://start.spring.io](https://start.spring.io).
 
-## Docker
+## Build application
 
-Start a monitoring setup with grafana, prometheus, cadvisor and this sample application.
+
+```shell
+mvn clean package
+```
+
+## Start infrastructure
+
+Start docker monitoring setup with grafana, prometheus, cadvisor and the application.
 
 ```shell
 docker-compose up
-open http://localhost:8080
-# make some requests in the sample application
-open http://localhost:3000
-# grafana login with admin:admin
 docker-compose down
-```
+```
+
+## Smart configuration
+
+* Application: [http://localhost:8080/cat](http://localhost:8080/cat)
+    * make some requests
+* Prometheus: [http://localhost:9090](http://localhost:9090)
+* Grafana: [http://localhost:3000](http://localhost:3000)
+    * login with admin:admin
+    * setup "prometheus" data source
+    * import grafana-dashboard

grafana/grafana-dashboard.json

@@ -14,7 +14,7 @@
       "type": "grafana",
       "id": "grafana",
       "name": "Grafana",
-      "version": "4.4.2"
+      "version": "4.6.3"
     },
     {
       "type": "panel",
@@ -30,7 +30,17 @@
     }
   ],
   "annotations": {
-    "list": []
+    "list": [
+      {
+        "builtIn": 1,
+        "datasource": "-- Grafana --",
+        "enable": true,
+        "hide": true,
+        "iconColor": "rgba(0, 211, 255, 1)",
+        "name": "Annotations & Alerts",
+        "type": "dashboard"
+      }
+    ]
   },
   "description": "Docker Monitoring Template",
   "editable": true,
@@ -39,7 +49,7 @@
   "hideControls": false,
   "id": null,
   "links": [],
-  "refresh": "10s",
+  "refresh": "30s",
   "rows": [
     {
       "collapse": false,
@@ -51,7 +61,7 @@
           "dashLength": 10,
           "dashes": false,
           "datasource": "${DS_PROMETHEUS}",
-          "fill": 1,
+          "fill": 0,
           "id": 10,
           "legend": {
             "alignAsTable": true,
@@ -81,20 +91,30 @@
           "steppedLine": false,
           "targets": [
             {
-              "expr": "rate(http_response_time_milliseconds_sum{job=\"vp-opti\"}[5m])/rate(http_response_time_milliseconds_count{job=\"vp-opti\"}[5m])",
+              "expr": "delta(counter_status_200_cat[1m])",
               "format": "time_series",
-              "intervalFactor": 2,
-              "legendFormat": "{{ method }} {{ handler }} http {{ status }}",
+              "instant": false,
+              "interval": "",
+              "intervalFactor": 1,
+              "legendFormat": "/cat",
               "refId": "A",
               "step": 4
+            },
+            {
+              "expr": "idelta(counter_status_200_prometheus[1m])",
+              "format": "time_series",
+              "interval": "",
+              "intervalFactor": 2,
+              "legendFormat": "/prometheus",
+              "refId": "B"
             }
           ],
           "thresholds": [],
           "timeFrom": null,
           "timeShift": null,
-          "title": "Http handler response time",
+          "title": "Http request count",
           "tooltip": {
-            "shared": false,
+            "shared": true,
             "sort": 0,
             "value_type": "individual"
           },
@@ -104,12 +124,11 @@
             "mode": "time",
             "name": null,
             "show": true,
-            "values": [
-              "total"
-            ]
+            "values": []
           },
           "yaxes": [
             {
+              "decimals": 0,
               "format": "short",
               "label": null,
               "logBase": 1,
@@ -123,7 +142,7 @@
               "logBase": 1,
               "max": null,
               "min": null,
-              "show": true
+              "show": false
             }
           ]
         }
@@ -516,7 +535,7 @@
     "list": []
   },
   "time": {
-    "from": "now-1h",
+    "from": "now-30m",
     "to": "now"
   },
   "timepicker": {
@@ -545,6 +564,6 @@
     ]
   },
   "timezone": "browser",
-  "title": "Docker Dashboard",
-  "version": 4
+  "title": "Spring Boot Monitoring Sample Dashboard",
+  "version": 1
 }

pom.xml

@@ -16,12 +16,13 @@
 		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
 		<java.version>1.8</java.version>
         <lombok.version>1.18.0</lombok.version>
+		<prometheus.verison>0.4.0</prometheus.verison>
 	</properties>
 
 	<parent>
 		<groupId>org.springframework.boot</groupId>
 		<artifactId>spring-boot-starter-parent</artifactId>
-		<version>1.5.6.RELEASE</version>
+		<version>1.5.14.RELEASE</version>
 		<relativePath/> <!-- lookup parent from repository -->
 	</parent>
 
@@ -42,6 +43,12 @@
 			<artifactId>spring-boot-actuator-docs</artifactId>
 		</dependency>
 
+		<dependency>
+			<groupId>io.prometheus</groupId>
+			<artifactId>simpleclient_spring_boot</artifactId>
+			<version>${prometheus.verison}</version>
+		</dependency>
+
         <dependency>
             <groupId>org.projectlombok</groupId>
             <artifactId>lombok</artifactId>

prometheus/prometheus.yml

@@ -24,7 +24,7 @@ scrape_configs:
     metrics_path: '/prometheus'
 
     static_configs:
-         - targets: ['vp-opti:8080']
+         - targets: ['app:8080']
 
   - job_name: 'cadvisor'
 

src/main/java/de/codecentric/springboot/monitoring/Application.java

@@ -1,9 +1,13 @@
 package de.codecentric.springboot.monitoring;
 
+import io.prometheus.client.spring.boot.EnablePrometheusEndpoint;
+import io.prometheus.client.spring.boot.EnableSpringBootMetricsCollector;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 
 @SpringBootApplication
+@EnablePrometheusEndpoint
+@EnableSpringBootMetricsCollector
 public class Application {
 
 	public static void main(String[] args) {