http

Documentation

Index

• func AddTracingToClient(client *http.Client, options ...Option) *http.Client
• func WrapClient(client *http.Client) *http.Client
• type Option
  • func WithCustomTag(key string, value any) Option
  • func WithRequestIgnorer(requestIgnorer RequestIgnorer) Option
  • func WithResourceNamer(resourceNamer ResourceNamer) Option
  • func WithServiceName(serviceName string) Option
• type RequestIgnorer
• type ResourceNamer
  • func FullURLResourceNamer() ResourceNamer
  • func FullURLWithParamsResourceNamer() ResourceNamer
  • func HostResourceNamer() ResourceNamer
  • func StaticResourceNamer(str string) ResourceNamer

Examples

• AddTracingToClient

Functions

func AddTracingToClient

func AddTracingToClient(client *http.Client, options ...Option) *http.Client

AddTracingToClient wraps the net/http.Client to automatically create child-spans, and append to HTTP Headers.

Example

package main

import (
	"context"
	"net/http"
	"time"

	datadogMiddleware "github.com/coopnorge/go-datadog-lib/v2/middleware/http"
	"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
)

func main() {
	ctx := context.Background()

	client := &http.Client{
		Timeout: 10 * time.Second,
	}
	client = datadogMiddleware.AddTracingToClient(client)

	span, ctx := tracer.StartSpanFromContext(ctx, "http.request")
	defer span.Finish()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://example.com", nil)
	if err != nil {
		span.Finish(tracer.WithError(err))
		panic(err)
	}
	resp, err := client.Do(req)
	if err != nil {
		span.Finish(tracer.WithError(err))
		panic(err)
	}
	println(resp)
}

func WrapClient

func WrapClient(client *http.Client) *http.Client

WrapClient wraps the net/http.Client to automatically create child-spans, and append to HTTP Headers.

Deprecated: Use AddTracingToClient instead, and set a proper ResourceNamer. This function will be removed in a later version.

Types

type Option

type Option func(cfg *config)

Option allows for overriding our default-config.

func WithCustomTag

func WithCustomTag(key string, value any) Option

WithCustomTag will attach the value to the span tagged by the key.

func WithRequestIgnorer

func WithRequestIgnorer(requestIgnorer RequestIgnorer) Option

WithRequestIgnorer specifies a function that will be called to determined if the request should be traced or not.

func WithResourceNamer

func WithResourceNamer(resourceNamer ResourceNamer) Option

WithResourceNamer specifies a function that will be called to determine what the ResourceName of the span should be. For example, in the span "http.client https://coop.no/", the ResourceName is "https://coop.no/"

func WithServiceName

func WithServiceName(serviceName string) Option

WithServiceName overrides the service-name set in environment-variable "DD_SERVICE".

type RequestIgnorer

type RequestIgnorer func(req *http.Request) bool

RequestIgnorer is a function that will be called to determine if the request should be traced or not.

type ResourceNamer

type ResourceNamer func(req *http.Request) string

ResourceNamer is a function that will be called to determine what the ResourceName of the span should be.

func FullURLResourceNamer

func FullURLResourceNamer() ResourceNamer

FullURLResourceNamer will name the ResourceName to "GET https://www.coop.no/api/some-service/some-endpoint" NOTE! This might leak unintended user-ids, if they are part of the URL-path.

func FullURLWithParamsResourceNamer

func FullURLWithParamsResourceNamer() ResourceNamer

FullURLWithParamsResourceNamer will name the ResourceName to "GET https://www.coop.no/api/some-service/some-endpoint?foo=bar" NOTE! This might leak unintended user-ids, credentials, or other things that are part of a URL.

func HostResourceNamer

func HostResourceNamer() ResourceNamer

HostResourceNamer will name the ResourceName to "www.coop.no"

func StaticResourceNamer

func StaticResourceNamer(str string) ResourceNamer

StaticResourceNamer will set every span's ResourceName to str.