feat: add metrics option and prometheus handler wraps

.github/workflows/ci-main.yml

@@ -199,16 +199,16 @@ jobs:
       uses: actions/checkout@v4
 
     - name: Start Apollo Containers
-      run:  docker-compose -f ".github/workflows/apollo/docker-compose.yml" up -d --build
+      run:  docker compose -f ".github/workflows/apollo/docker-compose.yml" up -d --build
 
     - name: Start Nacos Containers
-      run:  docker-compose -f ".github/workflows/nacos/docker-compose.yml" up -d --build
+      run:  docker compose -f ".github/workflows/nacos/docker-compose.yml" up -d --build
 
     - name: Start Redis Cluster Containers
-      run:  docker-compose -f ".github/workflows/redis/docker-compose.yml" up -d --build
+      run:  docker compose -f ".github/workflows/redis/docker-compose.yml" up -d --build
 
     - name: Start Consul Containers
-      run:  docker-compose -f ".github/workflows/consul/docker-compose.yml" up -d --build
+      run:  docker compose -f ".github/workflows/consul/docker-compose.yml" up -d --build
 
     - name: Setup Golang ${{ matrix.go-version }}
       uses: actions/setup-go@v5
@@ -228,16 +228,16 @@ jobs:
       run: bash .github/workflows/ci-main.sh coverage
 
     - name: Stop Redis Cluster Containers
-      run:  docker-compose -f ".github/workflows/redis/docker-compose.yml" down
+      run:  docker compose -f ".github/workflows/redis/docker-compose.yml" down
 
     - name: Stop Apollo Containers
-      run:  docker-compose -f ".github/workflows/apollo/docker-compose.yml" down
+      run:  docker compose -f ".github/workflows/apollo/docker-compose.yml" down
 
     - name: Stop Nacos Containers
-      run:  docker-compose -f ".github/workflows/nacos/docker-compose.yml" down
+      run:  docker compose -f ".github/workflows/nacos/docker-compose.yml" down
 
     - name: Stop Consul Containers
-      run:  docker-compose -f ".github/workflows/consul/docker-compose.yml" down
+      run:  docker compose -f ".github/workflows/consul/docker-compose.yml" down
 
     - name: Report Coverage
       uses: codecov/codecov-action@v4

cmd/gf/go.mod

