10000 [Docs] Monitoring of Kroxylicious on Kubernetes by k-wall · Pull Request #2256 · kroxylicious/kroxylicious · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
8000

[Docs] Monitoring of Kroxylicious on Kubernetes #2256

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 23 commits into from
Jun 13, 2025
Merged

[Docs] Monitoring of Kroxylicious on Kubernetes #2256

merged 23 commits into from
Jun 13, 2025

Conversation

k-wall
Copy link
Member
@k-wall k-wall commented Jun 2, 2025 •
edited
Loading

Type of change

Select the type of your PR

  • Documentation

Description

Documentation for the new metrics. The metrics need to be documented from the perspective direct use of the proxy, and use of the proxy via the operator.

Additional Context

Why are you making this pull request?

Checklist

Please go through this checklist and make sure all applicable tasks have been done

  • PR raised from a fork of this repository and made from a branch rather than main.
  • Write tests
  • Update documentation
  • Make sure all unit/integration tests pass
  • Make sure all Sonarcloud warnings are addressed or are justifiably ignored.
  • If applicable to the change, trigger the system test suite. Make sure tests pass.
  • If applicable to the change, trigger the performance test suite. Ensure that any degradations to performance numbers are understood and justified.
  • Ensure the PR references relevant issue(s) so they are closed on merging.
  • For user facing changes, update CHANGELOG.md (remember to include changes affecting the API of the test artefacts too).

NOTE: You must be a member of @kroxylicious/developers to trigger the system test and performance test suites. If you are not part of this group, comment on the PR requesting a trigger, tagging @kroxylicious/developers.

@k-wall k-wall added the documentation Improvements or additions to documentation label Jun 2, 2025
@k-wall k-wall force-pushed the wip-metrics-docs branch from fd63570 to d4f7ed2 Compare June 2, 2025 19:46
SamBarker
SamBarker reviewed Jun 3, 2025
View reviewed changes
Copy link
Member
@SamBarker SamBarker left a comment

Choose a reason for hiding this comment

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

Thanks for bootstrapping this @k-wall.

docs/assemblies/assembly-prometheus-metrics-proxy.adoc Outdated
// kroxylicious-operator/index.adoc

[id='assembly-prometheus-metrics-proxy-{context}']
= Proxy Metrics
Copy link
Member

Choose a reason for hiding this comment

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

Not necessarily part of this PR but I think it might be worth talking about how to get an aggregate view of the proxy process and a view of a whole virtual cluster. e.g. total network throughput and then throughput per virtual cluster. As they are likely to the high level questions people operating the proxy are likely to ask.

@k-wall k-wall force-pushed the wip-metrics-docs branch 2 times, most recently from 136e2a3 to 9a97cc0 Compare June 3, 2025 17:04
@robobario robobario added the essential Item considered essential for the near term label Jun 3, 2025
@k-wall k-wall added this to the 0.13.0 milestone Jun 4, 2025
@k-wall k-wall force-pushed the wip-metrics-docs branch from 3541a26 to c29d93d Compare June 5, 2025 15:20
ShubhamRwt
ShubhamRwt reviewed Jun 5, 2025
View reviewed changes
@ShubhamRwt
Copy link
Contributor

@k-wall Hi, Do we need to mentioned about deprecated metrics also?

@k-wall k-wall requested a review from PaulRMellor June 5, 2025 17:22
@ 8000 k-wall
Copy link
Member Author
k-wall commented Jun 5, 2025

@PaulRMellor FYI - just putting this on your radar.

@k-wall
Copy link
Member Author
k-wall commented Jun 5, 2025

@k-wall Hi, Do we need to mentioned about deprecated metrics also?

No, we don't do that.

tombentley
tombentley reviewed Jun 5, 2025
View reviewed changes
Copy link
Member
@tombentley tombentley left a comment

Choose a reason for hiding this comment

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

This is a great start.

docs/assemblies/assembly-prometheus-metrics-operator.adoc Outdated
The Java Operator SDK exposes metrics that allow its behaviour to be understood. These metrics
are enabled by default in the Kroxylicious Operator.

Refer to the {josdk-metrics}[Java Operator SDK metric documentation] to learn more about metrics.
Copy link
Member

Choose a reason for hiding this comment

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

This isn't sufficient on its own, is it? Don't we need to say there the scrape endpoint is, for example?

Copy link
Member Author

Choose a reason for hiding this comment

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

I've covered that in con-proxy-ingesting-metrics.adoc (when running proxy on baremetal) and con-operator-ingesting-metric (when running proxy using the operator).

