Put back some metrics to monitor what happens on graph updates.

Author: clems4ever

internal/handlers/handler_update_graph.go

@@ -1,46 +1,69 @@
 package handlers
 
 import (
-	"bytes"
 	"encoding/json"
 	"fmt"
 	"io"
 	"net/http"
 
 	"github.com/clems4ever/go-graphkb/internal/client"
 	"github.com/clems4ever/go-graphkb/internal/knowledge"
+	"github.com/clems4ever/go-graphkb/internal/metrics"
 	"github.com/clems4ever/go-graphkb/internal/sources"
+	"github.com/prometheus/client_golang/prometheus"
 	"golang.org/x/sync/semaphore"
 )
 
-func handleUpdate(registry sources.Registry, fn func(source string, body io.Reader) error, sem *semaphore.Weighted) http.HandlerFunc {
+func handleUpdate(registry sources.Registry, fn func(source string, body io.Reader) error, sem *semaphore.Weighted, operationDescriptor string) http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
 		ok, source, err := IsTokenValid(registry, r)
 		if err != nil {
 			ReplyWithInternalError(w, err)
 			return
 		}
 
+		promLabels := prometheus.Labels{
+			"source":    source,
+			"operation": operationDescriptor,
+		}
+
 		if !ok {
+			metrics.GraphUpdateRequestsUnauthorizedCounter.
+				With(promLabels).
+				Inc()
 			ReplyWithUnauthorized(w)
 			return
 		}
 
 		{
 			ok = sem.TryAcquire(1)
 			if !ok {
+				metrics.GraphUpdateRequestsRateLimitedCounter.
+					With(promLabels).
+					Inc()
 				ReplyWithTooManyRequests(w)
 				return
 			}
 			defer sem.Release(1)
 
+			metrics.GraphUpdateRequestsReceivedCounter.
+				With(promLabels).
+				Inc()
+
 			if err = fn(source, r.Body); err != nil {
+				metrics.GraphUpdateRequestsFailedCounter.
+					With(promLabels).
+					Inc()
 				ReplyWithInternalError(w, err)
 				return
 			}
+
+			metrics.GraphUpdateRequestsSucceededCounter.
+				With(promLabels).
+				Inc()
 		}
 
-		_, err = bytes.NewBufferString("Graph has been received and will be processed soon").WriteTo(w)
+		_, err = fmt.Fprint(w, "Graph update has been processed")
 		if err != nil {
 			ReplyWithInternalError(w, err)
 			return
@@ -57,9 +80,17 @@ func PutSchema(registry sources.Registry, graphUpdater *knowledge.GraphUpdater,
 		}
 
 		// TODO(c.michaud): verify compatibility of the schema with graph updates
-		graphUpdater.UpdateSchema(source, requestBody.Schema)
+		err := graphUpdater.UpdateSchema(source, requestBody.Schema)
+		if err != nil {
+			return fmt.Errorf("Unable to update the schema: %v", err)
+		}
+
+		labels := prometheus.Labels{"source": source}
+		metrics.GraphUpdateSchemaUpdatedCounter.
+			With(labels).
+			Inc()
 		return nil
-	}, sem)
+	}, sem, "update_schema")
 }
 
 // PutAssets upsert several assets into the graph of the data source
@@ -75,8 +106,13 @@ func PutAssets(registry sources.Registry, graphUpdater *knowledge.GraphUpdater,
 		if err != nil {
 			return fmt.Errorf("Unable to insert assets: %v", err)
 		}
+		labels := prometheus.Labels{"source": source}
+		metrics.GraphUpdateAssetsInsertedCounter.
+			With(labels).
+			Add(float64(len(requestBody.Assets)))
+
 		return nil
-	}, sem)
+	}, sem, "insert_assets")
 }
 
 // PutRelations upsert multiple relations into the graph of the data source
