Skip to content

Mismatch between docs and values.yaml for CODER_PROMETHEUS_ADDRESS #16538

Closed
@Cjkjvfnby

Description

@Cjkjvfnby

Is there an existing issue for this?

  • I have searched the existing issues

Current Behavior

Docs: https://coder.com/docs/admin/integrations/prometheus#kubernetes-deployment

The Prometheus endpoint can be enabled in the Helm chart's values.yml by setting the environment variable CODER_PROMETHEUS_ADDRESS to 0.0.0.0:2112.

values.yaml: https://github.com/coder/coder/blob/main/helm/coder/values.yaml

# Note: The following environment variables are set by default and cannot be
  # overridden:
  ...
  # - CODER_PROMETHEUS_ADDRESS: set to 0.0.0.0:2112 and cannot be changed.

Instructions to set a variable that is set by default are confusing.

Relevant Log Output

Expected Behavior

Documentation is consistent with values.yaml comments.

Steps to Reproduce

  1. Check https://coder.com/docs/admin/integrations/prometheus#kubernetes-deployment
  2. Check https://github.com/coder/coder/blob/main/helm/coder/values.yaml

Environment

Additional Context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsArea: coder.com/docss4Internal bugs (e.g. test flakes), extreme edge cases, and bug risks

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions