Documentation
¶
Overview ¶
Package echo provides functions to trace the labstack/echo package (https://github.com/labstack/echo).
Example ¶
To start tracing requests, add the trace middleware to your echo router.
r := echo.New()
// Use the tracer middleware with your desired service name.
r.Use(Middleware(WithServiceName("my-web-app")))
// Set up an endpoint.
r.GET("/hello", func(c echo.Context) error {
return c.String(200, "hello world!")
})
// ...and listen for incoming requests
r.Start(":8080")
Output:
Example (SpanFromContext) ¶
An example illustrating tracing a child operation within the main context.
// Create a new instance of echo
r := echo.New()
// Use the tracer middleware with your desired service name.
r.Use(Middleware(WithServiceName("image-encoder")))
// Set up some endpoints.
r.GET("/image/encode", func(c echo.Context) error {
// create a child span to track an operation
span, _ := tracer.StartSpanFromContext(c.Request().Context(), "image.encode")
// encode an image ...
// finish the child span
span.Finish()
return c.String(200, "ok!")
})
Output:
Index ¶
- func Middleware(opts ...Option) echo.MiddlewareFunc
- type IgnoreRequestFunc
- type Option
- func NoDebugStack() Option
- func WithAnalytics(on bool) Option
- func WithAnalyticsRate(rate float64) Option
- func WithCustomTag(key string, value interface{}) Option
- func WithErrorCheck(errCheck func(error) bool) Option
- func WithErrorTranslator(fn func(err error) (*echo.HTTPError, bool)) Option
- func WithHeaderTags(headers []string) Option
- func WithIgnoreRequest(ignoreRequestFunc IgnoreRequestFunc) Option
- func WithServiceName(name string) Option
- func WithStatusCheck(fn func(statusCode int) bool) Option
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Middleware ¶
func Middleware(opts ...Option) echo.MiddlewareFunc
Middleware returns echo middleware which will trace incoming requests.
Types ¶
type IgnoreRequestFunc ¶
type IgnoreRequestFunc func(c echo.Context) bool
IgnoreRequestFunc determines if tracing will be skipped for a request.
type Option ¶
type Option func(*config)
Option represents an option that can be passed to Middleware.
func NoDebugStack ¶
func NoDebugStack() Option
NoDebugStack prevents stack traces from being attached to spans finishing with an error. This is useful in situations where errors are frequent and performance is critical.
func WithAnalytics ¶
WithAnalytics enables Trace Analytics for all started spans.
func WithAnalyticsRate ¶
WithAnalyticsRate sets the sampling rate for Trace Analytics events correlated to started spans.
func WithCustomTag ¶
WithCustomTag will attach the value to the span tagged by the key. Standard span tags cannot be replaced.
func WithErrorCheck ¶
WithErrorCheck sets the func which determines if err would be ignored (if it returns true, the error is not tagged). This function also checks the errors created from the WithStatusCheck option.
func WithErrorTranslator ¶
WithErrorTranslator sets a function to translate Go errors into echo Errors. This is used for extracting the HTTP response status code.
func WithHeaderTags ¶
WithHeaderTags enables the integration to attach HTTP request headers as span tags. Warning: Using this feature can risk exposing sensitive data such as authorization tokens to Datadog. Special headers can not be sub-selected. E.g., an entire Cookie header would be transmitted, without the ability to choose specific Cookies.
func WithIgnoreRequest ¶
func WithIgnoreRequest(ignoreRequestFunc IgnoreRequestFunc) Option
WithIgnoreRequest sets a function which determines if tracing will be skipped for a given request.
func WithServiceName ¶
WithServiceName sets the given service name for the system.
func WithStatusCheck ¶
WithStatusCheck specifies a function fn which reports whether the passed statusCode should be considered an error.
Source Files