fix(docs): Make sure helm Grafana example works as expected. #3753
+7
−3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The problem with the grafana helm is that we don't have the profiling port exposed as part of the containerPorts of the container. So I had to reuse/abuse the gossip-tcp port in order to get it to be scraped. It also was using the wrong annotation of "pyroscope.grafana.com" instead of "profiles.grafana.com". Fixes grafana#3523
simonswine
added
backport release/v1.9
|
Hello @simonswine!
Please, if the current pull request addresses a bug fix, label it with the |
1 similar comment
|
Hello @simonswine!
Please, if the current pull request addresses a bug fix, label it with the |
simonswine
added
the
type/docs
|
This PR must be merged before a backport PR will be created. |
marcsanmi
approved these changes
Dec 10, 2024
| --set-string 'podAnnotations.profiles\.grafana\.com/memory\.scrape=true' \ | ||
| --set-string 'podAnnotations.profiles\.grafana\.com/memory\.port=9094' \ | ||
| --set-string 'podAnnotations.profiles\.grafana\.com/goroutine\.scrape=true' \ | ||
| --set-string 'podAnnotations.profiles\.grafana\.com/goroutine\.port=9094' |
There was a problem hiding this comment.
Nit: Instead of reusing the gossip-tcp port, do you think leveraging extraExposePorts from Grafana helm chart would work to properly expose the profiling port? I didn't try, but I believe it could be added via Helm command as:
--set extraExposePorts[0].name=profiling,extraExposePorts[0].port=6060,extraExposePorts[0].targetPort=6060There was a problem hiding this comment.
I am afraid that won't do it. extraExposePorts works on service level, we would need it on the container around here: https://github.com/grafana/helm-charts/blob/897c25093da0572716a7cd441e8d3c3dba064b98/charts/grafana/templates/_pod.tpl#L1081
I am planning of submitting something to that chart repo, but that will be a while until it comes through...
There was a problem hiding this comment.
There we go grafana/helm-charts#3472
simonswine
added a commit
to simonswine/helm-charts
that referenced
this pull request
Dec 10, 2024
In order to enable profiling using Grafana Alloy and Grafana Pyroscope currently you would need to abuse another container port or insert a dummy container to facitilitate profile collection. This is because a containerPort is matched with the annotations to enable profiling. As a workaround I am "abusing" the port :9094, as for the example I am working on it is unused. This change will make it possible to coexist with gossip-tcp and you would be able to enable profiling like this: ``` helm upgrade -n pyroscope-test --install grafana grafana/grafana \ --set env.GF_DIAGNOSTICS_PROFILING_ENABLED=true \ --set env.GF_DIAGNOSTICS_PROFILING_ADDR=0.0.0.0 \ --set env.GF_DIAGNOSTICS_PROFILING_PORT=6060 \ --set-string 'podAnnotations.profiles\.grafana\.com/cpu\.scrape=true' \ --set-string 'podAnnotations.profiles\.grafana\.com/cpu\.port=6060' \ --set-string 'podAnnotations.profiles\.grafana\.com/memory\.scrape=true' \ --set-string 'podAnnotations.profiles\.grafana\.com/memory\.port=6060' \ --set-string 'podAnnotations.profiles\.grafana\.com/goroutine\.scrape=true' \ --set-string 'podAnnotations.profiles\.grafana\.com/goroutine\.port=6060' ``` This is realted to grafana/pyroscope#3753 Signed-off-by: Christian Simon <[email protected]>
simonswine
added a commit
to simonswine/helm-charts
that referenced
this pull request
Dec 10, 2024
In order to enable profiling using Grafana Alloy and Grafana Pyroscope currently you would need to abuse another container port or insert a dummy container to facitilitate profile collection. This is because a containerPort is matched with the annotations to enable profiling. As a workaround I am "abusing" the port :9094, as for the example I am working on it is unused. This change will make it possible to coexist with gossip-tcp and you would be able to enable profiling like this: ``` helm upgrade -n pyroscope-test --install grafana grafana/grafana \ --set env.GF_DIAGNOSTICS_PROFILING_ENABLED=true \ --set env.GF_DIAGNOSTICS_PROFILING_ADDR=0.0.0.0 \ --set env.GF_DIAGNOSTICS_PROFILING_PORT=6060 \ --set-string 'podAnnotations.profiles\.grafana\.com/cpu\.scrape=true' \ --set-string 'podAnnotations.profiles\.grafana\.com/cpu\.port=6060' \ --set-string 'podAnnotations.profiles\.grafana\.com/memory\.scrape=true' \ --set-string 'podAnnotations.profiles\.grafana\.com/memory\.port=6060' \ --set-string 'podAnnotations.profiles\.grafana\.com/goroutine\.scrape=true' \ --set-string 'podAnnotations.profiles\.grafana\.com/goroutine\.port=6060' ``` This is realted to grafana/pyroscope#3753 Signed-off-by: Christian Simon <[email protected]>
github-actions bot
pushed a commit
that referenced
this pull request
Dec 10, 2024
The problem with the grafana helm is that we don't have the profiling port exposed as part of the containerPorts of the container. So I had to reuse/abuse the gossip-tcp port in order to get it to be scraped. It also was using the wrong annotation of "pyroscope.grafana.com" instead of "profiles.grafana.com". Fixes #3523 (cherry picked from commit 6045daa)
github-actions bot
pushed a commit
that referenced
this pull request
Dec 10, 2024
The problem with the grafana helm is that we don't have the profiling port exposed as part of the containerPorts of the container. So I had to reuse/abuse the gossip-tcp port in order to get it to be scraped. It also was using the wrong annotation of "pyroscope.grafana.com" instead of "profiles.grafana.com". Fixes #3523 (cherry picked from commit 6045daa)
simonswine
added a commit
that referenced
this pull request
Dec 10, 2024
…3754) The problem with the grafana helm is that we don't have the profiling port exposed as part of the containerPorts of the container. So I had to reuse/abuse the gossip-tcp port in order to get it to be scraped. It also was using the wrong annotation of "pyroscope.grafana.com" instead of "profiles.grafana.com". Fixes #3523 (cherry picked from commit 6045daa) Co-authored-by: Christian Simon <[email protected]>
simonswine
added a commit
that referenced
this pull request
Dec 10, 2024
…3755) The problem with the grafana helm is that we don't have the profiling port exposed as part of the containerPorts of the container. So I had to reuse/abuse the gossip-tcp port in order to get it to be scraped. It also was using the wrong annotation of "pyroscope.grafana.com" instead of "profiles.grafana.com". Fixes #3523 (cherry picked from commit 6045daa) Co-authored-by: Christian Simon <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The problem with the grafana helm is that we don't have the profiling port exposed as part of the containerPorts of the container. So I had to reuse/abuse the gossip-tcp port in order to get it to be scraped.
It also was using the wrong annotation of "pyroscope.grafana.com" instead of "profiles.grafana.com".
Fixes #3523