Skip to content

Commit

Permalink
Fix Prometheus doc links
Browse files Browse the repository at this point in the history
  • Loading branch information
thegridman committed Jan 7, 2025
1 parent 8c6a53e commit 4905654
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 20 deletions.
36 changes: 18 additions & 18 deletions docs/about/04_coherence_spec.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -753,24 +753,24 @@ ServiceMonitorSpec the ServiceMonitor spec for a port service.
| Field | Description | Type | Required
m| enabled | Enabled is a flag to enable or disable creation of a Prometheus ServiceMonitor for a port. If Prometheus ServiceMonitor CR is not installed no ServiceMonitor then even if this flag is true no ServiceMonitor will be created. m| *bool | false
m| labels | Additional labels to add to the ServiceMonitor. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ m| map[string]string | false
m| jobLabel | The label to use to retrieve the job name from. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#servicemonitorspec m| string | false
m| targetLabels | TargetLabels transfers labels on the Kubernetes Service onto the target. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#servicemonitorspec m| []string | false
m| podTargetLabels | PodTargetLabels transfers labels on the Kubernetes Pod onto the target. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#servicemonitorspec m| []string | false
m| sampleLimit | SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#servicemonitorspec m| *uint64 | false
m| path | HTTP path to scrape for metrics. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#endpoint m| string | false
m| scheme | HTTP scheme to use for scraping. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#endpoint m| string | false
m| params | Optional HTTP URL parameters See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#endpoint m| map[string][]string | false
m| interval | Interval at which metrics should be scraped See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#endpoint m| monitoringv1.Duration | false
m| scrapeTimeout | Timeout after which the scrape is ended See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#endpoint m| monitoringv1.Duration | false
m| tlsConfig | TLS configuration to use when scraping the endpoint See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#endpoint m| *monitoringv1.TLSConfig | false
m| bearerTokenFile | File to read bearer token for scraping targets. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#endpoint m| string | false
m| bearerTokenSecret | Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the service monitor and accessible by the Prometheus Operator. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#endpoint m| *https://{k8s-doc-link}/#secretkeyselector-v1-core[corev1.SecretKeySelector] | false
m| honorLabels | HonorLabels chooses the metric labels on collisions with target labels. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#endpoint m| bool | false
m| honorTimestamps | HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#endpoint m| *bool | false
m| basicAuth | BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#endpoint m| *monitoringv1.BasicAuth | false
m| metricRelabelings | MetricRelabelings to apply to samples before ingestion. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#endpoint m| []monitoringv1.RelabelConfig | false
m| relabelings | Relabelings to apply to samples before scraping. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#endpoint m| []monitoringv1.RelabelConfig | false
m| proxyURL | ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#endpoint m| *string | false
m| jobLabel | The label to use to retrieve the job name from. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#servicemonitorspec m| string | false
m| targetLabels | TargetLabels transfers labels on the Kubernetes Service onto the target. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#servicemonitorspec m| []string | false
m| podTargetLabels | PodTargetLabels transfers labels on the Kubernetes Pod onto the target. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#servicemonitorspec m| []string | false
m| sampleLimit | SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#servicemonitorspec m| *uint64 | false
m| path | HTTP path to scrape for metrics. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#endpoint m| string | false
m| scheme | HTTP scheme to use for scraping. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#endpoint m| string | false
m| params | Optional HTTP URL parameters See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#endpoint m| map[string][]string | false
m| interval | Interval at which metrics should be scraped See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#endpoint m| monitoringv1.Duration | false
m| scrapeTimeout | Timeout after which the scrape is ended See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#endpoint m| monitoringv1.Duration | false
m| tlsConfig | TLS configuration to use when scraping the endpoint See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#endpoint m| *monitoringv1.TLSConfig | false
m| bearerTokenFile | File to read bearer token for scraping targets. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#endpoint m| string | false
m| bearerTokenSecret | Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the service monitor and accessible by the Prometheus Operator. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#endpoint m| *https://{k8s-doc-link}/#secretkeyselector-v1-core[corev1.SecretKeySelector] | false
m| honorLabels | HonorLabels chooses the metric labels on collisions with target labels. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#endpoint m| bool | false
m| honorTimestamps | HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#endpoint m| *bool | false
m| basicAuth | BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#endpoint m| *monitoringv1.BasicAuth | false
m| metricRelabelings | MetricRelabelings to apply to samples before ingestion. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#endpoint m| []monitoringv1.RelabelConfig | false
m| relabelings | Relabelings to apply to samples before scraping. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#endpoint m| []monitoringv1.RelabelConfig | false
m| proxyURL | ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. See https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#endpoint m| *string | false
|===
<<Table of Contents,Back to TOC>>
Expand Down
4 changes: 2 additions & 2 deletions docs/ports/040_servicemonitors.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ spec:
The `Coherence` CRD <<docs/about/04_coherence_spec.adoc#_servicemonitorspec,ServiceMonitorSpec>>
contains many of the fields from the
https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#servicemonitorspec[Prometheus `ServiceMonitorSpec`]
and https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#endpoint[Prometheus Endpoint]
https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#servicemonitorspec[Prometheus `ServiceMonitorSpec`]
and https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#endpoint[Prometheus Endpoint]
to allow the `ServiceMonitor` to be configured for most use-cases.
In situations where the `Coherence` CRD does not have the required fields, for example when a different version
Expand Down

0 comments on commit 4905654

Please sign in to comment.