mirrors/prometheus-operator
mirrors/prometheus-operator
1
0
Fork 0
mirror of https://github.com/prometheus-operator/prometheus-operator.git synced 2025-04-21 11:48:53 +00:00
Code Activity

documentation: clarify _RelabelConfig_ usage

Browse source 
The _RelabelConfig_ is confusing and connotes, that it is about
`<relabel_config>`-section of the configuration, but in reality it is about
`<metric_relabel_configs>`-section.

Comment in `types.go` was changed and `make generate` run to update generated documentation.
This commit is contained in:
Alexander Dobriakov 2018-02-28 22:37:21 +01:00
parent f29ea1e1e2
commit 67ed5b20b5
5 changed files with 13 additions and 7 deletions
Documentation
api.md
example/prometheus-operator-crd
prometheus.crd.yamlservicemonitor.crd.yaml
pkg/client/monitoring/v1
openapi_generated.gotypes.go

2
Documentation/api.md
View file

@ -234,7 +234,7 @@ Most recent observed status of the Prometheus cluster. Read-only. Not included w
## RelabelConfig
RelabelConfig allows dynamic rewriting of the label set.
RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines `<metric_relabel_configs>`-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |

6
example/prometheus-operator-crd/prometheus.crd.yaml
View file

@ -1036,8 +1036,10 @@ spec:
writeRelabelConfigs:
description: The list of remote write relabel configurations.
items:
description: RelabelConfig allows dynamic rewriting of the label
set.
description: 'RelabelConfig allows dynamic rewriting of the
label set, being applied to samples before ingestion. It defines
`<metric_relabel_configs>`-section of Prometheus configuration.
More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs'
properties:
action:
description: Action to perform based on regex matching.

6
example/prometheus-operator-crd/servicemonitor.crd.yaml
View file

@ -83,8 +83,10 @@ spec:
metricRelabelings:
description: MetricRelabelConfigs to apply to samples before ingestion.
items:
description: RelabelConfig allows dynamic rewriting of the label
set.
description: 'RelabelConfig allows dynamic rewriting of the
label set, being applied to samples before ingestion. It defines
`<metric_relabel_configs>`-section of Prometheus configuration.
More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs'
properties:
action:
description: Action to perform based on regex matching.

2
pkg/client/monitoring/v1/openapi_generated.go
View file

@ -884,7 +884,7 @@ func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenA
"github.com/coreos/prometheus-operator/pkg/client/monitoring/v1.RelabelConfig": {
Schema: spec.Schema{
SchemaProps: spec.SchemaProps{
Description: "RelabelConfig allows dynamic rewriting of the label set.",
Description: "RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines `<metric_relabel_configs>`-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs",
Properties: map[string]spec.Schema{
"sourceLabels": {
SchemaProps: spec.SchemaProps{

4
pkg/client/monitoring/v1/types.go
View file

@ -218,7 +218,9 @@ type RemoteReadSpec struct {
ProxyURL string `json:"proxy_url,omitempty"`
}
// RelabelConfig allows dynamic rewriting of the label set.
// RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion.
// It defines `<metric_relabel_configs>`-section of Prometheus configuration.
// More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
// +k8s:openapi-gen=true
type RelabelConfig struct {
//The source labels select values from existing labels. Their content is concatenated