2022-03-02 17:50:29 +02:00
|
|
|
// Copyright The OpenTelemetry Authors
|
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
// You may obtain a copy of the License at
|
|
|
|
//
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
//
|
|
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
// limitations under the License.
|
|
|
|
|
|
|
|
package metric_test
|
|
|
|
|
|
|
|
import (
|
|
|
|
"context"
|
|
|
|
"fmt"
|
|
|
|
"runtime"
|
|
|
|
"time"
|
|
|
|
|
2022-04-28 21:52:10 +02:00
|
|
|
"go.opentelemetry.io/otel/metric"
|
2022-03-02 17:50:29 +02:00
|
|
|
"go.opentelemetry.io/otel/metric/instrument"
|
|
|
|
"go.opentelemetry.io/otel/metric/instrument/syncfloat64"
|
|
|
|
"go.opentelemetry.io/otel/metric/unit"
|
|
|
|
)
|
|
|
|
|
|
|
|
//nolint:govet // Meter doesn't register for go vet
|
|
|
|
func ExampleMeter_synchronous() {
|
|
|
|
// In a library or program this would be provided by otel.GetMeterProvider().
|
2022-04-28 21:52:10 +02:00
|
|
|
meterProvider := metric.NewNoopMeterProvider()
|
2022-03-02 17:50:29 +02:00
|
|
|
|
2023-01-03 20:34:10 +02:00
|
|
|
workDuration, err := meterProvider.Meter("go.opentelemetry.io/otel/metric#SyncExample").Int64Histogram(
|
2022-03-02 17:50:29 +02:00
|
|
|
"workDuration",
|
|
|
|
instrument.WithUnit(unit.Milliseconds))
|
|
|
|
if err != nil {
|
|
|
|
fmt.Println("Failed to register instrument")
|
|
|
|
panic(err)
|
|
|
|
}
|
|
|
|
|
|
|
|
startTime := time.Now()
|
|
|
|
ctx := context.Background()
|
|
|
|
// Do work
|
|
|
|
// ...
|
|
|
|
workDuration.Record(ctx, time.Since(startTime).Milliseconds())
|
|
|
|
}
|
|
|
|
|
|
|
|
//nolint:govet // Meter doesn't register for go vet
|
|
|
|
func ExampleMeter_asynchronous_single() {
|
|
|
|
// In a library or program this would be provided by otel.GetMeterProvider().
|
2022-04-28 21:52:10 +02:00
|
|
|
meterProvider := metric.NewNoopMeterProvider()
|
2022-03-02 17:50:29 +02:00
|
|
|
meter := meterProvider.Meter("go.opentelemetry.io/otel/metric#AsyncExample")
|
|
|
|
|
2023-01-03 20:34:10 +02:00
|
|
|
memoryUsage, err := meter.Int64ObservableGauge(
|
2022-03-02 17:50:29 +02:00
|
|
|
"MemoryUsage",
|
|
|
|
instrument.WithUnit(unit.Bytes),
|
|
|
|
)
|
|
|
|
if err != nil {
|
|
|
|
fmt.Println("Failed to register instrument")
|
|
|
|
panic(err)
|
|
|
|
}
|
|
|
|
|
2022-12-16 22:02:42 +02:00
|
|
|
_, err = meter.RegisterCallback([]instrument.Asynchronous{memoryUsage},
|
2023-01-08 17:53:07 +02:00
|
|
|
func(ctx context.Context) error {
|
2022-03-02 17:50:29 +02:00
|
|
|
// instrument.WithCallbackFunc(func(ctx context.Context) {
|
|
|
|
//Do Work to get the real memoryUsage
|
|
|
|
// mem := GatherMemory(ctx)
|
|
|
|
mem := 75000
|
|
|
|
|
|
|
|
memoryUsage.Observe(ctx, int64(mem))
|
2023-01-08 17:53:07 +02:00
|
|
|
return nil
|
2022-03-02 17:50:29 +02:00
|
|
|
})
|
|
|
|
if err != nil {
|
|
|
|
fmt.Println("Failed to register callback")
|
|
|
|
panic(err)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
//nolint:govet // Meter doesn't register for go vet
|
|
|
|
func ExampleMeter_asynchronous_multiple() {
|
2022-04-28 21:52:10 +02:00
|
|
|
meterProvider := metric.NewNoopMeterProvider()
|
2022-03-02 17:50:29 +02:00
|
|
|
meter := meterProvider.Meter("go.opentelemetry.io/otel/metric#MultiAsyncExample")
|
|
|
|
|
|
|
|
// This is just a sample of memory stats to record from the Memstats
|
2023-01-03 20:34:10 +02:00
|
|
|
heapAlloc, _ := meter.Int64ObservableUpDownCounter("heapAllocs")
|
|
|
|
gcCount, _ := meter.Int64ObservableCounter("gcCount")
|
|
|
|
gcPause, _ := meter.Float64Histogram("gcPause")
|
2022-03-02 17:50:29 +02:00
|
|
|
|
2022-12-16 22:02:42 +02:00
|
|
|
_, err := meter.RegisterCallback([]instrument.Asynchronous{
|
2022-03-02 17:50:29 +02:00
|
|
|
heapAlloc,
|
|
|
|
gcCount,
|
|
|
|
},
|
2023-01-08 17:53:07 +02:00
|
|
|
func(ctx context.Context) error {
|
2022-03-02 17:50:29 +02:00
|
|
|
memStats := &runtime.MemStats{}
|
|
|
|
// This call does work
|
|
|
|
runtime.ReadMemStats(memStats)
|
|
|
|
|
|
|
|
heapAlloc.Observe(ctx, int64(memStats.HeapAlloc))
|
|
|
|
gcCount.Observe(ctx, int64(memStats.NumGC))
|
|
|
|
|
|
|
|
// This function synchronously records the pauses
|
|
|
|
computeGCPauses(ctx, gcPause, memStats.PauseNs[:])
|
2023-01-08 17:53:07 +02:00
|
|
|
return nil
|
2022-03-02 17:50:29 +02:00
|
|
|
},
|
|
|
|
)
|
|
|
|
|
|
|
|
if err != nil {
|
|
|
|
fmt.Println("Failed to register callback")
|
|
|
|
panic(err)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-08-25 04:42:28 +02:00
|
|
|
// This is just an example, see the the contrib runtime instrumentation for real implementation.
|
2022-05-19 22:15:07 +02:00
|
|
|
func computeGCPauses(ctx context.Context, recorder syncfloat64.Histogram, pauseBuff []uint64) {}
|