feat: get alerting schemas from foundation-sdk (#210)

* feat: get alerting schemas from foundation-sdk This also updates the generator code: - pin to a specific version of the foundation-sdk (in `generator/jsonnetfile.lock.json`) - use `jrsonnet` consistently (increase performance of generation process) * chore: run make -B generate * chore: remove unused patch
grafana · Jun 4, 2024 · 119d653 · 119d653
1 parent 144f6cb
commit 119d653
Show file tree

Hide file tree

Showing 40 changed files with 399 additions and 1,549 deletions.
diff --git a/docs/API/alerting/contactPoint.md b/docs/API/alerting/contactPoint.md
@@ -28,7 +28,8 @@ PARAMETERS:
 * **value** (`boolean`)
    - default value: `true`
 
-
+EmbeddedContactPoint is the contact point type that is used
+by grafanas embedded alertmanager implementation.
 ### fn withName
 
 ```jsonnet
@@ -39,8 +40,8 @@ PARAMETERS:
 
 * **value** (`string`)
 
-Name is used as grouping key in the UI. Contact points with the
-same name will be grouped in the UI.
+EmbeddedContactPoint is the contact point type that is used
+by grafanas embedded alertmanager implementation.
 ### fn withProvenance
 
 ```jsonnet
@@ -51,7 +52,8 @@ PARAMETERS:
 
 * **value** (`string`)
 
-
+EmbeddedContactPoint is the contact point type that is used
+by grafanas embedded alertmanager implementation.
 ### fn withSettings
 
 ```jsonnet
@@ -85,7 +87,8 @@ PARAMETERS:
 * **value** (`string`)
    - valid values: `"alertmanager"`, `" dingding"`, `" discord"`, `" email"`, `" googlechat"`, `" kafka"`, `" line"`, `" opsgenie"`, `" pagerduty"`, `" pushover"`, `" sensugo"`, `" slack"`, `" teams"`, `" telegram"`, `" threema"`, `" victorops"`, `" webhook"`, `" wecom"`
 
-
+EmbeddedContactPoint is the contact point type that is used
+by grafanas embedded alertmanager implementation.
 ### fn withUid
 
 ```jsonnet
@@ -96,5 +99,5 @@ PARAMETERS:
 
 * **value** (`string`)
 
-UID is the unique identifier of the contact point. The UID can be
-set by the user.
+EmbeddedContactPoint is the contact point type that is used
+by grafanas embedded alertmanager implementation.
diff --git a/docs/API/alerting/index.md b/docs/API/alerting/index.md
@@ -5,7 +5,7 @@ grafonnet.alerting
 ## Subpackages
 
 * [contactPoint](contactPoint.md)
-* [messageTemplate](messageTemplate.md)
 * [muteTiming](muteTiming/index.md)
 * [notificationPolicy](notificationPolicy/index.md)
+* [notificationTemplate](notificationTemplate.md)
 * [ruleGroup](ruleGroup/index.md)
diff --git a/docs/API/alerting/notificationPolicy/index.md b/docs/API/alerting/notificationPolicy/index.md
@@ -34,7 +34,8 @@ PARAMETERS:
 
 * **value** (`string`)
 
-
+A Route is a node that contains definitions of how to handle alerts. This is modified
+from the upstream alertmanager in that it adds the ObjectMatchers property.
 ### fn withContinue
 
 ```jsonnet
@@ -46,7 +47,8 @@ PARAMETERS:
 * **value** (`boolean`)
    - default value: `true`
 
-
+A Route is a node that contains definitions of how to handle alerts. This is modified
+from the upstream alertmanager in that it adds the ObjectMatchers property.
 ### fn withGroupBy
 
 ```jsonnet
@@ -57,7 +59,8 @@ PARAMETERS:
 
 * **value** (`array`)
 
-
+A Route is a node that contains definitions of how to handle alerts. This is modified
+from the upstream alertmanager in that it adds the ObjectMatchers property.
 ### fn withGroupByMixin
 
 ```jsonnet
@@ -68,7 +71,8 @@ PARAMETERS:
 
 * **value** (`array`)
 
-
+A Route is a node that contains definitions of how to handle alerts. This is modified
+from the upstream alertmanager in that it adds the ObjectMatchers property.
 ### fn withGroupInterval
 
 ```jsonnet
@@ -79,7 +83,8 @@ PARAMETERS:
 
 * **value** (`string`)
 
-
+A Route is a node that contains definitions of how to handle alerts. This is modified
+from the upstream alertmanager in that it adds the ObjectMatchers property.
 ### fn withGroupWait
 
 ```jsonnet
@@ -90,7 +95,8 @@ PARAMETERS:
 
 * **value** (`string`)
 
-
+A Route is a node that contains definitions of how to handle alerts. This is modified
+from the upstream alertmanager in that it adds the ObjectMatchers property.
 ### fn withMatchers
 
 ```jsonnet
@@ -127,7 +133,8 @@ PARAMETERS:
 
 * **value** (`array`)
 
-
+A Route is a node that contains definitions of how to handle alerts. This is modified
+from the upstream alertmanager in that it adds the ObjectMatchers property.
 ### fn withMuteTimeIntervalsMixin
 
 ```jsonnet
@@ -138,7 +145,8 @@ PARAMETERS:
 
 * **value** (`array`)
 
-
+A Route is a node that contains definitions of how to handle alerts. This is modified
+from the upstream alertmanager in that it adds the ObjectMatchers property.
 ### fn withPolicy
 
 ```jsonnet
@@ -149,7 +157,8 @@ PARAMETERS:
 
 * **value** (`array`)
 
-
+A Route is a node that contains definitions of how to handle alerts. This is modified
+from the upstream alertmanager in that it adds the ObjectMatchers property.
 ### fn withPolicyMixin
 
 ```jsonnet
@@ -160,7 +169,8 @@ PARAMETERS:
 
 * **value** (`array`)
 
-
+A Route is a node that contains definitions of how to handle alerts. This is modified
+from the upstream alertmanager in that it adds the ObjectMatchers property.
 ### fn withRepeatInterval
 
 ```jsonnet
@@ -171,3 +181,5 @@ PARAMETERS:
 
 * **value** (`string`)
 
+A Route is a node that contains definitions of how to handle alerts. This is modified
+from the upstream alertmanager in that it adds the ObjectMatchers property.
diff --git a/docs/API/alerting/notificationPolicy/matcher.md b/docs/API/alerting/notificationPolicy/matcher.md
@@ -32,7 +32,7 @@ PARAMETERS:
 * **value** (`string`)
    - valid values: `"="`, `"!="`, `"=~"`, `"!~"`
 
-MatchType is an enum for label matching types.
+
 ### fn withValue
 
 ```jsonnet

diff --git a/docs/API/alerting/messageTemplate.md → docs/API/alerting/notificationTemplate.md b/docs/API/alerting/messageTemplate.md → docs/API/alerting/notificationTemplate.md
@@ -1,10 +1,11 @@
-# messageTemplate
+# notificationTemplate
 
-grafonnet.alerting.messageTemplate
+grafonnet.alerting.notificationTemplate
 
 ## Index
 
 * [`fn withName(value)`](#fn-withname)
+* [`fn withProvenance(value)`](#fn-withprovenance)
 * [`fn withTemplate(value)`](#fn-withtemplate)
 
 ## Fields
@@ -20,6 +21,17 @@ PARAMETERS:
 * **value** (`string`)
 
 
+### fn withProvenance
+
+```jsonnet
+withProvenance(value)
+```
+
+PARAMETERS:
+
+* **value** (`string`)
+
+
 ### fn withTemplate
 
 ```jsonnet

diff --git a/docs/API/alerting/ruleGroup/index.md b/docs/API/alerting/ruleGroup/index.md
@@ -37,7 +37,7 @@ PARAMETERS:
 
 * **value** (`integer`)
 
-
+Duration in seconds.
 ### fn withName
 
 ```jsonnet

diff --git a/docs/API/alerting/ruleGroup/rule/data.md b/docs/API/alerting/ruleGroup/rule/data.md
@@ -27,7 +27,7 @@ PARAMETERS:
 
 * **value** (`string`)
 
-Grafana data source unique identifier; it should be '__expr__' for a Server Side Expression operation.
+
 ### fn withModel
 
 ```jsonnet
@@ -38,7 +38,7 @@ PARAMETERS:
 
 * **value** (`object`)
 
-JSON is the raw JSON query and includes the above properties as well as custom properties.
+
 ### fn withModelMixin
 
 ```jsonnet
@@ -49,7 +49,7 @@ PARAMETERS:
 
 * **value** (`object`)
 
-JSON is the raw JSON query and includes the above properties as well as custom properties.
+
 ### fn withQueryType
 
 ```jsonnet
@@ -60,8 +60,7 @@ PARAMETERS:
 
 * **value** (`string`)
 
-QueryType is an optional identifier for the type of query.
-It can be used to distinguish different types of queries.
+
 ### fn withRefId
 
 ```jsonnet
@@ -72,7 +71,7 @@ PARAMETERS:
 
 * **value** (`string`)
 
-RefID is the unique identifier of the query, set by the frontend call.
+
 ### fn withRelativeTimeRange
 
 ```jsonnet
@@ -110,9 +109,7 @@ PARAMETERS:
 
 * **value** (`integer`)
 
-A Duration represents the elapsed time between two instants
-as an int64 nanosecond count. The representation limits the
-largest representable duration to approximately 290 years.
+Duration in seconds.
 #### fn relativeTimeRange.withTo
 
 ```jsonnet
@@ -123,6 +120,4 @@ PARAMETERS:
 
 * **value** (`integer`)
 
-A Duration represents the elapsed time between two instants
-as an int64 nanosecond count. The representation limits the
-largest representable duration to approximately 290 years.
+Duration in seconds.
diff --git a/docs/API/alerting/ruleGroup/rule/index.md b/docs/API/alerting/ruleGroup/rule/index.md
@@ -112,11 +112,10 @@ withFor(value)
 
 PARAMETERS:
 
-* **value** (`integer`)
+* **value** (`string`)
 
-A Duration represents the elapsed time between two instants
-as an int64 nanosecond count. The representation limits the
-largest representable duration to approximately 290 years.
+The amount of time, in seconds, for which the rule must be breached for the rule to be considered to be Firing.
+Before this time has elapsed, the rule is only considered to be Pending.
 ### fn withIsPaused
 
 ```jsonnet

diff --git a/gen/grafonnet-v11.0.0/alerting.libsonnet b/gen/grafonnet-v11.0.0/alerting.libsonnet
diff --git a/gen/grafonnet-v11.0.0/clean/alerting/contactPoint.libsonnet b/gen/grafonnet-v11.0.0/clean/alerting/contactPoint.libsonnet
diff --git a/gen/grafonnet-v11.0.0/clean/alerting/messageTemplate.libsonnet b/gen/grafonnet-v11.0.0/clean/alerting/messageTemplate.libsonnet