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

breaking change: rename discovery.file to local.file_match #4394

Merged
merged 3 commits into from
Jul 12, 2023

Conversation

rfratto
Copy link
Member

@rfratto rfratto commented Jul 11, 2023

This commit renames discovery.file to local.file_match so that:

  • The purpose of the component is more clear (i.e., to find files on the local filesystem which match a given pattern).

  • To remove a point of confusion where discovery.file was thought to be Prometheus' file SD.

  • To allow a component for Prometheus' file SD to be named discovery.file, which otherwise would've collided with the now-named local.file_match.

A redirect from the old documentation page is explicitly not configured because we anticipate creating a new page called discovery.file, which will have a warning about the rename.

Related to #3607.

This commit renames discovery.file to local.file_match so that:

* The purpose of the component is more clear (i.e., to find files on
  the local filesystem which match a given pattern).

* To remove a point of confusion where `discovery.file` was thought to
  be Prometheus' file SD.

* To allow a component for Prometheus' file SD to be named
  discovery.file, which otherwise would've collided with the now-named
  local.file_match.

A redirect from the old documentation page is explicitly not configured
because we anticipate creating a new page called discovery.file, which
will have a warning about the rename.

Related to grafana#3607.
@rfratto rfratto requested review from a team and clayton-cornell as code owners July 11, 2023 13:24
Copy link
Contributor

@clayton-cornell clayton-cornell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rfratto rfratto enabled auto-merge (squash) July 12, 2023 13:42
@rfratto rfratto merged commit 537c3f6 into grafana:main Jul 12, 2023
@rfratto rfratto deleted the rename-discovery.file branch July 12, 2023 13:44
clayton-cornell pushed a commit that referenced this pull request Aug 14, 2023
This commit renames discovery.file to local.file_match so that:

* The purpose of the component is more clear (i.e., to find files on
  the local filesystem which match a given pattern).

* To remove a point of confusion where `discovery.file` was thought to
  be Prometheus' file SD.

* To allow a component for Prometheus' file SD to be named
  discovery.file, which otherwise would've collided with the now-named
  local.file_match.

A redirect from the old documentation page is explicitly not configured
because we anticipate creating a new page called discovery.file, which
will have a warning about the rename.

Related to #3607.
clayton-cornell pushed a commit that referenced this pull request Aug 14, 2023
This commit renames discovery.file to local.file_match so that:

* The purpose of the component is more clear (i.e., to find files on
  the local filesystem which match a given pattern).

* To remove a point of confusion where `discovery.file` was thought to
  be Prometheus' file SD.

* To allow a component for Prometheus' file SD to be named
  discovery.file, which otherwise would've collided with the now-named
  local.file_match.

A redirect from the old documentation page is explicitly not configured
because we anticipate creating a new page called discovery.file, which
will have a warning about the rename.

Related to #3607.
@github-actions github-actions bot added the frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. label Feb 22, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants