OpenTelemetry HTTP Instrumentation

https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp
Admin
OpenTelemetry HTTP Instrumentation (otelhttp) is a Go package that provides tracing and metrics...
Tokens:4,717
Snippets:93
Trust Score:9.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Inject Start Time into Context

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Returns a new context with a specified start time for metrics and traces.

```go
func ContextWithStartTime(parent context.Context, start time.Time) context.Context
```

--------------------------------

### Retrieve Start Time from Context

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Extracts the start time previously injected into the context.

```go
func StartTimeFromContext(ctx context.Context) time.Time
```

--------------------------------

### Run HTTP Client-Server Services

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/example

Starts the client and server containers in the background using docker-compose.

```bash
docker-compose up --detach http-server http-client
```

--------------------------------

### Shutdown Services

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/example

Stops and removes the containers created for the example.

```bash
docker-compose down
```

--------------------------------

### PathPrefix filter function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/filters

Matches requests where the path starts with the provided string prefix.

```go
func PathPrefix(p string) otelhttp.Filter
```

--------------------------------

### NewHTTPServer Constructor

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Creates a new HTTPServer instance.

```go
func NewHTTPServer(meter metric.Meter) HTTPServer
```

--------------------------------

### Initialize a new HTTPClient

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Creates a new HTTPClient instance using the provided OpenTelemetry meter.

```go
func NewHTTPClient(meter metric.Meter) HTTPClient
```

--------------------------------

### MetricOpts Methods

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Methods to retrieve metric options.

```go
func (o MetricOpts) AddOptions() metric.AddOption
```

```go
func (o MetricOpts) MeasurementOption() metric.MeasurementOption
```

--------------------------------

### MetricOpts Structure

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Options for metric configuration.

```go
type MetricOpts struct {
	// contains filtered or unexported fields
}
```

--------------------------------

### Configure Instrumentation Options

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Various functional options for configuring the otelhttp handler or transport.

```go
func WithClientTrace(f func(context.Context) *httptrace.ClientTrace) Option
```

```go
func WithFilter(f Filter) Option
```

```go
func WithMessageEvents(events ...Event) Option
```

```go
func WithMeterProvider(provider metric.MeterProvider) Option
```

```go
func WithMetricAttributesFn(metricAttributesFn func(r *http.Request) []attribute.KeyValue) Option
```

```go
func WithPropagators(ps propagation.TextMapPropagator) Option
```

```go
func WithPublicEndpointFn(fn func(*http.Request) bool) Option
```

```go
func WithServerName(server string) Option
```

```go
func WithSpanNameFormatter(f func(operation string, r *http.Request) string) Option
```

--------------------------------

### Initialize BodyWrapper

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/request

Creates a new BodyWrapper with a callback function triggered on each read operation.

```go
func NewBodyWrapper(body io.ReadCloser, onRead func(int64)) *BodyWrapper
```

--------------------------------

### Create metric options

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Generates metric options from the provided metric attributes.

```go
func (n HTTPClient) MetricOptions(ma MetricAttributes) MetricOpts
```

--------------------------------

### Create Instrumentation Middleware

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Returns a middleware function that wraps handlers with tracing and metrics instrumentation.

```go
func NewMiddleware(operation string, opts ...Option) func(http.Handler) http.Handler
```

--------------------------------

### Initialize RespWriterWrapper

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/request

Creates a new RespWriterWrapper with a callback function triggered on each write operation.

```go
func NewRespWriterWrapper(w http.ResponseWriter, onWrite func(int64)) *RespWriterWrapper
```

--------------------------------

### Option Interface

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Interface used for setting optional configuration properties.

```go
type Option interface {
	// contains filtered or unexported methods
}
```

--------------------------------

### Initialize New Transport

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Wraps an existing http.RoundTripper. Uses http.DefaultTransport if the provided base is nil.

```go
func NewTransport(base http.RoundTripper, opts ...Option) *Transport
```

--------------------------------

### Configure Span Options

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Applies additional trace.SpanOptions to each new span created by the instrumentation.

```go
func WithSpanOptions(opts ...trace.SpanStartOption) Option
```

--------------------------------

### Define Package Version

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

