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

Add example for sync gauge in Go #4610

Merged
merged 4 commits into from
Jun 7, 2024
Merged

Add example for sync gauge in Go #4610

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
88ac0e9
add example for sync gauge in Go
bagmeg Jun 6, 2024
353d795
apply suggestions from PR review
bagmeg Jun 6, 2024
07242dc
Merge branch 'main' into add_sync_gauge_example
cartermp Jun 7, 2024
4b7c8ec
Merge branch 'main' into add_sync_gauge_example
cartermp Jun 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions content/en/docs/languages/go/instrumentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -534,6 +534,35 @@ func removeItem() {
}
```

### Using Gauges
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
### Using Gauges
### Using gauges

We use sentence case in titles.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for the feedback. I noticed that other titles like 'Using Histograms' also start with capital letters. Could you give me more detail on which part i should fix?


Gauges are used to measure non-additive values when changes occur.

For example, here's how you might report the current speed of a CPU fan:

```go
import (
"net/http"

"go.opentelemetry.io/otel/metric"
)

func init() {
speedGauge, err := meter.Int64Gauge(
"cpu.fan.speed",
metric.WithDescription("Speed of CPU fan"),
metric.WithUnit("RPM"),
)
if err != nil {
panic(err)
}
http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
// hard-code 1500 RPM for demonstrative purposes
speedGauge.Record(r.Context(), 1500)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
speedGauge.Record(r.Context(), 1500)
// hard-code 1500 RPM for demonstrative purposes
speedGauge.Record(r.Context(), 1500)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the suggestion. Applied and pushed.

})
}
```

### Using Histograms

Histograms are used to measure a distribution of values over time.
Expand Down