The highest tagged major version is
README
¶
id: otelfiber title: Otelfiber
OpenTelemetry support for Fiber.
Can be found on OpenTelemetry Registry.
Install
This middleware supports Fiber v2.
go get -u github.com/gofiber/contrib/otelfiber
Signature
otelfiber.Middleware(opts ...Option) fiber.Handler
Config
| Property | Type | Description | Default |
|---|---|---|---|
| Next | func(*fiber.Ctx) bool |
Define a function to skip this middleware when returned trueRequired - Rego quer | nil |
| TracerProvider | oteltrace.TracerProvider |
Specifies a tracer provider to use for creating a tracer | nil - the global tracer provider is used |
| MeterProvider | otelmetric.MeterProvider |
Specifies a meter provider to use for reporting | nil - the global meter provider is used |
| Port | *int |
Specifies the value to use when setting the net.host.port attribute on metrics/spans |
Required: If not default (80 for http, 443 for https) |
| Propagators | propagation.TextMapPropagator |
Specifies propagators to use for extracting information from the HTTP requests | If none are specified, global ones will be used |
| ServerName | *string |
specifies the value to use when setting the http.server_name attribute on metrics/spans |
- |
| SpanNameFormatter | func(*fiber.Ctx) string |
Takes a function that will be called on every request and the returned string will become the Span Name | default formatter returns the route pathRaw |
Usage
Please refer to example
Example
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"
}
Documentation
¶
Overview ¶
Package otelfiber instruments the github.com/gofiber/fiber package. (https://github.com/gofiber/fiber).
Currently, only the routing of a received message can be instrumented. To do so, use the Middleware function.
Index ¶
- Constants
- func Middleware(opts ...Option) fiber.Handler
- type Option
- func WithMeterProvider(provider otelmetric.MeterProvider) Option
- func WithNext(f func(ctx *fiber.Ctx) bool) Option
- func WithPort(port int) Option
- func WithPropagators(propagators propagation.TextMapPropagator) Option
- func WithServerName(serverName string) Option
- func WithSpanNameFormatter(f func(ctx *fiber.Ctx) string) Option
- func WithTracerProvider(provider oteltrace.TracerProvider) Option
Constants ¶
const ( // Unit constants for deprecated metric units UnitDimensionless = "1" UnitBytes = "By" UnitMilliseconds = "ms" )
Variables ¶
This section is empty.
Functions ¶
func Middleware ¶
func Middleware(opts ...Option) fiber.Handler
Middleware returns fiber handler which will trace incoming requests.
Types ¶
type Option ¶
type Option interface {
// contains filtered or unexported methods
}
Option specifies instrumentation configuration options.
func WithMeterProvider ¶
func WithMeterProvider(provider otelmetric.MeterProvider) Option
WithMeterProvider specifies a meter provider to use for reporting. If none is specified, the global provider is used.
func WithNext ¶ added in v1.0.9
WithNext takes a function that will be called on every request, the middleware will be skipped if returning true
func WithPort ¶
WithPort specifies the value to use when setting the `net.host.port` attribute on metrics/spans. Attribute is "Conditionally Required: If not default (`80` for `http`, `443` for `https`).
func WithPropagators ¶
func WithPropagators(propagators propagation.TextMapPropagator) Option
WithPropagators specifies propagators to use for extracting information from the HTTP requests. If none are specified, global ones will be used.
func WithServerName ¶
WithServerName specifies the value to use when setting the `http.server_name` attribute on metrics/spans.
func WithSpanNameFormatter ¶
WithSpanNameFormatter takes a function that will be called on every request and the returned string will become the Span Name
func WithTracerProvider ¶
func WithTracerProvider(provider oteltrace.TracerProvider) Option
WithTracerProvider specifies a tracer provider to use for creating a tracer. If none is specified, the global provider is used.
Source Files
Directories