Browse Source

update prometheus doc (#509)

erenJag 4 years ago
parent
commit
339cb6cce7

+ 8 - 0
docs/v1.X/docs/observability/prometheus.md

@@ -70,6 +70,14 @@ cs_node_hits_ko_total{name="crowdsecurity/http-logs",source="/var/log/nginx/erro
 
  - `cs_reader_hits_total` : how many events were read from a specific source
 
+#### Local API
+
+ - `cs_lapi_route_requests_total` : number of calls to each route per method
+ - `cs_lapi_machine_requests_total` : number of calls to each route per method grouped by machines
+ - `cs_lapi_bouncer_requests_total` : number of of calls to each route per method grouped by bouncers
+ - `cs_lapi_decisions_ko_total` : number of unsuccessfully responses when bouncers ask for an IP.
+ - `cs_lapi_decisions_ok_total` : number of successfully responses when bouncers ask for an IP.
+
 #### Info
 
  - `cs_info` : Information about {{v1X.crowdsec.name}} (software version)

+ 3 - 3
pkg/apiserver/controllers/v1/metrics.go

@@ -10,7 +10,7 @@ import (
 var LapiRouteHits = prometheus.NewCounterVec(
 	prometheus.CounterOpts{
 		Name: "cs_lapi_route_requests_total",
-		Help: "Number of calls to each route.",
+		Help: "Number of calls to each route per method.",
 	},
 	[]string{"route", "method"},
 )
@@ -19,7 +19,7 @@ var LapiRouteHits = prometheus.NewCounterVec(
 var LapiMachineHits = prometheus.NewCounterVec(
 	prometheus.CounterOpts{
 		Name: "cs_lapi_machine_requests_total",
-		Help: "Number of calls for each machine.",
+		Help: "Number of calls to each route per method grouped by machines.",
 	},
 	[]string{"machine", "route", "method"},
 )
@@ -28,7 +28,7 @@ var LapiMachineHits = prometheus.NewCounterVec(
 var LapiBouncerHits = prometheus.NewCounterVec(
 	prometheus.CounterOpts{
 		Name: "cs_lapi_bouncer_requests_total",
-		Help: "Number of calls for each bouncer.",
+		Help: "Number of calls to each route per method grouped by bouncers.",
 	},
 	[]string{"bouncer", "route", "method"},
 )