Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(Traefik Proxy): fix VALUES.md generation on prometheus values #1349

Merged
merged 1 commit into from
Feb 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions traefik/VALUES.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ Kubernetes: `>=1.22.0-0`
| logs.general.format | string | `nil` | Set [logs format](https://doc.traefik.io/traefik/observability/logs/#format) |
| logs.general.level | string | `"INFO"` | Alternative logging levels are TRACE, DEBUG, INFO, WARN, ERROR, FATAL, and PANIC. |
| logs.general.noColor | bool | `false` | When set to true and format is common, it disables the colorized output. |
| metrics.addInternals | bool | `false` | |
| metrics.addInternals | bool | `false` | Enable metrics for internal resources. Default: false |
| metrics.otlp.addEntryPointsLabels | string | `nil` | Enable metrics on entry points. Default: true |
| metrics.otlp.addRoutersLabels | string | `nil` | Enable metrics on routers. Default: false |
| metrics.otlp.addServicesLabels | string | `nil` | Enable metrics on services. Default: true |
Expand All @@ -210,14 +210,14 @@ Kubernetes: `>=1.22.0-0`
| metrics.otlp.http.tls.insecureSkipVerify | string | `nil` | When set to true, the TLS connection accepts any certificate presented by the server regardless of the hostnames it covers. |
| metrics.otlp.http.tls.key | string | `""` | The path to the private key. When using this option, setting the cert option is required. |
| metrics.otlp.pushInterval | string | `""` | Interval at which metrics are sent to the OpenTelemetry Collector. Default: 10s |
| metrics.prometheus.addEntryPointsLabels | string | `nil` | |
| metrics.prometheus.addRoutersLabels | string | `nil` | |
| metrics.prometheus.addServicesLabels | string | `nil` | |
| metrics.prometheus.buckets | string | `""` | |
| metrics.prometheus.addEntryPointsLabels | string | `nil` | Enable metrics on entry points. Default: true |
| metrics.prometheus.addRoutersLabels | string | `nil` | Enable metrics on routers. Default: false |
| metrics.prometheus.addServicesLabels | string | `nil` | Enable metrics on services. Default: true |
| metrics.prometheus.buckets | string | `""` | Buckets for latency metrics. Default="0.1,0.3,1.2,5.0" |
| metrics.prometheus.disableAPICheck | string | `nil` | When set to true, it won't check if Prometheus Operator CRDs are deployed |
| metrics.prometheus.entryPoint | string | `"metrics"` | Entry point used to expose metrics. |
| metrics.prometheus.headerLabels | object | `{}` | Add HTTP header labels to metrics. Example: headerLabels: { label: headerKey } |
| metrics.prometheus.manualRouting | bool | `false` | |
| metrics.prometheus.headerLabels | object | `{}` | Add HTTP header labels to metrics. See EXAMPLES.md or upstream doc for usage. |
| metrics.prometheus.manualRouting | bool | `false` | When manualRouting is true, it disables the default internal router in # order to allow creating a custom router for prometheus@internal service. |
| metrics.prometheus.prometheusRule.additionalLabels | object | `{}` | |
| metrics.prometheus.prometheusRule.enabled | bool | `false` | Enable optional CR for Prometheus Operator. See EXAMPLES.md for more details. |
| metrics.prometheus.prometheusRule.namespace | string | `""` | |
Expand Down
18 changes: 9 additions & 9 deletions traefik/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -394,26 +394,26 @@ logs:
names: {}

metrics:
## -- Enable metrics for internal resources. Default: false
# -- Enable metrics for internal resources. Default: false
addInternals: false

## -- Prometheus is enabled by default.
## -- It can be disabled by setting "prometheus: null"
## Prometheus is enabled by default.
## It can be disabled by setting "prometheus: null"
prometheus:
# -- Entry point used to expose metrics.
entryPoint: metrics
## Enable metrics on entry points. Default: true
# -- Enable metrics on entry points. Default: true
addEntryPointsLabels: # @schema type:[boolean, null]
## Enable metrics on routers. Default: false
# -- Enable metrics on routers. Default: false
addRoutersLabels: # @schema type:[boolean, null]
## Enable metrics on services. Default: true
# -- Enable metrics on services. Default: true
addServicesLabels: # @schema type:[boolean, null]
## Buckets for latency metrics. Default="0.1,0.3,1.2,5.0"
# -- Buckets for latency metrics. Default="0.1,0.3,1.2,5.0"
buckets: ""
## When manualRouting is true, it disables the default internal router in
# -- When manualRouting is true, it disables the default internal router in
## order to allow creating a custom router for prometheus@internal service.
manualRouting: false
## Add HTTP header labels to metrics. See EXAMPLES.md or upstream doc for usage.
# -- Add HTTP header labels to metrics. See EXAMPLES.md or upstream doc for usage.
headerLabels: {} # @schema type:[object, null]
service:
# -- Create a dedicated metrics service to use with ServiceMonitor
Expand Down