gohttpc

type Client struct {
	// contains filtered or unexported fields
}

type ClientOption func(*ClientOptions)

type ClientOptions struct {
	RequestOptions
	authscheme.HTTPClientAuthenticatorOptions

	HTTPClient *http.Client
}

type CustomAttributesFunc func(*Request) []attribute.KeyValue

type HTTPClient interface {
	// NewRequest returns a new http.Request given a method, URL, and optional body.
	NewRequest(
		ctx context.Context,
		method string,
		url string,
		body io.Reader,
	) (*http.Request, error)
	// Do sends an HTTP request and returns an HTTP response, following policy
	// (such as redirects, cookies, auth) as configured on the client.
	Do(req *http.Request) (*http.Response, error)
}

type HTTPClientGetter interface {
	// HTTPClient returns the current or inner HTTP client for load balancing.
	HTTPClient() (HTTPClient, error)
}

type HTTPClientMetrics struct {
	// Number of outbound HTTP connections that are currently active or idle on the client.
	OpenConnections metric.Int64UpDownCounter
	// The duration of the successfully established outbound HTTP connections.
	ConnectionDuration metric.Float64Histogram
	// The gauge metric to observe the server state.
	ServerState metric.Int64Gauge
	// The duration of how long the connection was previously idle.
	IdleConnectionDuration metric.Float64Histogram
	// The duration of the server for responding to the first byte.
	ServerDuration metric.Float64Histogram
	// Number of active HTTP requests.
	ActiveRequests metric.Int64UpDownCounter
	// Histogram metrics of the request body size.
	RequestBodySize metric.Int64Histogram
	// Histogram metrics of the response body size.
	ResponseBodySize metric.Int64Histogram
	// Duration of HTTP client requests.
	RequestDuration metric.Float64Histogram
	// The duration of DNS lookup operations performed by the HTTP client.
	DNSLookupDuration metric.Float64Histogram
}

type HTTPClientTracer interface {
	trace.Span

	// Context returns the internal context.
	Context() context.Context
	// TotalTime returns the total time.
	TotalTime() time.Duration
	// RemoteAddress gets the remote address if exists.
	RemoteAddress() string
	// SetMetricAttributes sets common attributes for metrics.
	SetMetricAttributes(attrs []attribute.KeyValue)
}

type HTTPDialerConfig struct {
	// The maximum amount of time a dial will wait for a connect to complete.
	// If Deadline is also set, it may fail earlier.
	Timeout *goutils.Duration `json:"timeout,omitempty" jsonschema:"oneof_ref=#/$defs/Duration,oneof_type=null" yaml:"timeout"`
	// Keep-alive probes are enabled by default.
	KeepAliveEnabled *bool `json:"keepAliveEnabled,omitempty" yaml:"keepAliveEnabled"`
	// KeepAliveInterval is the time between keep-alive probes. If zero, a default value of 15 seconds is used.
	KeepAliveInterval *goutils.Duration `json:"keepAliveInterval,omitempty" jsonschema:"oneof_ref=#/$defs/Duration,oneof_type=null" yaml:"keepAliveInterval"`
	// KeepAliveCount is the maximum number of keep-alive probes that can go unanswered before dropping a connection.
	// If zero, a default value of 9 is used.
	KeepAliveCount *int `json:"keepAliveCount,omitempty" jsonschema:"nullable,min=0" yaml:"keepAliveCount"`
	// KeepAliveIdle is the time that the connection must be idle before the first keep-alive probe is sent.
	// If zero, a default value of 15 seconds is used.
	KeepAliveIdle *goutils.Duration `json:"keepAliveIdle,omitempty" jsonschema:"oneof_ref=#/$defs/Duration,oneof_type=null" yaml:"keepAliveIdle"`
	// FallbackDelay specifies the length of time to wait before spawning a RFC 6555 Fast Fallback connection.
	// That is, this is the amount of time to wait for IPv6 to succeed before assuming that IPv6 is misconfigured and falling back to IPv4.
	// If zero, a default delay of 300ms is used. A negative value disables Fast Fallback support.
	FallbackDelay *goutils.Duration `json:"fallbackDelay,omitempty" jsonschema:"oneof_ref=#/$defs/Duration,oneof_type=null" yaml:"fallbackDelay"`
}