@@ -92,8 +128,13 @@ func PutRelations(registry sources.Registry, graphUpdater *knowledge.GraphUpdate
 		if err != nil {
 			return fmt.Errorf("Unable to insert relation: %v", err)
 		}
+
+		labels := prometheus.Labels{"source": source}
+		metrics.GraphUpdateRelationsInsertedCounter.
+			With(labels).
+			Add(float64(len(requestBody.Relations)))
 		return nil
-	}, sem)
+	}, sem, "insert_relations")
 }
 
 // DeleteAssets delete multiple assets from the graph of the data source
@@ -109,8 +150,13 @@ func DeleteAssets(registry sources.Registry, graphUpdater *knowledge.GraphUpdate
 		if err != nil {
 			return fmt.Errorf("Unable to remove assets: %v", err)
 		}
+
+		labels := prometheus.Labels{"source": source}
+		metrics.GraphUpdateAssetsDeletedCounter.
+			With(labels).
+			Add(float64(len(requestBody.Assets)))
 		return nil
-	}, sem)
+	}, sem, "delete_assets")
 }
 
 // DeleteRelations remove multiple relations from the graph of the data source
@@ -126,6 +172,11 @@ func DeleteRelations(registry sources.Registry, graphUpdater *knowledge.GraphUpd
 		if err != nil {
 			return fmt.Errorf("Unable to remove relation: %v", err)
 		}
+
+		labels := prometheus.Labels{"source": source}
+		metrics.GraphUpdateRelationsDeletedCounter.
+			With(labels).
+			Add(float64(len(requestBody.Relations)))
 		return nil
-	}, sem)
+	}, sem, "delete_relations")
 }

internal/metrics/metrics.go

@@ -11,42 +11,66 @@ var StartTimeGauge = promauto.NewGauge(prometheus.GaugeOpts{
 	Help: "The timestamp of the time when the app started",
 })
 
-// ********************* GRAPH UPDATE ENQUEUING ******************
+// ********************* GRAPH UPDATE REQUESTS ******************
 
-// GraphUpdateEnqueuingRequestsReceivedCounter reports the number of authorized updates request received by the webserver
-var GraphUpdateEnqueuingRequestsReceivedCounter = promauto.NewCounterVec(prometheus.CounterOpts{
-	Name: "go_graphkb_graph_update_enqueuing_requests_received_counter",
-	Help: "The number of graph update enqueuing requests received by the web server but not yet processed",
-}, []string{"source"})
+// GraphUpdateRequestsReceivedCounter reports the number of authorized and not rate limited updates requests received by the webserver
+var GraphUpdateRequestsReceivedCounter = promauto.NewCounterVec(prometheus.CounterOpts{
+	Name: "go_graphkb_graph_update_requests_received_counter",
+	Help: "The number of graph updates (insertion or removal of assets or relations) received. A request is considered received if authorization is valid and the request has not been rate limited",
+}, []string{"source", "operation"})
+
+// GraphUpdateRequestsRateLimitedCounter reports the number of unauthorized updates requests received by the webserver
+var GraphUpdateRequestsRateLimitedCounter = promauto.NewCounterVec(prometheus.CounterOpts{
+	Name: "go_graphkb_graph_update_requests_rate_limited_counter",
+	Help: "The number of graph updates which were rate limited",
+}, []string{"source", "operation"})
+
+// GraphUpdateRequestsUnauthorizedCounter reports the number of unauthorized updates requests received by the webserver
+var GraphUpdateRequestsUnauthorizedCounter = promauto.NewCounterVec(prometheus.CounterOpts{
+	Name: "go_graphkb_graph_update_requests_unauthorized_counter",
+	Help: "The number of graph updates which were unauthorized",
+}, []string{"source", "operation"})
 
-// GraphUpdateEnqueuingRequestsFailedCounter reports the number of failed update requests
-var GraphUpdateEnqueuingRequestsFailedCounter = promauto.NewCounterVec(prometheus.CounterOpts{
-	Name: "go_graphkb_graph_update_enqueuing_requests_failed_counter",
-	Help: "The number of failed graph update enqueuing requests",
-}, []string{"source", "status_code"})
+// GraphUpdateRequestsFailedCounter reports the number of failed update requests
+var GraphUpdateRequestsFailedCounter = promauto.NewCounterVec(prometheus.CounterOpts{
+	Name: "go_graphkb_graph_update_requests_failed_counter",
+	Help: "The number of failed graph update",
+}, []string{"source", "operation"})
 
