Documentation
¶
Overview ¶
Package api provides clients for the HTTP APIs.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var DefaultRoundTripper http.RoundTripper = &http.Transport{ Proxy: http.ProxyFromEnvironment, DialContext: (&net.Dialer{ Timeout: 30 * time.Second, KeepAlive: 30 * time.Second, }).DialContext, TLSHandshakeTimeout: 10 * time.Second, }
DefaultRoundTripper is used if no RoundTripper is set in Config.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client interface {
URL(ep string, args map[string]string) *url.URL
Do(context.Context, *http.Request) (*http.Response, []byte, Error)
}
Client is the interface for an API client.
type Config ¶
type Config struct {
// The address of the Prometheus to connect to.
Address string
// RoundTripper is used by the Client to drive HTTP requests. If not
// provided, DefaultRoundTripper will be used.
RoundTripper http.RoundTripper
}
Config defines configuration parameters for a new client.
type Error ¶ added in v0.9.4
type Error interface {
error
// Err returns the underlying error.
Err() error
// Warnings returns a list of warnings.
Warnings() []string
}
Error encapsulates an error + warning
func DoGetFallback ¶ added in v0.9.3
func DoGetFallback(c Client, ctx context.Context, u *url.URL, args url.Values) (*http.Response, []byte, Error)
DoGetFallback will attempt to do the request as-is, and on a 405 it will fallback to a GET request.
func NewErrorAPI ¶ added in v0.9.4
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.