The constant defining the current release version of the otelhttp instrumentation.

```go
const Version = "0.69.0"
```

--------------------------------

### Record HTTP client metrics

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Records metrics for an HTTP client operation within the given context.

```go
func (n HTTPClient) RecordMetrics(ctx context.Context, md MetricData, opts MetricOpts)
```

--------------------------------

### HTTPServer Route

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Returns the attribute for the route.

```go
func (n HTTPServer) Route(route string) attribute.KeyValue
```

--------------------------------

### Retrieve Labeler from Context

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Retrieves a Labeler instance from the provided context if one is available.

```go
func LabelerFromContext(ctx context.Context) (*Labeler, bool)
```

--------------------------------

### Retrieve current module version

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/test

Returns the current release version of the otelhttp instrumentation test module.

```go
func Version() string
```

--------------------------------

### Define HTTPClient structure

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Represents the HTTP client semantic convention handler.

```go
type HTTPClient struct {
	// contains filtered or unexported fields
}
```

--------------------------------

### View Client Logs

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/example

Displays the stdout logs for the http-client service to inspect generated spans and metrics.

```bash
docker-compose logs http-client
```

--------------------------------

### Specify Tracer Provider

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Sets a custom tracer provider for creating tracers. Defaults to the global provider if not specified.

```go
func WithTracerProvider(provider trace.TracerProvider) Option
```

--------------------------------

### func Version()

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/test

Retrieves the current release version of the otelhttp instrumentation test module.

```APIDOC
## func Version()

### Description
Returns the current release version of the otelhttp instrumentation test module as a string.

### Signature
`func Version() string`

### Returns
- **string** - The version string.
```

--------------------------------

### WithSpanOptions

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Configures additional trace span options for the instrumentation.

```APIDOC
## func WithSpanOptions(opts ...trace.SpanStartOption) Option

### Description
Configures an additional set of trace.SpanOptions, which are applied to each new span created by the instrumentation.

### Parameters
- **opts** (...trace.SpanStartOption) - Required - The span start options to apply.
```

--------------------------------

### Retrieve semantic version

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/test

Returns the semantic version for tracer or meter creation. This function is deprecated; use Version instead.

```go
func SemVersion() string
```

--------------------------------

### HTTPServer RecordMetrics

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Records metrics for server telemetry data.

```go
func (n HTTPServer) RecordMetrics(ctx context.Context, md ServerMetricData)
```

--------------------------------

### ServerMetricData Structure

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Aggregated server metric data.

```go
type ServerMetricData struct {
	ServerName   string
	ResponseSize int64

	MetricData
	MetricAttributes
}
```

--------------------------------

### Wrap Handler with Instrumentation

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Wraps an http.Handler to add tracing and metrics based on the provided operation name.

```go
func NewHandler(handler http.Handler, operation string, opts ...Option) http.Handler
```

--------------------------------

### View Server Logs

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/example

Displays the stdout logs for the http-server service to inspect generated spans.

```bash
docker-compose logs http-server
```

--------------------------------

### HTTPServer Definition

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Structure for handling server-side HTTP semantic conventions.

```go
type HTTPServer struct {
	// contains filtered or unexported fields
}
```

--------------------------------

### Manage Labeler Attributes

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Methods to add or retrieve attributes from a Labeler.

```go
func (l *Labeler) Add(ls ...attribute.KeyValue)
```

```go
func (l *Labeler) Get() []attribute.KeyValue
```

--------------------------------

### MetricAttributes Structure

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Data structure for server metric attributes.

```go
type MetricAttributes struct {
	Req                  *http.Request
	StatusCode           int
	Route                string
	AdditionalAttributes []attribute.KeyValue
	Err                  error
}
```

--------------------------------

### Path filter function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/filters

Matches requests where the path matches the provided string exactly.

```go
func Path(p string) otelhttp.Filter
```

--------------------------------

### Execute RoundTrip

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Creates a span and propagates context via request headers. The span ends when the response body is closed or EOF is reached.

```go
func (t *Transport) RoundTrip(r *http.Request) (*http.Response, error)
```

--------------------------------

### HTTPClient TraceAttributes

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Returns attributes for httptrace.