@@ -3,13 +3,13 @@ module github.com/gogf/gf/cmd/gf/v2
 go 1.18
 
 require (
-	github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.6.4
-	github.com/gogf/gf/contrib/drivers/mssql/v2 v2.6.4
-	github.com/gogf/gf/contrib/drivers/mysql/v2 v2.6.4
-	github.com/gogf/gf/contrib/drivers/oracle/v2 v2.6.4
-	github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.6.4
-	github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.6.4
-	github.com/gogf/gf/v2 v2.6.4
+	github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.7.0
+	github.com/gogf/gf/contrib/drivers/mssql/v2 v2.7.0
+	github.com/gogf/gf/contrib/drivers/mysql/v2 v2.7.0
+	github.com/gogf/gf/contrib/drivers/oracle/v2 v2.7.0
+	github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.7.0
+	github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.7.0
+	github.com/gogf/gf/v2 v2.7.0
 	github.com/gogf/selfupdate v0.0.0-20231215043001-5c48c528462f
 	github.com/olekukonko/tablewriter v0.0.5
 	golang.org/x/mod v0.9.0

cmd/gf/go.sum

@@ -38,20 +38,6 @@ github.com/go-ole/go-ole v1.2.6/go.mod h1:pprOEPIfldk/42T2oK7lQ4v4JSDwmV0As9GaiU
 github.com/go-sql-driver/mysql v1.4.0/go.mod h1:zAC/RDZ24gD3HViQzih4MyKcchzm+sOG5ZlKdlhCg5w=
 github.com/go-sql-driver/mysql v1.7.1 h1:lUIinVbN1DY0xBg0eMOzmmtGoHwWBbvnWubQUrtU8EI=
 github.com/go-sql-driver/mysql v1.7.1/go.mod h1:OXbVy3sEdcQ2Doequ6Z5BW6fXNQTmx+9S1MCJN5yJMI=
-github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.6.4 h1:ggkj93Ln7ULOyoDGIGaphkg/qV8zDDSbkFVn6EljjNQ=
-github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.6.4/go.mod h1:J7CWaKo4mIYv1BqfHFpTPAjs5Sm7eZrCjA2UMAfM98E=
-github.com/gogf/gf/contrib/drivers/mssql/v2 v2.6.4 h1:S22r+bWoSSESNJh/IT9tpbgDhmWltxztiQ5ONn75BRo=
-github.com/gogf/gf/contrib/drivers/mssql/v2 v2.6.4/go.mod h1:NFhR+wl4BF1W/ddH9hKXARL+g3nP+r1qeAgxqOl75bA=
-github.com/gogf/gf/contrib/drivers/mysql/v2 v2.6.4 h1:ScG3YcYMDEP/UrwNtwQPt2noySa5ZpoV7BxrwaeBaro=
-github.com/gogf/gf/contrib/drivers/mysql/v2 v2.6.4/go.mod h1:oFFE9u1zHkxVXk7ZkNipXQR9JFyDZDiixZy243ywhfQ=
-github.com/gogf/gf/contrib/drivers/oracle/v2 v2.6.4 h1:9bOuNKHZ/ZBNuuZT2Qc0V+ypkKI2k8ZkSwcnqH+ikEY=
-github.com/gogf/gf/contrib/drivers/oracle/v2 v2.6.4/go.mod h1:tK8W1hDZdwjfWh3GlNdYoBWLs6unfey2+XW8FFnWICM=
-github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.6.4 h1:a+zIohGG1mv+1/9lBb/C0coM+MbmPYOWKo2SL1tJhTU=
-github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.6.4/go.mod h1:I7TGm/kilpNGwT8h8Frc5vGWRLgn5Vn9ce2gIBHcfbg=
-github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.6.4 h1:eJYZCJIqybMV6oJY7J7clWTNqx0yzZI7CaUn31igBGc=
-github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.6.4/go.mod h1:3q/YKn6NL7KkUdT6nw93eM5d1QjmX/+b+CPiIm/aLiA=
-github.com/gogf/gf/v2 v2.6.4 h1:w7HXdH9mcTsn/aE13CkaDbRArmAL1KS3FuQqDi6u74Y=
-github.com/gogf/gf/v2 v2.6.4/go.mod h1:x2XONYcI4hRQ/4gMNbWHmZrNzSEIg20s2NULbzom5k0=
 github.com/gogf/selfupdate v0.0.0-20231215043001-5c48c528462f h1:7xfXR/BhG3JDqO1s45n65Oyx9t4E/UqDOXep6jXdLCM=
 github.com/gogf/selfupdate v0.0.0-20231215043001-5c48c528462f/go.mod h1:HnYoio6S7VaFJdryKcD/r9HgX+4QzYfr00XiXUo/xz0=
 github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q=

contrib/config/apollo/go.mod

@@ -4,7 +4,7 @@ go 1.18
 
 require (
 	github.com/apolloconfig/agollo/v4 v4.3.1
-	github.com/gogf/gf/v2 v2.6.4
+	github.com/gogf/gf/v2 v2.7.0
 )
 
 require (

contrib/config/consul/go.mod

@@ -3,7 +3,7 @@ module github.com/gogf/gf/contrib/config/consul/v2
 go 1.18
 
 require (
-	github.com/gogf/gf/v2 v2.6.4
+	github.com/gogf/gf/v2 v2.7.0
 	github.com/hashicorp/consul/api v1.24.0
 	github.com/hashicorp/go-cleanhttp v0.5.2
 )

contrib/config/kubecm/go.mod

@@ -3,7 +3,7 @@ module github.com/gogf/gf/contrib/config/kubecm/v2
 go 1.18
 
 require (
-	github.com/gogf/gf/v2 v2.6.4
+	github.com/gogf/gf/v2 v2.7.0
 	k8s.io/api v0.27.4
 	k8s.io/apimachinery v0.27.4
 	k8s.io/client-go v0.27.4

contrib/config/nacos/go.mod

@@ -3,7 +3,7 @@ module github.com/gogf/gf/contrib/config/nacos/v2
 go 1.18
 
 require (
-	github.com/gogf/gf/v2 v2.6.4
+	github.com/gogf/gf/v2 v2.7.0
 	github.com/nacos-group/nacos-sdk-go/v2 v2.2.5
 )
 

contrib/config/polaris/go.mod

@@ -3,7 +3,7 @@ module github.com/gogf/gf/contrib/config/polaris/v2
 go 1.18
 
 require (
-	github.com/gogf/gf/v2 v2.6.4
+	github.com/gogf/gf/v2 v2.7.0
 	github.com/polarismesh/polaris-go v1.5.5
 )
 

contrib/drivers/clickhouse/go.mod

@@ -4,7 +4,7 @@ go 1.18
 
 require (
 	github.com/ClickHouse/clickhouse-go/v2 v2.0.15
-	github.com/gogf/gf/v2 v2.6.4
+	github.com/gogf/gf/v2 v2.7.0
 	github.com/google/uuid v1.3.0
 	github.com/shopspring/decimal v1.3.1
 )

contrib/drivers/dm/go.mod

@@ -6,7 +6,7 @@ replace github.com/gogf/gf/v2 => ../../../
 
 require (
 	gitee.com/chunanyong/dm v1.8.12
-	github.com/gogf/gf/v2 v2.6.4
+	github.com/gogf/gf/v2 v2.7.0
 )
 
 require (

contrib/drivers/mssql/go.mod

@@ -4,7 +4,7 @@ go 1.18
 
 require (
 	github.com/denisenkom/go-mssqldb v0.12.3
-	github.com/gogf/gf/v2 v2.6.4
+	github.com/gogf/gf/v2 v2.7.0
 )
 
 require (

contrib/drivers/mysql/go.mod

@@ -4,7 +4,7 @@ go 1.18
 
 require (
 	github.com/go-sql-driver/mysql v1.7.1
-	github.com/gogf/gf/v2 v2.6.4
+	github.com/gogf/gf/v2 v2.7.0
 )
 
 require (

contrib/drivers/oracle/go.mod

@@ -3,7 +3,7 @@ module github.com/gogf/gf/contrib/drivers/oracle/v2
 go 1.18
 
 require (
-	github.com/gogf/gf/v2 v2.6.4
+	github.com/gogf/gf/v2 v2.7.0
 	github.com/sijms/go-ora/v2 v2.7.10
 )
 

contrib/drivers/pgsql/go.mod

@@ -3,7 +3,7 @@ module github.com/gogf/gf/contrib/drivers/pgsql/v2
 go 1.18
 
 require (
-	github.com/gogf/gf/v2 v2.6.4
+	github.com/gogf/gf/v2 v2.7.0
 	github.com/lib/pq v1.10.9
 )
 

contrib/drivers/sqlite/go.mod

@@ -4,7 +4,7 @@ go 1.18
 
 require (
 	github.com/glebarez/go-sqlite v1.21.2
-	github.com/gogf/gf/v2 v2.6.4
+	github.com/gogf/gf/v2 v2.7.0
 )
 
 require (

contrib/drivers/sqlitecgo/go.mod

@@ -3,8 +3,8 @@ module github.com/gogf/gf/contrib/drivers/sqlitecgo/v2
 go 1.18
 
 require (
-	github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.6.4
-	github.com/gogf/gf/v2 v2.6.4
+	github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.7.0
+	github.com/gogf/gf/v2 v2.7.0
 	github.com/mattn/go-sqlite3 v1.14.17
 )
 

contrib/metric/otelmetric/go.mod

@@ -3,7 +3,7 @@ module github.com/gogf/gf/contrib/metric/otelmetric/v2
 go 1.18
 
 require (
-	github.com/gogf/gf/v2 v2.6.1
+	github.com/gogf/gf/v2 v2.7.0
 	github.com/prometheus/client_golang v1.19.0
 	go.opentelemetry.io/contrib/instrumentation/runtime v0.49.0
 	go.opentelemetry.io/otel v1.24.0

contrib/metric/otelmetric/otelmetric.go

@@ -8,13 +8,11 @@
 package otelmetric
 
 import (
-	"go.opentelemetry.io/otel/sdk/metric"
-
 	"github.com/gogf/gf/v2/os/gmetric"
 )
 
 // NewProvider creates and returns a metrics provider.
-func NewProvider(option ...metric.Option) (gmetric.Provider, error) {
+func NewProvider(option ...Option) (gmetric.Provider, error) {
 	provider, err := newProvider(option...)
 	if err != nil {
 		return nil, err
@@ -24,7 +22,7 @@ func NewProvider(option ...metric.Option) (gmetric.Provider, error) {
 
 // MustProvider creates and returns a metrics provider.
 // It panics if any error occurs.
-func MustProvider(option ...metric.Option) gmetric.Provider {
+func MustProvider(option ...Option) gmetric.Provider {
 	provider, err := NewProvider(option...)
 	if err != nil {
 		panic(err)

contrib/metric/otelmetric/otelmetric_option.go

@@ -0,0 +1,108 @@
+// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
+//
+// This Source Code Form is subject to the terms of the MIT License.
+// If a copy of the MIT was not distributed with this file,
+// You can obtain one at https://github.com/gogf/gf.
+
+package otelmetric
+
+import (
+	"go.opentelemetry.io/otel/sdk/metric"
+	"go.opentelemetry.io/otel/sdk/resource"
+)
+
+// newProviderConfigByOptions returns a config configured with options.
+func newProviderConfigByOptions(options []Option) providerConfig {
+	conf := providerConfig{}
+	for _, o := range options {
+		conf = o.apply(conf)
+	}
+	return conf
+}
+
+// Option applies a configuration option value to a MeterProvider.
+type Option interface {
+	apply(providerConfig) providerConfig
+}
+
+// optionFunc applies a set of options to a config.
+type optionFunc func(providerConfig) providerConfig
+
+// apply returns a config with option(s) applied.
+func (o optionFunc) apply(conf providerConfig) providerConfig {
+	return o(conf)
+}
+
+// providerConfig is the configuration for Provider.
+type providerConfig struct {
+	viewOption            metric.Option
+	readerOption          metric.Option
+	resourceOption        metric.Option
+	enabledBuiltInMetrics bool
+}
+
+// IsBuiltInMetricsEnabled returns whether the builtin metrics is enabled.
+func (cfg providerConfig) IsBuiltInMetricsEnabled() bool {
+	return cfg.enabledBuiltInMetrics
+}
+
+// MetricOptions converts and returns the providerConfig as metrics options.
+func (cfg providerConfig) MetricOptions() []metric.Option {
+	var metricOptions = make([]metric.Option, 0)
+	if cfg.viewOption != nil {
+		metricOptions = append(metricOptions, cfg.viewOption)
+	}
+	if cfg.readerOption != nil {
+		metricOptions = append(metricOptions, cfg.readerOption)
+	}
+	if cfg.resourceOption != nil {
+		metricOptions = append(metricOptions, cfg.resourceOption)
+	}
+	return metricOptions
+}
+
+// WithBuiltInMetrics enables builtin metrics.
+func WithBuiltInMetrics() Option {
+	return optionFunc(func(cfg providerConfig) providerConfig {
+		cfg.enabledBuiltInMetrics = true
+		return cfg
+	})
+}
+
+// WithResource associates a Resource with a MeterProvider. This Resource
+// represents the entity producing telemetry and is associated with all Meters
+// the MeterProvider will create.
+func WithResource(res *resource.Resource) Option {
+	return optionFunc(func(cfg providerConfig) providerConfig {
+		cfg.resourceOption = metric.WithResource(res)
+		return cfg
+	})
+}
+
+// WithReader associates Reader r with a MeterProvider.
+//
+// By default, if this option is not used, the MeterProvider will perform no
+// operations; no data will be exported without a Reader.
+func WithReader(reader metric.Reader) Option {
+	return optionFunc(func(cfg providerConfig) providerConfig {
+		if reader == nil {
+			return cfg
+		}
+		cfg.readerOption = metric.WithReader(reader)
+		return cfg
+	})
+}
+
+// WithView associates views a MeterProvider.
+//
+// Views are appended to existing ones in a MeterProvider if this option is
+// used multiple times.
+//
+// By default, if this option is not used, the MeterProvider will use the
+// default view.
+func WithView(views ...metric.View) Option {
+	return optionFunc(func(cfg providerConfig) providerConfig {
+		cfg.viewOption = metric.WithView(views...)
+		return cfg
+	})
+}

contrib/metric/otelmetric/otelmetric_prometheus.go

@@ -0,0 +1,34 @@
+// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
+//
+// This Source Code Form is subject to the terms of the MIT License.
+// If a copy of the MIT was not distributed with this file,
+// You can obtain one at https://github.com/gogf/gf.
+
+package otelmetric
+
+import (
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/prometheus/client_golang/prometheus/collectors"
+	"github.com/prometheus/client_golang/prometheus/promhttp"
+
+	"github.com/gogf/gf/v2/frame/g"
+	"github.com/gogf/gf/v2/net/ghttp"
+)
+
+// PrometheusHandler returns the http handler for prometheus metrics exporting.
+func PrometheusHandler(r *ghttp.Request) {
+	// Remove all builtin metrics that are produced by prometheus client.
+	prometheus.Unregister(collectors.NewProcessCollector(collectors.ProcessCollectorOpts{}))
+	prometheus.Unregister(collectors.NewGoCollector())
+
+	handler := promhttp.HandlerFor(prometheus.DefaultGatherer, promhttp.HandlerOpts{})
+	handler.ServeHTTP(r.Response.Writer, r.Request)
+}
+
+// StartPrometheusMetricsServer starts running a http server for metrics exporting.
+func StartPrometheusMetricsServer(port int, path string) {
+	s := g.Server()
+	s.BindHandler(path, PrometheusHandler)
+	s.SetPort(port)
+	s.Run()
+}