This repository was archived by the owner on Jul 31, 2023. It is now read-only.
Add derived gauge example.#1110
Merged
rghetia merged 3 commits intocensus-instrumentation:devfrom Apr 16, 2019
Merged
Conversation
songy23
reviewed
Apr 16, 2019
examples/derived_gauges/README.md
Outdated
| Table of Contents | ||
| ================= | ||
| - [Summary](#summary) | ||
| - [Run the example.](#run-the-example) |
examples/derived_gauges/README.md
Outdated
| when the queue was consumed. It is represented using derived gauge float64. | ||
| This example shows how to use gauge metrics. The program records two gauges. | ||
|
|
||
| These metrics are read when exporter scrapes them. In these example prometheus exporter is used to |
examples/derived_gauges/README.md
Outdated
|
|
||
| Enter different value for number of items to queue and fetch the metrics using above url to see the variation in the metrics. | ||
|
|
||
| ## Run the example. |
examples/derived_gauges/README.md
Outdated
| metric.WithDescription("Instantaneous queue size"), | ||
| metric.WithUnit(metricdata.UnitDimensionless)) | ||
| if err != nil { | ||
| log.Fatalf("error creating queue size derived gauge, error%v\n", err) |
Contributor
There was a problem hiding this comment.
Nit: add a space between "error" and "%v"
examples/derived_gauges/README.md
Outdated
| metric.WithDescription("time elapsed since last time the queue was processed"), | ||
| metric.WithUnit(metricdata.UnitDimensionless)) | ||
| if err != nil { | ||
| log.Fatalf("error creating queue_seconds_since_processed_last derived gauge, error%v\n", err) |
examples/derived_gauges/README.md
Outdated
| ```go | ||
| err = queueSizeGauge.UpsertEntry(q.Size) | ||
| if err != nil { | ||
| log.Fatalf("error getting queue size derived gauge entry, error%v\n", err) |
examples/derived_gauges/README.md
Outdated
| ```go | ||
| err = elapsedSeconds.UpsertEntry(q.Elapsed) | ||
| if err != nil { | ||
| log.Fatalf("error getting queue_seconds_since_processed_last derived gauge entry, error%v\n", err) |
songy23
approved these changes
Apr 16, 2019
rakyll
reviewed
Apr 16, 2019
|
|
||
| // Command stats implements the stats Quick Start example from: | ||
| // https://opencensus.io/quickstart/go/metrics/ | ||
| // START entire |
Contributor
There was a problem hiding this comment.
Add a line, otherwise START entire will be a part of the godoc.
| "go.opencensus.io/metric/metricdata" | ||
| "go.opencensus.io/metric/metricproducer" | ||
| "net/http" | ||
| "os" |
Contributor
There was a problem hiding this comment.
Standard library imports should be in the first section.
Separate standard library imports from go.opencensus.io imports with a line.
Contributor
Author
There was a problem hiding this comment.
i relied on gofmt to catch this but it doesn't. fixed it.
| "strings" | ||
| ) | ||
|
|
||
| // This example demonstrates the use of derived gauges. It is a simple interactive program of consumer |
Contributor
There was a problem hiding this comment.
You can put this explanation as the package doc, so it is visible on godoc.
| size int | ||
| q []int | ||
| lastConsumed time.Time | ||
| mu sync.Mutex |
Contributor
There was a problem hiding this comment.
In Go, mutex is often declared right above the field the mutex is protecting.
Example:
type queue struct {
size int
lastConsumed time.Time
mu sync.Mutex // guards mutex
q []int
}
| fmt.Printf("queued %d items, queue size is %d\n", count, q.size) | ||
| } | ||
|
|
||
| func (q *queue) runConsumer(interval int, cQuit chan bool) { |
Contributor
There was a problem hiding this comment.
In Go, don't use int for duration. Use time.Duration instead. So the unit of the value is not ambiguous.
| fmt.Printf("queued %d items, queue size is %d\n", count, q.size) | ||
| } | ||
|
|
||
| func (q *queue) runConsumer(interval int, cQuit chan bool) { |
Contributor
There was a problem hiding this comment.
s/cQuit/quit
quit is a common variable name for closing channels.
|
|
||
| cQuit := make(chan bool) | ||
| defer func() { | ||
| cQuit <- true |
Contributor
There was a problem hiding this comment.
You don't need to send true, if you close channel that will be sufficient for the select.
Contributor
Author
|
@rakyll thanks for the review. I'll open another PR to fix all of them. |
rghetia
added a commit
to rghetia/opencensus-go
that referenced
this pull request
Apr 17, 2019
rghetia
added a commit
that referenced
this pull request
Apr 18, 2019
rghetia
added a commit
to rghetia/opencensus-go
that referenced
this pull request
Apr 25, 2019
* Add derived gauge example. * fix fmt error and unreachable code error. * fix typos.
rghetia
added a commit
to rghetia/opencensus-go
that referenced
this pull request
Apr 25, 2019
rghetia
added a commit
that referenced
this pull request
Apr 25, 2019
* Add derived gauge example. * fix fmt error and unreachable code error. * fix typos.
rghetia
added a commit
that referenced
this pull request
Apr 25, 2019
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
No description provided.