```go
func (n HTTPClient) TraceAttributes(host string) []attribute.KeyValue
```

--------------------------------

### Hostname filter function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/filters

Matches requests where the hostname matches the provided string.

```go
func Hostname(h string) otelhttp.Filter
```

--------------------------------

### Inject Labeler into Context

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Returns a new context containing the provided Labeler instance for metric attribute injection.

```go
func ContextWithLabeler(parent context.Context, l *Labeler) context.Context
```

--------------------------------

### func NewMiddleware

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Returns a tracing and metrics instrumentation middleware that wraps a handler in a span.

```APIDOC
## func NewMiddleware(operation string, opts ...Option) func(http.Handler) http.Handler

### Description
Returns a tracing and metrics instrumentation middleware. The handler returned by the middleware wraps a handler in a span named after the operation and enriches it with metrics.

### Parameters
- **operation** (string) - Required - The name of the operation for the span.
- **opts** (...Option) - Optional - Configuration options for the instrumentation.
```

--------------------------------

### WithTracerProvider

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Specifies a custom tracer provider for the instrumentation.

```APIDOC
## func WithTracerProvider(provider trace.TracerProvider) Option

### Description
Specifies a tracer provider to use for creating a tracer. If none is specified, the global provider is used.

### Parameters
- **provider** (trace.TracerProvider) - Required - The tracer provider to use.
```

--------------------------------

### MetricData Structure

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Basic metric data containing request size and duration.

```go
type MetricData struct {
	RequestSize     int64
	RequestDuration time.Duration
}
```

--------------------------------

### func SemVersion()

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/test

Retrieves the semantic version for tracer/meter creation. This function is deprecated.

```APIDOC
## func SemVersion() (Deprecated)

### Description
Returns the semantic version to be supplied to tracer/meter creation. This function is deprecated; use Version() instead.

### Signature
`func SemVersion() string`

### Returns
- **string** - The semantic version string.
```

--------------------------------

### HTTPServer MetricAttributes

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Calculates metric attributes for an HTTP server request.

```go
func (n HTTPServer) MetricAttributes(server string, req *http.Request, statusCode int, route string, additionalAttributes []attribute.KeyValue) []attribute.KeyValue
```

--------------------------------

### RequestTraceAttrsOpts Structure

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Options for request trace attributes.

```go
type RequestTraceAttrsOpts struct {
	// If set, this is used as value for the "http.client_ip" attribute.
	HTTPClientIP string
}
```

--------------------------------

### Any filter function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/filters

Returns a filter that evaluates to true if any of the provided filters return true.

```go
func Any(fs ...otelhttp.Filter) otelhttp.Filter
```

--------------------------------

### Define Event Types

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Represents message event types for WithMessageEvents.

```go
type Event int
```

```go
const (
	ReadEvents Event
	WriteEvents
)
```

--------------------------------

### All filter function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/filters

Returns a filter that evaluates to true only if all provided filters return true.

```go
func All(fs ...otelhttp.Filter) otelhttp.Filter
```

--------------------------------

### Method filter function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/filters

Matches requests where the HTTP method matches the provided value.

```go
func Method(m string) otelhttp.Filter
```

--------------------------------

### Generate metric attributes for HTTP client

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Computes metric attributes based on the HTTP request, status code, and additional provided attributes.

```go
func (n HTTPClient) MetricAttributes(req *http.Request, statusCode int, additionalAttributes []attribute.KeyValue) []attribute.KeyValue
```

--------------------------------

### Split a network address into host and port

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Splits a network address string into its host and port components, handling various formats including IPv6 literals.

```go
func SplitHostPort(hostport string) (host string, port int)
```

--------------------------------

### Header filter function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/filters

Matches requests where the specified header key has an exact value match.

```go
func Header(k, v string) otelhttp.Filter
```

--------------------------------

### Retrieve RespWriterWrapper metrics and state

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/request

Methods to access written bytes, status codes, errors, or perform write/flush operations.

```go
func (w *RespWriterWrapper) BytesWritten() int64
func (w *RespWriterWrapper) Error() error
func (w *RespWriterWrapper) Flush()
func (w *RespWriterWrapper) StatusCode() int
func (w *RespWriterWrapper) Write(p []byte) (int, error)
func (w *RespWriterWrapper) WriteHeader(statusCode int)
```

