Otelfiber
Fiber용 OpenTelemetry 지원.
OpenTelemetry Registry에서 찾을 수 있습니다.
참고: Go 1.19 이상이 필요합니다
Installation
이 미들웨어는 Fiber v2를 지원합니다.
go get -u github.com/gofiber/contrib/otelfiber/v2
Signatures
otelfiber.Middleware(opts ...otelfiber.Option) fiber.Handler
Config
기능 파라미터를 사용하여 미들웨어를 구성할 수 있습니다
WithNext
func(*fiber.Ctx) bool
true를 반환할 때 이 미들웨어를 건너뛰는 함수를 정의합니다.
nil
WithTracerProvider
oteltrace.TracerProvider
Tracer를 생성하는 데 사용할 tracer provider를 지정합니다.
nil - 전역 tracer provider가 사용됩니다
WithMeterProvider
otelmetric.MeterProvider
보고에 사용할 meter provider를 지정합니다.
nil - 전역 meter provider가 사용됩니다
WithPort
int
메트릭/스팬에 net.host.port
속성을 설정할 때 사용할 값을 지정합니다.
기본값 (http
는 80
, https
는 443
)
WithPropagators
propagation.TextMapPropagator
HTTP 요청에서 정보를 추출하는 데 사용할 전파자를 지정합니다.
지정되지 않으면 전역 전파자가 사용됩니다
WithServerName
string
메트릭/스팬에 http.server_name
속성을 설정할 때 사용할 값을 지정합니다.
-
WithSpanNameFormatter
func(*fiber.Ctx) string
모든 요청에서 호출되고 반환된 문자열이 스팬 이름이 되는 함수를 사용합니다.
기본 포맷터는 경로 원시 정보를 반환합니다
WithCustomAttributes
func(*fiber.Ctx) []attribute.KeyValue
스팬에 사용자 정의 속성을 추가하는 함수를 정의합니다.
nil
WithCollectClientIP
bool
요청에서 클라이언트의 IP 주소를 수집할지 여부를 지정합니다.
true
Usage
example을 참조하세요.
Examples
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("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"
}
Last updated