Otelfiber

对 Fiber 的 OpenTelemetry 支持。

可以在 OpenTelemetry 注册表上找到。

注意：需要 Go 1.19 及以上版本

安装

此中间件支持 Fiber v2。

go get -u github.com/gofiber/contrib/otelfiber/v2

签名

otelfiber.Middleware(opts ...otelfiber.Option) fiber.Handler

配置

您可以使用函数参数配置中间件

函数	参数类型	描述	默认值
WithNext	func(*fiber.Ctx) bool	定义一个函数，当返回 true 时跳过此中间件。	nil
WithTracerProvider	oteltrace.TracerProvider	指定用于创建跟踪器的跟踪器提供程序。	nil - 使用全局跟踪器提供程序
WithMeterProvider	otelmetric.MeterProvider	指定用于报告的测量提供程序。	nil - 使用全局测量提供程序
WithPort	int	指定在 metrics/spans 上设置 net.host.port 属性时使用的值。	默认为 (http 对应 80, https 对应 443)
WithPropagators	propagation.TextMapPropagator	指定用于从 HTTP 请求中提取信息的传播器。	如果未指定，将使用全局传播器
WithServerName	string	指定在 metrics/spans 上设置 http.server_name 属性时使用的值。	-
WithSpanNameFormatter	func(*fiber.Ctx) string	接受一个函数，该函数将在每个请求上调用，返回的字符串将成为 span 名称。	默认格式化程序返回路由 pathRaw
WithCustomAttributes	func(*fiber.Ctx) []attribute.KeyValue	定义一个函数，用于向 span 添加自定义属性。	nil
WithCustomMetricAttributes	func(*fiber.Ctx) []attribute.KeyValue	定义一个函数，用于向 metrics 添加自定义属性。	nil
WithCollectClientIP	bool	指定是否从请求中收集客户端的 IP 地址。	true

用法

请参阅 示例

示例

package main

import (
	"context"
	"errors"
	"log"

	"go.opentelemetry.io/otel/sdk/resource"

	"github.com/gofiber/fiber/v2"

	"github.com/gofiber/contrib/otelfiber"
	"go.opentelemetry.io/otel"
	"go.opentelemetry.io/otel/attribute"
	stdout "go.opentelemetry.io/otel/exporters/stdout/stdouttrace"

	//"go.opentelemetry.io/otel/exporters/jaeger"
	"go.opentelemetry.io/otel/propagation"
	sdktrace "go.opentelemetry.io/otel/sdk/trace"
	semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
	oteltrace "go.opentelemetry.io/otel/trace"
)

var tracer = otel.Tracer("fiber-server")

func main() {
	tp := initTracer()
	defer func() {
		if err := tp.Shutdown(context.Background()); err != nil {
			log.Printf("Error shutting down tracer provider: %v", err)
		}
	}()

	app := fiber.New()

	app.Use(otelfiber.Middleware())

	app.Get("/error", func(ctx *fiber.Ctx) error {
		return errors.New("abc")
	})

	app.Get("/users/:id", func(c *fiber.Ctx) error {
		id := c.Params("id")
		name := getUser(c.UserContext(), id)
		return c.JSON(fiber.Map{"id": id, name: name})
	})

	log.Fatal(app.Listen(":3000"))
}

func initTracer() *sdktrace.TracerProvider {
	exporter, err := stdout.New(stdout.WithPrettyPrint())
	if err != nil {
		log.Fatal(err)
	}
	tp := sdktrace.NewTracerProvider(
		sdktrace.WithSampler(sdktrace.AlwaysSample()),
		sdktrace.WithBatcher(exporter),
		sdktrace.WithResource(
			resource.NewWithAttributes(
				semconv.SchemaURL,
				semconv.ServiceNameKey.String("my-service"),
			)),
	)
	otel.SetTracerProvider(tp)
	otel.SetTextMapPropagator(propagation.NewCompositeTextMapPropagator(propagation.TraceContext{}, propagation.Baggage{}))
	return tp
}

func getUser(ctx context.Context, id string) string {
	_, span := tracer.Start(ctx, "getUser", oteltrace.WithAttributes(attribute.String("id", id)))
	defer span.End()
	if id == "123" {
		return "otelfiber tester"
	}
	return "unknown"
}