OpenTelemetry Echo Instrumentation

https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho
Admin
OpenTelemetry instrumentation for the Echo web framework that enables tracing and metrics collection...
Tokens:5,716
Snippets:80
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Run labstack echo instrumentation example

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/example

Use these commands to bring up and down the echo-server and echo-client services for the example. Ensure Docker Compose is installed.

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

```bash
docker-compose logs echo-server
```

```bash
docker-compose down
```

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

### Get Version

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho

The current release version of the echo instrumentation.

```go
const Version = "0.68.0"
```

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

### Get Echo Middleware

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho

Returns echo middleware which will trace incoming requests. Use this to instrument routing.

```go
func Middleware(serverName string, opts ...Option) echo.MiddlewareFunc
```

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

### Get Version of Echo Instrumentation Test Module

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/test

Use this function to retrieve the current release version of the echo instrumentation test module. No setup or imports are required.

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

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

### Get Route Attribute

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

Route returns an attribute.KeyValue for the specified route string.

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

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

### Get HTTP Status Code and Message

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

Status maps an HTTP status code to an OpenTelemetry span status code and message. Codes in the 400-499 range are not treated as errors.

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

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

### NewHTTPServer Constructor

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

Initializes a new HTTP server for metric collection. Requires a metric.Meter to be provided.

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

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

### NewHTTPClient Constructor

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

Initializes a new HTTP client for metric collection. Requires a metric.Meter to be provided.

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

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

### Option Interface

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho

Option specifies instrumentation configuration options.

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

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

### Record Server Metrics

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

Use RecordMetrics to record server-side metrics. It takes context and server metric data as input.

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

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

### Configure Tracer Provider for Echo

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho

Use WithTracerProvider to specify a custom tracer provider. If not provided, the global tracer provider is used.

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

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

### Configure Meter Provider

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho

WithMeterProvider specifies a meter provider to use for creating a meter. If none is specified, the global provider is used.

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

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

### MetricOpts AddOptions

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

Retrieves metric add options from MetricOpts.

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

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

### HTTPClient MetricOptions

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

Converts MetricAttributes into metric options for recording measurements.

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

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

### MetricOpts MeasurementOption

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

Retrieves metric measurement options from MetricOpts.

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

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

### Configure Skipper

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho

WithSkipper specifies a skipper for allowing requests to skip generating spans.

```go
func WithSkipper(skipper middleware.Skipper) Option
```

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

### WithTracerProvider Option

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho

WithTracerProvider specifies a tracer provider to use for creating a tracer. If none is specified, the global provider is used.

```APIDOC
## func WithTracerProvider ¶

```
func WithTracerProvider(provider oteltrace.TracerProvider) Option
```

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

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

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

### HTTPClient TraceAttributes

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

Returns attributes for httptrace, typically used for client-side tracing. Requires a host string.

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

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

### Middleware

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho

Middleware returns echo middleware which will trace incoming requests. It can be configured using various Option functions.

```APIDOC
## Middleware

### Description

Middleware returns echo middleware which will trace incoming requests.

### Function Signature

```go
func Middleware(serverName string, opts ...Option) echo.MiddlewareFunc
```

### Parameters

- **serverName** (string) - The name of the server to be used in instrumentation.
- **opts** (...Option) - A variadic list of Option functions to configure the middleware.

### Options

- **WithEchoMetricAttributeFn**
  - **Description**: Specifies a function that extracts additional attributes from the echo.Context.
  - **Signature**: `func WithEchoMetricAttributeFn(f EchoMetricAttributeFn) Option`

- **WithMeterProvider**
  - **Description**: Specifies a meter provider to use for creating a meter. If none is specified, the global provider is used.
  - **Signature**: `func WithMeterProvider(provider metric.MeterProvider) Option`

- **WithMetricAttributeFn**
  - **Description**: Specifies a function that extracts additional attributes from the http.Request.
  - **Signature**: `func WithMetricAttributeFn(f MetricAttributeFn) Option`

