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

Rename "metrics" port to "management" port #867

Closed
toddbaert opened this issue Aug 28, 2023 · 6 comments · Fixed by #1012
Closed

Rename "metrics" port to "management" port #867

toddbaert opened this issue Aug 28, 2023 · 6 comments · Fixed by #1012
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@toddbaert
Copy link
Member

toddbaert commented Aug 28, 2023

Currently, the "metrics" port configuration controls the port the HTTP readyz/healthz checks, gRPC health check, and metrics.

We should change the name to "management" port to make clear it exposes more than just metrics.

Relates to: #863

Be sure to update any related doc.

@toddbaert toddbaert added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Aug 28, 2023
@Saurabhkr952
Copy link

I'd like to work on this. Changing "metrics" to "management" port makes sense given its broader functionality. I'm ready to implement the change and update the docs.
Please guide me on the next steps or any specific requirements for this contribution.

Thank you!

@toddbaert
Copy link
Member Author

Thanks @Saurabhkr952 . Once #863 is merged, I think it should be a matter of:

  • updating the viper config (use managementPort and fallback to metricsPort if managementPort is not defined), and add some kind of deprecation warning if possible
  • update all mention of metrics port / metricsPort / etc in docs, and mention the deprecation above
  • update code / config objects to use managementPort instead of metricsPort

I think that'll about cover it.

@agardnerIT
Copy link
Contributor

Please also document this as a new page on the website (in /web-docs) as a Definition of done - so that this doesn't go out without documentation.

Saying that, I don't think we have documentation on this piece yet at all...

Saurabhkr952 added a commit to Saurabhkr952/flagd that referenced this issue Sep 16, 2023
Saurabhkr952 added a commit to Saurabhkr952/flagd that referenced this issue Sep 16, 2023
Signed-off-by: Saurabhkr952 <saurabhkr952@gmail.com>
@craigpastro
Copy link
Member

It seems that work on the issue has gotten a bit stale. Does anyone mind if I pick this task up? @Saurabhkr952?

@beeme1mr beeme1mr assigned craigpastro and unassigned Saurabhkr952 Nov 14, 2023
@beeme1mr
Copy link
Member

Hey @craigpastro, that would be great! I've reassigned the issue to you. Thank you 🙇

@beeme1mr beeme1mr removed the help wanted Extra attention is needed label Nov 14, 2023
@craigpastro
Copy link
Member

Thanks @beeme1mr! I'll try to get to it soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
5 participants