-// GraphUpdateEnqueuingRequestsSucceededCounter reports the number of successful enqueuing requests
-var GraphUpdateEnqueuingRequestsSucceededCounter = promauto.NewCounterVec(prometheus.CounterOpts{
-	Name: "go_graphkb_graph_update_enqueuing_requests_succeeded_counter",
-	Help: "The number of successful graph update enqueuing requests",
+// GraphUpdateRequestsSucceededCounter reports the number of successful update requests
+var GraphUpdateRequestsSucceededCounter = promauto.NewCounterVec(prometheus.CounterOpts{
+	Name: "go_graphkb_graph_update_requests_succeeded_counter",
+	Help: "The number of succeeded graph update",
+}, []string{"source", "operation"})
+
+// ********************* GRAPH UPDATE COUNTERS ******************
+
+// GraphUpdateSchemaUpdatedCounter reports the number of schema updated since the start of the process
+var GraphUpdateSchemaUpdatedCounter = promauto.NewCounterVec(prometheus.CounterOpts{
+	Name: "go_graphkb_graph_update_schema_updated_counter",
+	Help: "The number of assets inserted since the start of the process",
 }, []string{"source"})
 
-// ********************* GRAPH PROCESSING *************************
+// GraphUpdateAssetsInsertedCounter reports the number of assets inserted since the start of the process
+var GraphUpdateAssetsInsertedCounter = promauto.NewCounterVec(prometheus.CounterOpts{
+	Name: "go_graphkb_graph_update_assets_inserted_counter",
+	Help: "The number of assets inserted since the start of the process",
+}, []string{"source"})
 
-// GraphUpdatesProcessingRequestedCounter reports the number of updates to be processed and imported into DB.
-var GraphUpdatesProcessingRequestedCounter = promauto.NewCounterVec(prometheus.CounterOpts{
-	Name: "go_graphkb_graph_updates_processing_requested_counter",
-	Help: "The number of update requests to be processed and imported into DB",
+// GraphUpdateRelationsInsertedCounter reports the number of relations inserted since the start of the process
+var GraphUpdateRelationsInsertedCounter = promauto.NewCounterVec(prometheus.CounterOpts{
+	Name: "go_graphkb_graph_update_relations_inserted_counter",
+	Help: "The number of relations inserted since the start of the process",
 }, []string{"source"})
 
-// GraphUpdatesProcessingSucceededCounter reports the number of updates which have successfully been processed
-var GraphUpdatesProcessingSucceededCounter = promauto.NewCounterVec(prometheus.CounterOpts{
-	Name: "go_graphkb_graph_updates_processing_succeeded_counter",
-	Help: "The number of update requests processed successfully",
+// GraphUpdateAssetsDeletedCounter reports the number of assets inserted since the start of the process
+var GraphUpdateAssetsDeletedCounter = promauto.NewCounterVec(prometheus.CounterOpts{
+	Name: "go_graphkb_graph_update_assets_deleted_counter",
+	Help: "The number of assets deleted since the start of the process",
 }, []string{"source"})
 
-// GraphUpdatesProcessingFailedCounter reports the number of updates which failed to be processed
-var GraphUpdatesProcessingFailedCounter = promauto.NewCounterVec(prometheus.CounterOpts{
-	Name: "go_graphkb_graph_updates_failed_counter",
-	Help: "The number of update requests which failed",
+// GraphUpdateRelationsDeletedCounter reports the number of relations deleted since the start of the process
+var GraphUpdateRelationsDeletedCounter = promauto.NewCounterVec(prometheus.CounterOpts{
+	Name: "go_graphkb_graph_update_relations_deleted_counter",
+	Help: "The number of relations deleted since the start of the process",
 }, []string{"source"})