-
Notifications
You must be signed in to change notification settings - Fork 1.1k
docs: fix stale explanation in instrumenting HTTP server tutorial #3074
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
Open
santhiprakash
wants to merge
1
commit into
prometheus:main
Choose a base branch
from
santhiprakash:fix-tutorial-stale-explanation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -84,9 +84,9 @@ func main() { | |
| } | ||
| ``` | ||
|
|
||
| The `prometheus.MustRegister` function registers the pingCounter with the default registry. | ||
| The `promauto.With(reg).NewCounter()` function creates the counter and registers it with the custom registry. | ||
| To expose the metrics, the Go Prometheus client library provides the promhttp package. | ||
| `promhttp.Handler()` provides an `http.Handler` which exposes the metrics registered in the default registry. | ||
| `promhttp.HandlerFor(reg, promhttp.HandlerOpts{})` provides an `http.Handler` which exposes the metrics registered in the given registry. | ||
|
|
||
| The sample code is now: | ||
|
|
||
|
|
@@ -111,7 +111,7 @@ func newMetrics(reg prometheus.Registerer) *metrics { | |
| pingCounter: promauto.With(reg).NewCounter( | ||
| prometheus.CounterOpts{ | ||
| Name: "ping_request_count", | ||
| Help: "No of request handled by Ping handler", | ||
| Help: "No of requests handled by Ping handler", | ||
| }), | ||
| } | ||
| return m | ||
|
|
@@ -147,7 +147,7 @@ Now hit the localhost:8090/ping endpoint a couple of times and then send a reque | |
|
|
||
| Here, the `ping_request_count` shows that the `/ping` endpoint was called 3 times. | ||
|
|
||
| The default registry comes with a collector for Go runtime metrics, and that is why we see other metrics like `go_threads`, `go_goroutines`, etc. | ||
| The code above uses a custom registry (`prometheus.NewRegistry()`), which does not include Go runtime metrics by default. To also collect Go runtime metrics, register `prometheus.NewGoCollector()` with the registry. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Instead use |
||
|
|
||
| We have built our first metric exporter. Let’s update our Prometheus config to scrape the metrics from our server. | ||
|
|
||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: Now the image further down is no longer in sync. Ideally this PR updates the image as well or we leave this typo?