--------------------------------

### Generate trace attributes for HTTP request

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Extracts trace attributes from an HTTP request made by a client.

```go
func (n HTTPClient) RequestTraceAttrs(req *http.Request) []attribute.KeyValue
```

--------------------------------

### Retrieve BodyWrapper metrics

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/request

Methods to access the total bytes read, the last error encountered, or to perform read/close operations.

```go
func (w *BodyWrapper) BytesRead() int64
func (w *BodyWrapper) Close() error
func (w *BodyWrapper) Error() error
func (w *BodyWrapper) Read(b []byte) (int, error)
```

--------------------------------

### HTTPClient ResponseTraceAttrs

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Returns trace attributes for an HTTP response made by a client.

```go
func (n HTTPClient) ResponseTraceAttrs(resp *http.Response) []attribute.KeyValue
```

--------------------------------

### ResponseTelemetry Structure

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Telemetry data for HTTP responses.

```go
type ResponseTelemetry struct {
	StatusCode int
	ReadBytes  int64
	ReadError  error
	WriteBytes int64
	WriteError error
}
```

--------------------------------

### type HTTPClient

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Provides methods for generating OpenTelemetry attributes and metrics for HTTP client operations.

```APIDOC
## func NewHTTPClient(meter metric.Meter) HTTPClient

### Description
Creates a new HTTPClient instance using the provided OpenTelemetry meter.

## func (HTTPClient) ErrorType(err error) attribute.KeyValue

### Description
Returns an error.type attribute for the given error. This function is designed to keep attribute cardinality bounded by reporting a single concrete type per failure.

## func (HTTPClient) RequestTraceAttrs(req *http.Request) []attribute.KeyValue

### Description
Returns trace attributes for an HTTP request made by a client.
```

--------------------------------

### Define Transport Struct

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Implements http.RoundTripper to wrap outbound HTTP requests with spans and metrics.

```go
type Transport struct {
	// contains filtered or unexported fields
}
```

--------------------------------

### func NewHandler

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Wraps an existing http.Handler in a span named after the operation and enriches it with metrics.

```APIDOC
## func NewHandler(handler http.Handler, operation string, opts ...Option) http.Handler

### Description
Wraps the passed handler in a span named after the operation and enriches it with metrics.

### Parameters
- **handler** (http.Handler) - Required - The original http.Handler to wrap.
- **operation** (string) - Required - The name of the operation for the span.
- **opts** (...Option) - Optional - Configuration options for the instrumentation.
```

--------------------------------

### HTTPServer RequestTraceAttrs

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Returns trace attributes for an HTTP request received by a server.

```go
func (n HTTPServer) RequestTraceAttrs(server string, req *http.Request, opts RequestTraceAttrsOpts) []attribute.KeyValue
```

--------------------------------

### Query filter function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/filters

Matches requests where the specified query parameter has an exact value match.

```go
func Query(k, v string) otelhttp.Filter
```

--------------------------------

### None filter function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/filters

Returns a filter that evaluates to true only if none of the provided filters return true.

```go
func None(fs ...otelhttp.Filter) otelhttp.Filter
```

--------------------------------

### Define HTTP Attribute Constants

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Constants representing attribute keys used for recording request and response metrics in spans.

```go
const (
	ReadBytesKey  = attribute.Key("http.read_bytes")  // if anything was read from the request body, the total number of bytes read
	ReadErrorKey  = attribute.Key("http.read_error")  // If an error occurred while reading a request, the string of the error (io.EOF is not recorded)
	WroteBytesKey = attribute.Key("http.wrote_bytes") // if anything was written to the response writer, the total number of bytes written
	WriteErrorKey = attribute.Key("http.write_error") // if an error occurred while writing a reply, the string of the error (io.EOF is not recorded)
)
```

--------------------------------

### HTTPClient Status

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Returns a span status code and message for an HTTP status code.

```go
func (n HTTPClient) Status(code int) (codes.Code, string)
```

--------------------------------

### HTTPServer ResponseTraceAttrs

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Returns trace attributes for telemetry from an HTTP response.

