Skip to content

refactor: Rename metrics-port to management-port #1012

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 7 commits into from
Nov 16, 2023
Merged

refactor: Rename metrics-port to management-port #1012

merged 7 commits into from
Nov 16, 2023

Conversation

craigpastro
Copy link
Member

@craigpastro craigpastro commented Nov 14, 2023 •
edited
Loading

This PR

  • Renames the flag --metrics-port to --management-port
  • The short flag name -m now relates to --management-port
  • Add a deprecated notice to --metrics-port
  • Replaces "metrics port" with "management port" in docs (and any variants)
  • Behaviour: If --management-port is set use that value (and possibly ignore --metrics-port). If not and --metrics-port is set use that value. Otherwise, use the default value.

Related Issues

Resolves #867.

Notes

Follow-up Tasks

How to test

@craigpastro craigpastro requested a review from a team as a code owner November 14, 2023 20:42
@netlify Netlify
Copy link

netlify bot commented Nov 14, 2023 •
edited
Loading

✅ Deploy Preview for polite-licorice-3db33c canceled.

Name Link
🔨 Latest commit bc4e5c2
🔍 Latest deploy log https://app.netlify.com/sites/polite-licorice-3db33c/deploys/65565b0b5bfc010008c8f5f1

@codecov Codecov
Copy link

codecov bot commented Nov 14, 2023 •
edited
Loading

Codecov Report

Attention: 8 lines in your changes are missing coverage. Please review.

Comparison is base (e6f92d2) 71.96% compared to head (bc4e5c2) 71.96%.
Report is 2 commits behind head on main.

Files Patch % Lines
core/pkg/runtime/from_config.go 0.00% 8 Missing ⚠️
Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #1012   +/-   ##
=======================================
  Coverage   71.96%   71.96%           
=======================================
  Files          28       28           
  Lines        2864     2864           
=======================================
  Hits         2061     2061           
  Misses        699      699           
  Partials      104      104

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@craigpastro
Rename metrics-port to management-port
54891be 
Signed-off-by: Craig Pastro <craig.pastro@gmail.com>
@beeme1mr beeme1mr changed the title refactor: Rename metrics-port to management-port refactor!: Rename metrics-port to management-port Nov 14, 2023
Kavindu-Dodan
Kavindu-Dodan approved these changes Nov 15, 2023
View reviewed changes
Copy link
Contributor

@Kavindu-Dodan Kavindu-Dodan left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Changes looks good. Like @beeme1mr said, we need to upadte Openfeature Operator to adapt to this configuration change. However, this change won't break exisiting configurations as we have fallback option for deprecated configuration option.

If we release flagd, @odubajDT is this something that we could include with beta version changeset ?

@Kavindu-Dodan Kavindu-Dodan mentioned this pull request Nov 15, 2023
Merged
@toddbaert toddbaert self-requested a review November 15, 2023 20:45
@toddbaert toddbaert self-requested a review November 15, 2023 20:48
toddbaert
toddbaert approved these changes Nov 15, 2023
View reviewed changes
Copy link
Member

@toddbaert toddbaert left a comment

Choose a reason for hiding this comment

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

Is this actually breaking with the change here? Doesn't this make it transparent?

Also we can perhaps log a warning if the deprecated option is used: https://github.com/open-feature/flagd/pull/1012/files#r1394782335

@craigpastro
Add a warning log for deprecated flag
22b1e03 
Signed-off-by: Craig Pastro <craig.pastro@gmail.com>
@craigpastro
Merge branch 'metrics-port-to-management-port' of https://github.com/…
ad52e64 
…craigpastro/flagd into metrics-port-to-management-port
@Kavindu-Dodan
Copy link
Contributor

Is this actually breaking with the change here? Doesn't this make it transparent?

Also we can perhaps log a warning if the deprecated option is used: https://github.com/open-feature/flagd/pull/1012/files#r1394782335

Yeah this is not a breaking change. We can modify the PR title if we all agree :)

@odubajDT odubajDT mentioned this pull request Nov 16, 2023
Merged
@toddbaert
Copy link
Member

Is this actually breaking with the change here? Doesn't this make it transparent?
Also we can perhaps log a warning if the deprecated option is used: https://github.com/open-feature/flagd/pull/1012/files#r1394782335

Yeah this is not a breaking change. We can modify the PR title if we all agree :)

@craigpastro is there actually a breaking change here?

@craigpastro
Copy link
Member Author

craigpastro commented Nov 16, 2023 •
edited
Loading

@craigpastro is there actually a breaking change here?

No, I wouldn’t call it such since it is still backwards compatible. There is the possibility that someone may use both --management-port and --metrics-port and not get what they expect, but that is forward-breaking I guess.

@beeme1mr beeme1mr changed the title refactor!: Rename metrics-port to management-port refactor: Rename metrics-port to management-port Nov 16, 2023
@beeme1mr beeme1mr removed the breaking label Nov 16, 2023
@beeme1mr beeme1mr merged commit 5635e38 into open-feature:main Nov 16, 2023
@github-actions github-actions bot mentioned this pull request Nov 16, 2023
Merged
@craigpastro craigpastro deleted the metrics-port-to-management-port branch November 17, 2023 22:20
toddbaert pushed a commit that referenced this pull request Nov 28, 2023
@github-actions
chore: release main (#1017)
14929dd 
🤖 I have created a release *beep* *boop*
---


<details><summary>flagd: 0.7.1</summary>

##
[0.7.1](flagd/v0.7.0...flagd/v0.7.1)
(2023-11-28)


### 🐛 Bug Fixes

* **deps:** update module github.com/open-feature/flagd/core to v0.7.0
([#1014](#1014))
([deec49e](deec49e))


### 🔄 Refactoring

* Rename metrics-port to management-port
([#1012](#1012))
([5635e38](5635e38))
</details>

<details><summary>flagd-proxy: 0.3.1</summary>

##
[0.3.1](flagd-proxy/v0.3.0...flagd-proxy/v0.3.1)
(2023-11-28)


### 🐛 Bug Fixes

* **deps:** update module github.com/open-feature/flagd/core to v0.7.0
([#1014](#1014))
([deec49e](deec49e))


### 🔄 Refactoring

* Rename metrics-port to management-port
([#1012](#1012))
([5635e38](5635e38))
</details>

<details><summary>core: 0.7.1</summary>

##
[0.7.1](core/v0.7.0...core/v0.7.1)
(2023-11-28)


### 🐛 Bug Fixes

* **deps:** update kubernetes packages to v0.28.4
([#1016](#1016))
([ae470e3](ae470e3))
* **deps:** update opentelemetry-go monorepo
([#1019](#1019))
([23ae555](23ae555))


### 🔄 Refactoring

* Rename metrics-port to management-port
([#1012](#1012))
([5635e38](5635e38))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Kavindu-Dodan Kavindu-Dodan Kavindu-Dodan approved these changes

@beeme1mr beeme1mr beeme1mr approved these changes

@thisthat thisthat thisthat approved these changes

@toddbaert toddbaert toddbaert approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Rename "metrics" port to "management" port
5 participants
@craigpastro @Kavindu-Dodan @toddbaert @beeme1mr @thisthat