add port info for metrics

wjayesh · Aug 5, 2020 · 22811b6 · 22811b6
1 parent 488cf2d
commit 22811b6
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -83,6 +83,7 @@ Name | Description
 remedy | This group has metrics related to the remedial measures taken when the pods fail, such as restarting pods or increasing memory allocation.
 dns | This group has metrics that deal with dns queries made by the application and their response. 
 
+&nbsp;
 
 Remedy group has the following available metrics:
 
@@ -100,6 +101,15 @@ Name | Metric Type | Exposed Information
 `dns_query_count` | Counter | Counts the number of DNS queries made
 `dns_query_response_time` | Histogram | The time it takes to finish dns queries
 
+### Port
+
+The metrics are exposed on the port `9890` of the pod's IP address. The endpoint is `/metrics`. 
+
+A sample call could be done in the following manner:
+```bash
+curl 10.244.0.13:9890/metrics 
+```
+
 ### Visuals
 
 A sample run with an orchestrated OOM error: