docs: add keptnConfigureMonitoring example and use case

Signed-off-by: Paolo Chila <[email protected]>
keptn-sandbox · Feb 10, 2022 · 3eb7d79 · 3eb7d79
1 parent 92d68a4
commit 3eb7d79
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/FEATURES.md b/FEATURES.md
@@ -177,3 +177,10 @@ If the service already exists, skip creation of the service.
 * README contains an example of how to call this function within a Jenkinsfile
 * Finished event appears in Keptn Bridge (check for source="jenkins-library")
 
+### User Story 12: Configure monitoring for keptn project
+
+**Goal**: A user should be able to configure monitoring for a project after adding the relevant files to the Keptn configuration repo (SLIs/SLOs and monitoring config files as needed)
+
+**DoD**:
+* Shared library code contains function `keptnConfigureMonitoring` to trigger the appropriate event.
+* README contains an example of how to call this function within a Jenkinsfile for prometheus and dynatrace
diff --git a/README.md b/README.md
@@ -102,6 +102,10 @@ keptn.keptnAddResources('keptn/sli.yaml','dynatrace/sli.yaml')
 keptn.keptnAddResources('keptn/slo.yaml','slo.yaml')
 keptn.keptnAddResources('keptn/load.jmx','jmeter/load.jmx')
 
+// Configure monitoring for your keptn project (using dynatrace or prometheus)
+keptn.keptnConfigureMonitoring monitoring:"dynatrace"
+// keptn.keptnConfigureMonitoring monitoring:"prometheus"
+
 // Custom Labels
 // all keptn.send** functions have an optional parameter called labels. It is a way to pass custom labels to the sent event
 def labels=[:]