github/karma
1
0
Fork 0
mirror of https://github.com/prymitive/karma synced 2026-05-05 03:16:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(config): move value mapping options to grid:sorting section

Browse Source 
Those options are only valid for sorting, so move it to the new config section where all sort options live
This commit is contained in:
Łukasz Mierzwa
2019-02-21 18:15:11 +00:00
parent a68796f630
commit 058d10f4ba
6 changed files with 45 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
demo/karma.yaml
View File

@@ -22,6 +22,16 @@ grid:
order: label
reverse: false
label: severity
customValues:
labels:
cluster:
prod: 1
staging: 2
dev: 3
severity:
critical: 1
warning: 2
info: 3
labels:
color:
static:
@@ -35,16 +45,6 @@ labels:
info: "#87c4e0"
warning: "#ffae42"
critical: "#ff220c"
sorting:
valueMapping:
cluster:
prod: 1
staging: 2
dev: 3
severity:
critical: 1
warning: 2
info: 3
log:
config: false
level: warning

68
docs/CONFIGURATION.md
View File

@@ -257,6 +257,8 @@ grid:
order: string
reverse: bool
label: string
customValues:
labels: dict
```
- `sorting:order` - default sort order for alert grid, valid values are:
@@ -270,7 +272,16 @@ grid:
- `sorting:reverse` - default value for reversed sort order
- `sorting:label` - label name for sorting when `grid:sorting:order` is set
to `label`. Labels can be assigned custom values used only by sorting via
`labels:sorting:valueMapping`, see [Labels](#Labels) section for details.
`sorting:customValues:labels`.
- `sorting:customValues:labels` - when sorting using alert labels values are
compared as strings, which work for labels like `cluster=A`, `cluster=B` &
`cluster=C`, but not for `cluster=prod`, `cluster=staging` & `cluster=dev`.
Alphabetic sort would order the second case as follows: `dev`, `prod`,
`staging`. To allow for more natural sorting `sorting:valueMapping` can be
used to map label values to integer values which will be used for sorting
instead of original string values.
Note: this option is not available via environment variables, you can only set
it via the config file.
Defaults:
@@ -280,10 +291,11 @@ grid:
order: startsAt
reverse: true
label: alertname
customValues:
labels: {}
```
Example with sorting using `severity` label, with extra option to map severity
labels to numeric values for sorting:
Example with sorting using `severity` label and value mappings for it:
```YAML
grid:
@@ -291,13 +303,12 @@ grid:
order: label
reverse: false
label: severity
labels:
sorting:
valueMapping:
severity:
critical: 1
warning: 2
info: 3
customValues:
labels:
severity:
critical: 1
warning: 2
info: 3
```
### Labels
@@ -316,13 +327,11 @@ Syntax:
```YAML
labels:
color:
static: []
unique: []
custom: {}
static: list of strings
unique: list of strings
custom: dict
keep: list of strings
strip: list of strings
sorting:
valueMapping: {}
```
- `color:static` - list of label names that will all have the same color applied
@@ -341,15 +350,6 @@ labels:
it via the config file.
- `keep` - list of allowed labels, if empty all labels are allowed.
- `strip` - list of ignored labels.
- `sorting:valueMapping` - when sorting using alert labels values are compared
as strings, which work for labels like `cluster=A`, `cluster=B` & `cluster=C`,
but not for `cluster=prod`, `cluster=staging` & `cluster=dev`. Alphabetic
sort would order the second case as follows: `dev`, `prod`, `staging`.
To allow for more natural sorting `sorting:valueMapping` can be used to
map label values to integer values which will be used for sorting instead
of original string values.
Note: this option is not available via environment variables, you can only set
it via the config file.
Example with static color for the `job` label (every `job` label will have the
same color regardless of the value) and unique color for the `@receiver` label
@@ -398,24 +398,6 @@ labels:
critical: "#ff220c"
```
Example with custom value mapping for sorting, this allows to put `cluster=prod`
or `severity=critical` (depending on which label is used for sorting) on top of
the dashboard grid (or bottom if `Reverse` is enabled by user).
```YAML
labels:
sorting:
valueMapping:
cluster:
prod: 1
staging: 2
dev: 3
severity:
critical: 1
warning: 2
info: 3
```
Defaults:
```YAML
@@ -426,8 +408,6 @@ labels:
custom: {}
keep: []
strip: []
sorting:
valueMapping: {}
```
### Listen

2
internal/config/config.go
View File

@@ -175,7 +175,7 @@ func (config *configSchema) Read() {
log.Fatal(err)
}
err = v.UnmarshalKey("labels.sorting.valuemapping", &config.Labels.Sorting.ValueMapping)
err = v.UnmarshalKey("grid.sorting.customValues.labels", &config.Grid.Sorting.CustomValues.Labels)
if err != nil {
log.Fatal(err)
}

4
internal/config/config_test.go
View File

@@ -87,6 +87,8 @@ grid:
order: startsAt
reverse: true
label: alertname
customValues:
labels: {}
labels:
keep:
- foo
@@ -103,8 +105,6 @@ labels:
unique:
- f
- gg
sorting:
valueMapping: {}
listen:
address: 0.0.0.0
port: 80

12
internal/config/models.go
View File

@@ -45,9 +45,12 @@ type configSchema struct {
}
Grid struct {
Sorting struct {
Order string
Reverse bool
Label string
Order string
Reverse bool
Label string
CustomValues struct {
Labels map[string]map[string]int
} `yaml:"customValues"`
}
}
Labels struct {
@@ -58,9 +61,6 @@ type configSchema struct {
Static []string
Unique []string
}
Sorting struct {
ValueMapping map[string]map[string]int `yaml:"valueMapping"`
}
}
Listen struct {
Address string

4
views.go
View File

@@ -97,8 +97,8 @@ func alerts(c *gin.Context) {
AnnotationsVisible: config.Config.Annotations.Visible,
}
if config.Config.Labels.Sorting.ValueMapping != nil {
resp.Settings.Sorting.ValueMapping = config.Config.Labels.Sorting.ValueMapping
if config.Config.Grid.Sorting.CustomValues.Labels != nil {
resp.Settings.Sorting.ValueMapping = config.Config.Grid.Sorting.CustomValues.Labels
}
// use full URI (including query args) as cache key