- **WithOnError**
  - **Description**: Specifies a function that is called when an error occurs during request processing.
  - **Signature**: `func WithOnError(f OnErrorFn) Option`

- **WithPropagators**
  - **Description**: Specifies propagators to use for extracting information from the HTTP requests. If none are specified, global ones will be used.
  - **Signature**: `func WithPropagators(propagators propagation.TextMapPropagator) Option`

- **WithSkipper**
  - **Description**: Specifies a skipper for allowing requests to skip generating spans.
  - **Signature**: `func WithSkipper(skipper middleware.Skipper) Option`

### Types

- **EchoMetricAttributeFn**: `func(echo.Context) []attribute.KeyValue` - Used to extract additional attributes from the echo.Context.
- **MetricAttributeFn**: `func(*http.Request) []attribute.KeyValue` - Used to extract additional attributes from the http.Request.
- **OnErrorFn**: `func(echo.Context, error)` - Used to specify how errors are handled in the middleware.
- **Option**: Interface for configuration options.
```

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

### ServerMetricData Struct

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

ServerMetricData aggregates data for server-side metrics, combining server name, response size, and metric details.

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

	MetricData
	MetricAttributes
}
```

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

### Configure Propagators

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho

WithPropagators specifies propagators to use for extracting information from HTTP requests. If none are specified, global ones will be used.

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

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

### HTTPClient RecordMetrics

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

Records metrics for an HTTP client operation. Requires context, metric data, and metric options.

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

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

### MetricOpts.AddOptions

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

AddOptions returns a metric.AddOption from MetricOpts. This is used for configuring metric collection.

```APIDOC
## func (MetricOpts) AddOptions

### Description
Returns a metric.AddOption based on the MetricOpts configuration.

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

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

### type HTTPServer

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

HTTPServer provides functionality for instrumenting HTTP servers with OpenTelemetry metrics and traces.

```APIDOC
## type HTTPServer

### Description
HTTPServer provides functionality for instrumenting HTTP servers with OpenTelemetry metrics and traces.

### Methods

#### func NewHTTPServer

##### Description
NewHTTPServer creates a new HTTPServer with the given metric.Meter.

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

#### func (HTTPServer) MetricAttributes

##### Description
MetricAttributes returns metric attributes for an HTTP server request, including server name, request details, status code, route, and additional attributes.

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

#### func (HTTPServer) NetworkTransportAttr

##### Description
NetworkTransportAttr returns network transport attributes for the given network type.

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

#### func (HTTPServer) RecordMetrics

##### Description
RecordMetrics records metrics for an HTTP server request.

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

#### func (HTTPServer) RequestTraceAttrs

##### Description
RequestTraceAttrs returns trace attributes for an HTTP server request.

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

#### func (HTTPServer) ResponseTraceAttrs

##### Description
ResponseTraceAttrs returns trace attributes for an HTTP server response.

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

#### func (HTTPServer) Route

##### Description
Route returns an attribute for the given route.

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

#### func (HTTPServer) Status

##### Description
Status converts an HTTP status code to an OpenTelemetry status code and string representation.

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

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

### HTTPServer MetricAttributes

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

Generates metric attributes for an HTTP server request. Takes server name, http.Request, status code, route, and additional attributes.

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

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

### MetricOpts.MeasurementOption

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

MeasurementOption returns a metric.MeasurementOption from MetricOpts. This is used for configuring metric measurements.

```APIDOC
## func (MetricOpts) MeasurementOption

### Description
Returns a metric.MeasurementOption based on the MetricOpts configuration.

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

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

### HTTPClient MetricAttributes

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

Generates metric attributes for an HTTP client request. Takes the http.Request, status code, and additional attributes as input.

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

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

### MetricData Struct

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

MetricData contains core metric information for requests, including size and duration.

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

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

### Version Function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/test

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

```APIDOC
## func Version()

