Skip to content

Commit d3f0c18

Browse files
authored
Merge pull request #2577 from dashpole/update_om_links
docs: update links to openmetrics to reference the v1.0.0 release
2 parents b5abea9 + 6cfc844 commit d3f0c18

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

docs/metrics/extend/customresourcestate-metrics.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -294,13 +294,13 @@ The above configuration was tested on [this](https://github.com/kubernetes/autos
294294

295295
### Metric types
296296

297-
The configuration supports three kind of metrics from the [OpenMetrics specification](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md).
297+
The configuration supports three kind of metrics from the [OpenMetrics specification](https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md).
298298

299299
The metric type is specified by the `type` field and its specific configuration at the types specific struct.
300300

301301
#### Gauge
302302

303-
> Gauges are current measurements, such as bytes of memory currently used or the number of items in a queue. For gauges the absolute value is what is of interest to a user. [[0]](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#gauge)
303+
> Gauges are current measurements, such as bytes of memory currently used or the number of items in a queue. For gauges the absolute value is what is of interest to a user. [[0]](https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#gauge)
304304

305305
Example:
306306

@@ -386,7 +386,7 @@ kube_customresource_foo_status{customresource_group="myteam.io", customresource_
386386

387387
#### StateSet
388388

389-
> StateSets represent a series of related boolean values, also called a bitset. If ENUMs need to be encoded this MAY be done via StateSet. [[1]](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#stateset)
389+
> StateSets represent a series of related boolean values, also called a bitset. If ENUMs need to be encoded this MAY be done via StateSet. [[1]](https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#stateset)
390390

391391
```yaml
392392
kind: CustomResourceStateMetrics
@@ -420,7 +420,7 @@ kube_customresource_status_phase{customresource_group="myteam.io", customresourc
420420

421421
#### Info
422422

423-
> Info metrics are used to expose textual information which SHOULD NOT change during process lifetime. Common examples are an application's version, revision control commit, and the version of a compiler. [[2]](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#info)
423+
> Info metrics are used to expose textual information which SHOULD NOT change during process lifetime. Common examples are an application's version, revision control commit, and the version of a compiler. [[2]](https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#info)
424424

425425
Metrics of type `Info` will always have a value of 1.
426426

pkg/customresourcestate/config_metrics_types.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ type MetricMeta struct {
2525
}
2626

2727
// MetricGauge targets a Path that may be a single value, array, or object. Arrays and objects will generate a metric per element.
28-
// Ref: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#gauge
28+
// Ref: https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#gauge
2929
type MetricGauge struct {
3030
// LabelFromKey adds a label with the given name if Path is an object. The label value will be the object key.
3131
LabelFromKey string `yaml:"labelFromKey" json:"labelFromKey"`
@@ -38,15 +38,15 @@ type MetricGauge struct {
3838
}
3939

4040
// MetricInfo is a metric which is used to expose textual information.
41-
// Ref: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#info
41+
// Ref: https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#info
4242
type MetricInfo struct {
4343
// LabelFromKey adds a label with the given name if Path is an object. The label value will be the object key.
4444
LabelFromKey string `yaml:"labelFromKey" json:"labelFromKey"`
4545
MetricMeta `yaml:",inline" json:",inline"`
4646
}
4747

4848
// MetricStateSet is a metric which represent a series of related boolean values, also called a bitset.
49-
// Ref: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#stateset
49+
// Ref: https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#stateset
5050
type MetricStateSet struct {
5151
MetricMeta `yaml:",inline" json:",inline"`
5252

pkg/metric/metric.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ var (
3737
}
3838
)
3939

40-
// Type represents the type of the metric. See https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#metric-types.
40+
// Type represents the type of the metric. See https://github.com/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#metric-types.
4141
type Type string
4242

4343
// Supported metric types.

0 commit comments

Comments
 (0)