Skip to content

Commit

Permalink
fix typos in README of v1 samples
Browse files Browse the repository at this point in the history
Took 4 minutes
  • Loading branch information
agaurav committed Jul 21, 2022
1 parent 219a95a commit 426a229
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions samples/sumologic/v1/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
## Creating Sumologic native SLO's and monitors from OpenSLO yaml configs
# Creating Sumologic native SLO's and monitors from OpenSLO yaml configs

slogen support native sumologic slo creation for spec version v1 for OpenSLO.

Samples can be found in the [samples/sumologic/v1/](samples/sumologic/v1/) directory.


#### OpenSLO SLI to Sumologic SLI fields mapping
### OpenSLO SLI to Sumologic SLI fields mapping

- the `name` value specified in `metadata:name` field of the OpenSLO spec is used as the SLO name
- Budgeting method `Occurrences` maps to `Request` based SLO's while `Timeslices` maps to `Window` based SLO's
- use `"sumologic-logs` as `metricSource:type` for logs based Indicators, while `"sumologic-metrics`` for metrics based Indicators
- use `"sumologic-logs` as `metricSource:type` for logs based Indicators, while `sumologic-metrics` for metrics based Indicators

#### Using Alerting Policies to create SLO monitors
slogen doesn't support inline alerting conditional in SLO config yaml.
### Using Alerting Policies to create SLO monitors
For now slogen doesn't support inline alerting conditional in SLO config yaml.
Alerting policies need to specified separately as showed in the samples and then can be referred by name the SLO config.

To specify the `critical` and `warning` threshold use the same condition `name` as done in the samples.

To specify the `critical` and `warning` threshold use the same condition `name` while changing the severity level as done in the samples.

0 comments on commit 426a229

Please sign in to comment.