```go
func (n HTTPServer) ResponseTraceAttrs(resp ResponseTelemetry) []attribute.KeyValue
```

--------------------------------

### HeaderContains filter function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/filters

Matches requests where the specified header key contains the provided value string.

```go
func HeaderContains(k, v string) otelhttp.Filter
```

--------------------------------

### HTTPServer NetworkTransportAttr

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Returns network transport attributes.

```go
func (s HTTPServer) NetworkTransportAttr(network string) []attribute.KeyValue
```

--------------------------------

### HTTPServer Status

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Returns a span status code and message for an HTTP status code value.

```go
func (n HTTPServer) Status(code int) (codes.Code, string)
```

--------------------------------

### func SplitHostPort

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Splits a network address string into its host and port components.

```APIDOC
## func SplitHostPort(hostport string) (host string, port int)

### Description
Splits a network address hostport of the form "host", "host%zone", "[host]", "[host%zone]", "host:port", "host%zone:port", "[host]:port", "[host%zone]:port", or ":port" into host or host%zone and port. An empty host is returned if it is not provided or unparsable. A negative port is returned if it is not provided or unparsable.
```

--------------------------------

### Define Request Filter

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Predicate used to determine whether a given http.request should be traced.

```go
type Filter func(*http.Request) bool
```

--------------------------------

### NewTransport

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Creates a new Transport that wraps an existing http.RoundTripper to inject span context and record metrics.

```APIDOC
## func NewTransport(base http.RoundTripper, opts ...Option) *Transport

### Description
Wraps the provided http.RoundTripper with one that starts a span, injects the span context into the outbound request headers, and enriches it with metrics. If the provided http.RoundTripper is nil, http.DefaultTransport will be used.

### Parameters
- **base** (http.RoundTripper) - Required - The base transport to wrap.
- **opts** (...Option) - Optional - Configuration options for the transport.
```

--------------------------------

### HTTPServer SpanName

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Returns the span name for an HTTP request following OpenTelemetry conventions.

```go
func (n HTTPServer) SpanName(r *http.Request) string
```

--------------------------------

### Define Instrumentation Scope Name

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

The constant defining the instrumentation scope name for this package.

```go
const ScopeName = "go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
```

--------------------------------

### Define BodyWrapper struct

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/request

The BodyWrapper struct wraps an io.ReadCloser to track bytes read from an HTTP request body.

```go
type BodyWrapper struct {
	io.ReadCloser
	OnRead func(n int64) // must not be nil
	// contains filtered or unexported fields
}
```

--------------------------------

### Define RespWriterWrapper struct

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/request

The RespWriterWrapper struct wraps an http.ResponseWriter to track bytes written and capture the HTTP status code.

```go
type RespWriterWrapper struct {
	http.ResponseWriter
	OnWrite func(n int64) // must not be nil
	// contains filtered or unexported fields
}
```

--------------------------------

### QueryContains filter function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/filters

Matches requests where the specified query parameter contains the provided value string.

```go
func QueryContains(k, v string) otelhttp.Filter
```

--------------------------------

### Labeler Type Definition

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Used to allow instrumented HTTP handlers to add custom attributes to metrics.

```go
type Labeler struct {
	// contains filtered or unexported fields
}
```

--------------------------------

### func NewTransport

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Creates a new Transport that wraps an http.RoundTripper to provide tracing and metrics for outgoing HTTP requests.

```APIDOC
## func NewTransport(base http.RoundTripper, opts ...Option) *Transport

### Description
Creates a new Transport that wraps the provided base http.RoundTripper to instrument outgoing requests.

### Parameters
- **base** (http.RoundTripper) - Required - The base RoundTripper to wrap.
- **opts** (...Option) - Optional - Configuration options for the instrumentation.
```

--------------------------------

### Not filter function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/filters

Inverts the result of the provided filter.

```go
func Not(f otelhttp.Filter) otelhttp.Filter
```

--------------------------------

### Generate error type attribute

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/internal/semconv

Returns an error.type attribute for a given error, maintaining low cardinality for OTel compliance.

```go
func (n HTTPClient) ErrorType(err error) attribute.KeyValue
```
Tokens:
Raw