### Description
Version is the current release version of the echo instrumentation test module.

### Signature
```go
func Version() string
```
```

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

### SplitHostPort Function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

Splits a network address string into host and port components. Handles various formats including IPv6 addresses and zone identifiers. Returns empty host and negative port for unparsable inputs.

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

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

### Define Instrumentation Scope Name

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho

Defines the instrumentation scope name for the otelecho package.

```go
const (

	// ScopeName is the instrumentation scope name.
	ScopeName = "go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho"
)
```

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

### type HTTPClient

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

HTTPClient provides functionality for instrumenting HTTP clients with OpenTelemetry metrics and traces.

```APIDOC
## type HTTPClient

### Description
HTTPClient provides functionality for instrumenting HTTP clients with OpenTelemetry metrics and traces.

### Methods

#### func NewHTTPClient

##### Description
NewHTTPClient creates a new HTTPClient with the given metric.Meter.

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

#### func (HTTPClient) MetricAttributes

##### Description
MetricAttributes returns metric attributes for an HTTP request, including status code and additional attributes.

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

#### func (HTTPClient) MetricOptions

##### Description
MetricOptions returns metric options for recording metrics.

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

#### func (HTTPClient) RecordMetrics

##### Description
RecordMetrics records metrics for an HTTP client request.

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

#### func (HTTPClient) RequestTraceAttrs

##### Description
RequestTraceAttrs returns trace attributes for an HTTP request made by a client.

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

#### func (HTTPClient) ResponseTraceAttrs

##### Description
ResponseTraceAttrs returns trace attributes for an HTTP response made by a client.

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

#### func (HTTPClient) Status

##### Description
Status converts an HTTP status code to an OpenTelemetry status code and string representation.

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

#### func (HTTPClient) TraceAttributes

##### Description
TraceAttributes returns attributes for httptrace.

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

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

### RequestTraceAttrsOpts Struct

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

RequestTraceAttrsOpts provides options for generating request trace attributes, such as specifying the client IP.

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

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

### Route

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

Route returns the attribute for the route. This is useful for tagging metrics or traces with specific route information.

```APIDOC
## func (HTTPServer) Route

### Description
Returns an attribute representing the route.

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

### Parameters
#### Path Parameters
- **route** (string) - The route identifier.

### Request Example
```go
// Example usage:
routeAttr := httpServer.Route("/users/:id")
```
```

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

### RecordMetrics

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

RecordMetrics records server-side metrics for an HTTP request. It takes context and server metric data as input.

```APIDOC
## func (HTTPServer) RecordMetrics

### Description
Records server-side metrics for an HTTP request.

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

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

### Configure HTTP Request Attributes

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho

WithMetricAttributeFn specifies a function that extracts additional attributes from the http.Request. If attributes are duplicated with WithEchoMetricAttributeFn, these will be overridden.

```go
func WithMetricAttributeFn(f MetricAttributeFn) Option
```

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

### Configure Echo Metric Attributes

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho

WithEchoMetricAttributeFn specifies a function that extracts additional attributes from the echo.Context. If attributes are duplicated with WithMetricAttributeFn, these will be used.

```go
func WithEchoMetricAttributeFn(f EchoMetricAttributeFn) Option
```

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

### HTTPClient RequestTraceAttrs

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

Returns trace attributes for an HTTP request made by a client. Extracts relevant information from the http.Request.

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

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

### HTTPClient Status

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

Converts an integer HTTP status code into OpenTelemetry codes.Code and a string representation.

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

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

### HTTPClient ResponseTraceAttrs

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

Returns trace attributes for an HTTP response received by a client. Extracts relevant information from the http.Response.

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

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

### func SplitHostPort

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

SplitHostPort 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.

```APIDOC
## func SplitHostPort

### Description
SplitHostPort 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.

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

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

### Generate Request Trace Attributes

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