type HTTPTransportConfig struct {
	// Options the http.Dialer to connect to an address
	Dialer *HTTPDialerConfig `json:"dialer,omitempty" yaml:"dialer"`
	// Idle connection timeout. The maximum amount of time an idle (keep-alive) connection will remain idle before closing itself. Zero means no limit.
	IdleConnTimeout *goutils.Duration `json:"idleConnTimeout,omitempty" jsonschema:"oneof_ref=#/$defs/Duration,oneof_type=null" yaml:"idleConnTimeout"`
	// Response header timeout, if non-zero, specifies the amount of time to wait for a server's response headers after fully writing the request (including its body, if any).
	// This time does not include the time to read the response body.
	// This timeout is used to cover cases where the tcp connection works but the server never answers.
	ResponseHeaderTimeout *goutils.Duration `json:"responseHeaderTimeout,omitempty" jsonschema:"oneof_ref=#/$defs/Duration,oneof_type=null" yaml:"responseHeaderTimeout"`
	// TLS handshake timeout is the maximum amount of time to wait for a TLS handshake. Zero means no timeout.
	TLSHandshakeTimeout *goutils.Duration `json:"tlsHandshakeTimeout,omitempty" jsonschema:"oneof_ref=#/$defs/Duration,oneof_type=null" yaml:"tlsHandshakeTimeout"`
	// Expect continue timeout, if non-zero, specifies the amount of time to wait for a server's first response headers after fully writing the request headers if the request has an "Expect: 100-continue" header.
	ExpectContinueTimeout *goutils.Duration `json:"expectContinueTimeout,omitempty" jsonschema:"oneof_ref=#/$defs/Duration,oneof_type=null" yaml:"expectContinueTimeout"`
	// MaxIdleConns controls the maximum number of idle (keep-alive) connections across all hosts. Zero means no limit.
	MaxIdleConns *int `json:"maxIdleConns,omitempty" jsonschema:"nullable,min=0" yaml:"maxIdleConns"`
	// MaxIdleConnsPerHost, if non-zero, controls the maximum idle (keep-alive) connections to keep per-host.
	MaxIdleConnsPerHost *int `json:"maxIdleConnsPerHost,omitempty" jsonschema:"nullable,min=0" yaml:"maxIdleConnsPerHost"`
	// MaxConnsPerHost optionally limits the total number of connections per host, including connections in the dialing, active, and idle states.
	// On limit violation, dials will block. Zero means no limit.
	MaxConnsPerHost *int `json:"maxConnsPerHost,omitempty" jsonschema:"nullable,min=0" yaml:"maxConnsPerHost"`
	// MaxResponseHeaderBytes specifies a limit on how many response bytes are allowed in the server's response header.
	// Zero means to use a default limit.
	MaxResponseHeaderBytes *int64 `json:"maxResponseHeaderBytes,omitempty" jsonschema:"nullable,min=0" yaml:"maxResponseHeaderBytes"`
	// ReadBufferSize specifies the size of the read buffer used when reading from the transport.
	// If zero, a default (currently 4KB) is used.
	ReadBufferSize *int `json:"readBufferSize,omitempty" jsonschema:"nullable,min=0" yaml:"readBufferSize"`
	// WriteBufferSize specifies the size of the write buffer used when writing to the transport.
	// If zero, a default (currently 4KB) is used.
	WriteBufferSize *int `json:"writeBufferSize,omitempty" jsonschema:"nullable,min=0" yaml:"writeBufferSize"`
	// DisableKeepAlives, if true, disables HTTP keep-alives and will only use the connection to the server for a single HTTP request.
	// This is unrelated to the similarly named TCP keep-alives.
	DisableKeepAlives bool `json:"disableKeepAlives,omitempty" yaml:"disableKeepAlives"`
	// ForceAttemptHTTP2 controls whether HTTP/2 is enabled when a non-zero Dial, DialTLS, or DialContext func or TLSClientConfig is provided.
	// Default is true.
	ForceAttemptHTTP2 *bool `json:"forceAttemptHTTP2,omitempty" yaml:"forceAttemptHTTP2"`
}

type Request struct {
	// contains filtered or unexported fields
}

type RequestOption func(*RequestOptions)

type RequestOptions struct {
	Logger                      *slog.Logger
	Tracer                      trace.Tracer
	TraceHighCardinalityPath    bool
	MetricHighCardinalityPath   bool
	CustomAttributesFunc        CustomAttributesFunc
	Retry                       retrypolicy.RetryPolicy[*http.Response]
	Timeout                     time.Duration
	Authenticator               authscheme.HTTPClientAuthenticator
	ClientTraceEnabled          bool
	UserAgent                   string
	AllowedTraceRequestHeaders  []string
	AllowedTraceResponseHeaders []string
}

type RequestOptionsGetter interface {
	GetRequestOptions() *RequestOptions
}

type RequestWithClient struct {
	*Request
	// contains filtered or unexported fields
}