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.

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

Fix docs: explain available metrics for Hubble VS Legacy control plane #1093

Closed
SRodi opened this issue Dec 2, 2024 · 4 comments
Closed

Fix docs: explain available metrics for Hubble VS Legacy control plane #1093

SRodi opened this issue Dec 2, 2024 · 4 comments
Assignees
@SRodi
Labels
area/documentation Improvements or additions to documentation meta/invalid This doesn't seem right

Comments

@SRodi
Copy link
Member

SRodi commented Dec 2, 2024 •
edited
Loading

Issue

The doc https://retina.sh/docs/Metrics/modes/ does not explain / differentiate between retina control planes.

We should clarify adv_ metrics are not available for Hubble control plane

This relates to #1055
@SRodi SRodi added area/controllers area/metrics area/operator control-plane/hubble lang/go The Go Programming Language meta/invalid This doesn't seem right type/bug Something isn't working labels Dec 2, 2024
@SRodi
Copy link
Member Author

SRodi commented Dec 3, 2024

It seems this is an issue with the docs as the current implementation supports Advanced/Pod-Level metrics (i.e. metrics with the prefix adv_) only on Legacy control plane. However, I do not find this mentioned anywhere in the docs https://retina.sh/docs/Metrics/modes/

@SRodi SRodi added area/documentation Improvements or additions to documentation and removed type/bug Something isn't working lang/go The Go Programming Language area/metrics area/controllers area/operator control-plane/hubble labels Dec 5, 2024
@SRodi SRodi changed the title metricsconfiguration-controller not starting Fix docs: explain available metrics for Hubble VS Legacy control plane Dec 5, 2024
@DeeBi9
Copy link

DeeBi9 commented Dec 11, 2024 •
edited
Loading

@SRodi
As you mentioned that the there is no clear mention of which control plane support which metrics mode. Could you please confirm whether the following is correct?
1.Basic Mode: Available for both Legacy and Hubble control planes.
2.Advanced/Pod-Level with Remote Context: Available only for Legacy control plane.
3.Advanced/Pod-Level with Local Context: Available only for Legacy control plane.

@SRodi
Copy link
Member Author

SRodi commented Dec 12, 2024

@vakalapa can you please provide additional insights on the current state of metrics for Hubble VS Legacy control plane? Thanks.

@SRodi SRodi mentioned this issue Jan 7, 2025
Merged
7 tasks
github-merge-queue bot pushed a commit that referenced this issue Jan 10, 2025
@SRodi
chore(docs): Add doc for Hubble control plane and metrics (#1194)
e31cc3c 
# Description

Initial PR to add documentation for Hubble control plane and metrics.

## Related Issue

#1055 
#1093

## Checklist

- [x] I have read the [contributing
documentation](https://retina.sh/docs/contributing).
- [x] I signed and signed-off the commits (`git commit -S -s ...`). See
[this
documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)
on signing commits.
- [x] I have correctly attributed the author(s) of the code.
- [x] I have tested the changes locally.
- [x] I have followed the project's style guidelines.
- [x] I have updated the documentation, if necessary.
- [x] I have added tests, if applicable.

## Screenshots (if applicable) or Testing Completed

![image](https://github.com/user-attachments/assets/eafb42b9-795d-42d6-86cf-a9271eaaea4c)


![image](https://github.com/user-attachments/assets/f491ce0e-4456-4190-bb54-7dfa64f7b626)


![image](https://github.com/user-attachments/assets/eab86779-ed75-4d94-877d-e6f48213e865)


![image](https://github.com/user-attachments/assets/d82cc71d-3d74-427d-8e91-e7c1c4b495d9)


Please add any relevant screenshots or GIFs to showcase the changes
made.

## Additional Notes

Add any additional notes or context about the pull request here.

---

Please refer to the [CONTRIBUTING.md](../CONTRIBUTING.md) file for more
information on how to contribute to this project.
kamilprz pushed a commit to kamilprz/retina that referenced this issue Jan 13, 2025
@SRodi @kamilprz
chore(docs): Add doc for Hubble control plane and metrics (microsoft#…
4deb1bf 
…1194)

# Description

Initial PR to add documentation for Hubble control plane and metrics.

## Related Issue

microsoft#1055 
microsoft#1093

## Checklist

- [x] I have read the [contributing
documentation](https://retina.sh/docs/contributing).
- [x] I signed and signed-off the commits (`git commit -S -s ...`). See
[this
documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)
on signing commits.
- [x] I have correctly attributed the author(s) of the code.
- [x] I have tested the changes locally.
- [x] I have followed the project's style guidelines.
- [x] I have updated the documentation, if necessary.
- [x] I have added tests, if applicable.

## Screenshots (if applicable) or Testing Completed

![image](https://github.com/user-attachments/assets/eafb42b9-795d-42d6-86cf-a9271eaaea4c)


![image](https://github.com/user-attachments/assets/f491ce0e-4456-4190-bb54-7dfa64f7b626)


![image](https://github.com/user-attachments/assets/eab86779-ed75-4d94-877d-e6f48213e865)


![image](https://github.com/user-attachments/assets/d82cc71d-3d74-427d-8e91-e7c1c4b495d9)


Please add any relevant screenshots or GIFs to showcase the changes
made.

## Additional Notes

Add any additional notes or context about the pull request here.

---

Please refer to the [CONTRIBUTING.md](../CONTRIBUTING.md) file for more
information on how to contribute to this project.
@SRodi SRodi self-assigned this Jan 15, 2025
@SRodi
Copy link
Member Author

SRodi commented Jan 15, 2025

@DeeBi9 some initial doc update to mention Hubble metrics was added as part of #1194 - link to docs: https://retina.sh/docs/Metrics/metrics-intro we are actively working on the docs, so please keep an eye out for it.

I am closing this issue but please feel free to ask any questions in our discussion section or to open another issue if necessary!

@SRodi SRodi closed this as completed Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@SRodi SRodi

Labels
area/documentation Improvements or additions to documentation meta/invalid This doesn't seem right
Projects
Retina Triage Board
Archived in project
Milestone
No milestone
Development

No branches or pull requests
2 participants
@SRodi @DeeBi9