add doc for metrics APIs

Orange-OpenSource · Jan 13, 2016 · d740957 · d740957
1 parent dac42ed
commit d740957
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/doc/admin/broker.md b/doc/admin/broker.md
@@ -125,6 +125,14 @@ You can either:
 
     java -jar cepheus-broker.jar --spring.config.location=/etc/cepheus/broker.properties
 
+### Metrics and health
+
+You can enable the Spring Boot Actuator `/infos`, `/health` and `/metrics` endpoints with these application properties:
+
+    endpoints.info.enabled=true
+    endpoints.metrics.enabled=true
+    endpoints.health.enabled=true
+
 ## User guide
 
 The complete user & programming guide can be found [here](../index.md)
diff --git a/doc/admin/cep.md b/doc/admin/cep.md
@@ -126,6 +126,17 @@ The Cepheus-CEP loads its data on startup and saves back data updates to a singl
 The default location of the data file is defined by the `data.file` property.
 This Cepheus-CEP process must have write access rights on this file.
 
+### Metrics and health
+
+You can enable the Spring Boot Actuator `/infos`, `/health` and `/metrics` endpoints with these application properties:
+
+    endpoints.info.enabled=true
+    endpoints.metrics.enabled=true
+    endpoints.health.enabled=true
+
+Metrics will include the metrics for each EPL statement with the following data:
+`cpuTime`, `wallTime`,`numInput` and `numOutputIStream`.
+
 ## User guide
 
 The complete user & programming guide can be found [here](../index.md)