Merge pull request #1040 from fluxcd/grafana-annotations

Add involved object reference as annotations for the grafana provider

Author: matheuscscp

docs/spec/v1beta3/providers.md

@@ -1270,6 +1270,11 @@ spec:
     name: grafana-token
 ```
 
+Besides the tag `flux` and the tag containing the reporting controller (e.g. `source-controller`),
+the event metadata is also included as tags of the form `${metadataKey}: ${metadataValue}`, and
+the tags `kind: ${event.InvolvedObject.Kind}`, `name: ${event.InvolvedObject.Name}` and
+`namespace: ${event.InvolvedObject.Namespace}` are also included.
+
 ### GitHub dispatch
 
 The `githubdispatch` provider generates GitHub events of type

internal/notifier/grafana.go

@@ -36,7 +36,7 @@ type Grafana struct {
 	Password string
 }
 
-// GraphiteAnnotation represents a Grafana API annotation in Graphite format
+// GraphitePayload represents a Grafana API annotation in Graphite format
 type GraphitePayload struct {
 	When int64    `json:"when"` //optional unix timestamp (ms)
 	Text string   `json:"text"`
@@ -75,6 +75,9 @@ func (g *Grafana) Post(ctx context.Context, event eventv1.Event) error {
 		value := strings.ReplaceAll(v, ":", "|")
 		sfields = append(sfields, fmt.Sprintf("%s: %s", key, value))
 	}
+	sfields = append(sfields, fmt.Sprintf("kind: %s", event.InvolvedObject.Kind))
+	sfields = append(sfields, fmt.Sprintf("name: %s", event.InvolvedObject.Name))
+	sfields = append(sfields, fmt.Sprintf("namespace: %s", event.InvolvedObject.Namespace))
 	payload := GraphitePayload{
 		When: event.Timestamp.Unix(),
 		Text: fmt.Sprintf("%s/%s.%s", strings.ToLower(event.InvolvedObject.Kind), event.InvolvedObject.Name, event.InvolvedObject.Namespace),

internal/notifier/grafana_test.go

@@ -41,6 +41,9 @@ func TestGrafana_Post(t *testing.T) {
 			require.Equal(t, "flux", payload.Tags[0])
 			require.Equal(t, "source-controller", payload.Tags[1])
 			require.Equal(t, "test: metadata", payload.Tags[2])
+			require.Equal(t, "kind: GitRepository", payload.Tags[3])
+			require.Equal(t, "name: webapp", payload.Tags[4])
+			require.Equal(t, "namespace: gitops-system", payload.Tags[5])
 		}))
 		defer ts.Close()