@k-wall k-wall marked this pull request as ready for review June 5, 2025 23:29
@k-wall k-wall requested a review from a team as a code owner June 5, 2025 23:29
k-wall
k-wall commented Jun 5, 2025
View reviewed changes
k-wall
k-wall commented Jun 5, 2025
View reviewed changes
k-wall
k-wall commented Jun 5, 2025
View reviewed changes
@k-wall k-wall changed the title Metrics docs Metrics/monitoring docs Jun 6, 2025
@k-wall k-wall force-pushed the wip-metrics-docs branch from 43c23a1 to 3a2d465 Compare June 9, 2025 12:45
@k-wall k-wall mentioned this pull request Jun 9, 2025
Open
@k-wall k-wall force-pushed the wip-metrics-docs branch 6 times, most recently from 0c7a58d to 222071e Compare June 9, 2025 15:05
PaulRMellor
PaulRMellor approved these changes Jun 13, 2025
View reviewed changes
Copy link
Contributor
@PaulRMellor PaulRMellor left a comment

Choose a reason for hiding this comment

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

Excellent, Keith. The procedures look clean, minimal, and easy to follow.
I've left a few more suggestions, mainly for layout and consistency

docs/assemblies/assembly-proxy-monitoring.adoc
include::../modules/monitoring/proc-proxy-introducing-metrics.adoc[leveloffset=+1]
include::../modules/monitoring/con-prometheus-metrics-proxy.adoc[leveloffset=+1]
include::../modules/monitoring/con-{guide}-ingesting-metrics.adoc[leveloffset=+1]
include::../modules/monitoring/con-{guide}-integrating-micrometer.adoc[leveloffset=+1]
Copy link
Contributor

Choose a reason for hiding this comment

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

This need excluding for downstream?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, but that applies to the whole proxy-guide. It is just the operator-guide that will be used downstream.

k-wall and others added 22 commits June 13, 2025 21:36
@k-wall
Document proxy and operator metrics.
0d00de7 
Separate monitoring when deploying the proxy standalone from when the proxy is deployed by the proxy.

Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall
new section describing how to ingest metrics when not on kubernetes
1e9b40a 
Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall
address review comments
ad5aecc 
Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall
address review comments
8288fb2 
Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall
correct podmonitor pod match labels to reflect the work of kroxylicio…
70bfde2 
…us#2276

Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall
addressing review feedback
9a62c93 
make assembly-prometheus-metrics-operator.adoc a concept file.

Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall @PaulRMellor
Apply suggestions from code review
0d10b6d 
Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com>
Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall
addressing review feedback
9cf5aa9 
Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall
assembly-proxy-monitoring: replace the bullets with a intrioduction
853dc3b 
Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall
make con-*-setting-log-level into a procedure
34915a2 
Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall
addressing review feedback
a89ea7d 
Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall
add intro to assembly-operator-monitoring.adoc like the one in assemb…
4fbd600 
…ly-proxy-monitoring.adoc

Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall
make use of "{guide}" token in new content
10fdbb9 
why: help us keep the structure of the proxy/operator in synch, where it makes sense.
Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall
fix conditional inclusion of the OLM section
2354c50 
Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall
complete TODO in OLM section
9fa2b33 
Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall
add message counter diagram
f09d407 
Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall @PaulRMellor
Apply suggestions from code review
92c4916 
Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com>
Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall
fix port name
32857de 
Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall
addressing review feedback
b6e613d 
Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall
refactor operator-setting-log-levels as concept and 3 procedures
5ab4bb7 
Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall
addressing review feedback
977978b 
Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall
refactor ingesting into procedures
e766d7b 
Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall k-wall force-pushed the wip-metrics-docs branch from 2a41a7e to 1345594 Compare June 13, 2025 20:36
@k-wall @PaulRMellor
Apply suggestions from code review
b7d6eec 
Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com>
Signed-off-by: Keith Wall <kwall@apache.org>
@k-wall k-wall force-pushed the wip-metrics-docs branch from 1345594 to b7d6eec Compare June 13, 2025 20:46
@k-wall k-wall enabled auto-merge (squash) June 13, 2025 20:48
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@k-wall k-wall merged commit 3fcb0e1 into kroxylicious:main Jun 13, 2025
5 checks passed
@k-wall k-wall deleted the wip-metrics-docs branch June 14, 2025 07:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tombentley tombentley tombentley approved these changes

@SamBarker SamBarker SamBarker left review comments

@ShubhamRwt ShubhamRwt ShubhamRwt left review comments

@PaulRMellor PaulRMellor PaulRMellor approved these changes

Assignees

@k-wall k-wall

@ShubhamRwt ShubhamRwt

Labels
documentation Improvements or additions to documentation essential Item considered essential for the near term
Projects
None yet
Milestone
0.13.0
Development

Successfully merging this pull request may close these issues.
6 participants
@k-wall @ShubhamRwt @SamBarker @tombentley @PaulRMellor @robobario
0