RequestTraceAttrs generates trace attributes for an incoming HTTP request. Provide the primary server name and the request object. If the server name is unknown, an empty string can be used, and the request Host header will be utilized.

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

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

### MetricAttributes Struct

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

MetricAttributes holds attributes relevant for server metrics, including the HTTP request, status code, route, and additional attributes.

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

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

### HTTPServer NetworkTransportAttr

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

Returns network transport attributes for an HTTP server. Requires a network string (e.g., "tcp", "udp").

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

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

### Generate Response Trace Attributes

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

ResponseTraceAttrs returns trace attributes for HTTP response telemetry. Attributes are omitted if fields in ResponseTelemetry are not set.

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

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

### ResponseTelemetry Struct

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

ResponseTelemetry captures details about an HTTP response, including status code, bytes read/written, and any associated errors.

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

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

### Define OnErrorFn

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho

OnErrorFn is used to specify how errors are handled in the middleware.

```go
type OnErrorFn func(echo.Context, error)
```

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

### Define MetricAttributeFn

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho

MetricAttributeFn is used to extract additional attributes from the http.Request and return them as a slice of attribute.KeyValue.

```go
type MetricAttributeFn func(*http.Request) []attribute.KeyValue
```

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

### Configure Error Handling

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho

WithOnError specifies a function that is called when an error occurs during request processing. Be cautious with custom error handlers to avoid invalid span data or double execution of HTTPErrorHandler.

```go
func WithOnError(f OnErrorFn) Option
```

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

### Define EchoMetricAttributeFn

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho

EchoMetricAttributeFn is used to extract additional attributes from the echo.Context and return them as a slice of attribute.KeyValue.

```go
type EchoMetricAttributeFn func(echo.Context) []attribute.KeyValue
```

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

### Status

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

Status returns a span status code and message for an HTTP status code value returned by a server. Non-error codes in the 4xx range are handled appropriately.

```APIDOC
## func (HTTPServer) Status

### Description
Converts an HTTP status code into an OpenTelemetry status code and message. Status codes in the 400-499 range are not treated as errors.

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

### Parameters
#### Path Parameters
- **code** (int) - The HTTP status code.

### Request Example
```go
// Example usage:
otOkStatus, msg := httpServer.Status(404)
```
```

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

### RequestTraceAttrs

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

RequestTraceAttrs returns trace attributes for an HTTP request received by a server. It helps in identifying the server and associated request details for tracing.

```APIDOC
## func (HTTPServer) RequestTraceAttrs

### Description
Returns trace attributes for an HTTP request received by a server. The server name is used to identify the primary server, and if not known, the request Host header is used. It can also include client IP if provided in options.

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

### Parameters
#### Path Parameters
- **server** (string) - The primary server name (e.g., Host header value).
- **req** (*http.Request) - The incoming HTTP request.
- **opts** (RequestTraceAttrsOpts) - Options for trace attributes, including `HTTPClientIP`.

### Request Example
```go
// Example usage:
attrs := httpServer.RequestTraceAttrs("example.com", req, RequestTraceAttrsOpts{HTTPClientIP: "192.168.1.1"})
```
```

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

### ResponseTraceAttrs

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconv

ResponseTraceAttrs returns trace attributes for telemetry from an HTTP response. It captures details like status code and bytes read/written.

```APIDOC
## func (HTTPServer) ResponseTraceAttrs

### Description
Returns trace attributes for telemetry from an HTTP response. Attributes are generated based on the provided `ResponseTelemetry` data. If fields are not set, the corresponding attribute is omitted.

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

### Parameters
#### Path Parameters
- **resp** (ResponseTelemetry) - Telemetry data for the HTTP response.

### Request Example
```go
// Example usage:
responseTelemetry := ResponseTelemetry{StatusCode: 200, ReadBytes: 1024, WriteBytes: 512}
attrs := httpServer.ResponseTraceAttrs(responseTelemetry)
```
```
Tokens:
Raw