Skip to main content
Version: 2.7.x(Latest)

基本介绍

框架内置了 Go 基础指标,默认情况下是关闭的,需要手动开启,可以通过创建 Provider 时通过 otelmetric.WithBuiltInMetrics() 参数开启。

package main

import (
"go.opentelemetry.io/otel/exporters/prometheus"

"github.com/gogf/gf/contrib/metric/otelmetric/v2"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/os/gctx"
"github.com/gogf/gf/v2/os/gmetric"
)

const (
instrument = "github.com/gogf/gf/example/metric/basic"
instrumentVersion = "v1.0"
)

var (
meter = gmetric.GetGlobalProvider().Meter(gmetric.MeterOption{
Instrument: instrument,
InstrumentVersion: instrumentVersion,
})
counter = meter.MustCounter(
"goframe.metric.demo.counter",
gmetric.MetricOption{
Help: "This is a simple demo for Counter usage",
Unit: "bytes",
},
)
)

func main() {
var ctx = gctx.New()

// Prometheus exporter to export metrics as Prometheus format.
exporter, err := prometheus.New(
prometheus.WithoutCounterSuffixes(),
prometheus.WithoutUnits(),
)
if err != nil {
g.Log().Fatal(ctx, err)
}

// OpenTelemetry provider.
provider := otelmetric.MustProvider(
otelmetric.WithReader(exporter),
otelmetric.WithBuiltInMetrics(),
)
provider.SetAsGlobal()
defer provider.Shutdown(ctx)

// Counter.
counter.Inc(ctx)
counter.Add(ctx, 10)

// HTTP Server for metrics exporting.
otelmetric.StartPrometheusMetricsServer(8000, "/metrics")
}

执行后,访问 http://127.0.0.1:8000/metrics 查看结果。

内置指标说明

指标名称指标类型指标单位指标描述
process.runtime.go.cgo.callsCounter当前进程调用的 cgo 次数。
process.runtime.go.gc.countCounter已完成的 gc 周期的次数。
process.runtime.go.gc.pause_nsHistogramnsGC stop-the-world 中暂停的纳秒数量。
process.runtime.go.gc.pause_total_nsCounterns自程序启动以来, GC stop-the-world 的累计微秒计数。
process.runtime.go.goroutinesGauge当前运行的协程数量。
process.runtime.go.lookupsCounter运行时执行的指针查询的数量。
process.runtime.go.mem.heap_allocGaugebytes分配的堆对象的字节数。
process.runtime.go.mem.heap_idleGaugebytes空闲(未使用)的堆内存。
process.runtime.go.mem.heap_inuseGaugebytes已使用的堆内存。
process.runtime.go.mem.heap_objectsGauge已分配的堆对象数量。
process.runtime.go.mem.live_objectsGauge存活对象数量( Mallocs - Frees)
process.runtime.go.mem.heap_releasedGaugebytes已交还给操作系统的堆内存。
process.runtime.go.mem.heap_sysGaugebytes从操作系统获得的堆内存。
process.runtime.uptimeCounterms自应用程序被初始化以来的毫秒数。