Documentation
¶
Index ¶
- type APIAnnotationsCreateRequest
- type APIAnnotationsCreateResponse
- type APIBaseVersionResponse
- type APIBasicAuth
- type APIDemoErrorResponse
- type APILabelPair
- type APILog
- type APILogsAllResponse
- type APIMySQLAddRequest
- type APIMySQLAddResponse
- type APIMySQLInstance
- type APIMySQLListResponse
- type APIMySQLNode
- type APIMySQLRemoveResponse
- type APIMySQLService
- type APIPostgreSQLAddRequest
- type APIPostgreSQLAddResponse
- type APIPostgreSQLInstance
- type APIPostgreSQLListResponse
- type APIPostgreSQLNode
- type APIPostgreSQLRemoveResponse
- type APIPostgreSQLService
- type APIRDSAddRequest
- type APIRDSAddResponse
- type APIRDSDiscoverRequest
- type APIRDSDiscoverResponse
- type APIRDSInstance
- type APIRDSInstanceID
- type APIRDSListResponse
- type APIRDSNode
- type APIRDSRemoveRequest
- type APIRDSRemoveResponse
- type APIRDSService
- type APIRemoteInstance
- type APIRemoteListResponse
- type APIRemoteNode
- type APIRemoteService
- type APIScrapeConfig
- type APIScrapeConfigsCreateRequest
- type APIScrapeConfigsCreateResponse
- type APIScrapeConfigsDeleteResponse
- type APIScrapeConfigsGetResponse
- type APIScrapeConfigsListResponse
- type APIScrapeConfigsUpdateRequest
- type APIScrapeConfigsUpdateResponse
- type APIScrapeTargetHealth
- type APIStaticConfig
- type APITLSConfig
- type ScrapeTargetHealthHealth
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIAnnotationsCreateRequest ¶ added in v1.14.1
type APIAnnotationsCreateRequest struct {
// tags
Tags []string `json:"tags"`
// text
Text string `json:"text,omitempty"`
}
APIAnnotationsCreateRequest api annotations create request swagger:model apiAnnotationsCreateRequest
func (*APIAnnotationsCreateRequest) MarshalBinary ¶ added in v1.14.1
func (m *APIAnnotationsCreateRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIAnnotationsCreateRequest) UnmarshalBinary ¶ added in v1.14.1
func (m *APIAnnotationsCreateRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIAnnotationsCreateResponse ¶ added in v1.14.1
type APIAnnotationsCreateResponse struct {
// message
Message string `json:"message,omitempty"`
}
APIAnnotationsCreateResponse api annotations create response swagger:model apiAnnotationsCreateResponse
func (*APIAnnotationsCreateResponse) MarshalBinary ¶ added in v1.14.1
func (m *APIAnnotationsCreateResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIAnnotationsCreateResponse) UnmarshalBinary ¶ added in v1.14.1
func (m *APIAnnotationsCreateResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIBaseVersionResponse ¶
type APIBaseVersionResponse struct {
// version
Version string `json:"version,omitempty"`
}
APIBaseVersionResponse api base version response swagger:model apiBaseVersionResponse
func (*APIBaseVersionResponse) MarshalBinary ¶
func (m *APIBaseVersionResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIBaseVersionResponse) UnmarshalBinary ¶
func (m *APIBaseVersionResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIBasicAuth ¶
type APIBasicAuth struct {
// password
Password string `json:"password,omitempty"`
// username
Username string `json:"username,omitempty"`
}
APIBasicAuth api basic auth swagger:model apiBasicAuth
func (*APIBasicAuth) MarshalBinary ¶
func (m *APIBasicAuth) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIBasicAuth) UnmarshalBinary ¶
func (m *APIBasicAuth) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIDemoErrorResponse ¶
type APIDemoErrorResponse interface{}
APIDemoErrorResponse api demo error response swagger:model apiDemoErrorResponse
type APILabelPair ¶
type APILabelPair struct {
// Label name
Name string `json:"name,omitempty"`
// Label value
Value string `json:"value,omitempty"`
}
APILabelPair api label pair swagger:model apiLabelPair
func (*APILabelPair) MarshalBinary ¶
func (m *APILabelPair) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APILabelPair) UnmarshalBinary ¶
func (m *APILabelPair) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APILog ¶ added in v1.14.1
type APILog struct {
// Last lines of log file
Lines []string `json:"lines"`
}
APILog api log swagger:model apiLog
func (*APILog) MarshalBinary ¶ added in v1.14.1
MarshalBinary interface implementation
func (*APILog) UnmarshalBinary ¶ added in v1.14.1
UnmarshalBinary interface implementation
type APILogsAllResponse ¶ added in v1.14.1
type APILogsAllResponse struct {
// Maps log file name to content
Logs map[string]APILog `json:"logs,omitempty"`
}
APILogsAllResponse api logs all response swagger:model apiLogsAllResponse
func (*APILogsAllResponse) MarshalBinary ¶ added in v1.14.1
func (m *APILogsAllResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APILogsAllResponse) UnmarshalBinary ¶ added in v1.14.1
func (m *APILogsAllResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIMySQLAddRequest ¶ added in v1.16.0
type APIMySQLAddRequest struct {
// address
Address string `json:"address,omitempty"`
// name
Name string `json:"name,omitempty"`
// password
Password string `json:"password,omitempty"`
// port
Port int64 `json:"port,omitempty"`
// username
Username string `json:"username,omitempty"`
}
APIMySQLAddRequest api my SQL add request swagger:model apiMySQLAddRequest
func (*APIMySQLAddRequest) MarshalBinary ¶ added in v1.16.0
func (m *APIMySQLAddRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIMySQLAddRequest) UnmarshalBinary ¶ added in v1.16.0
func (m *APIMySQLAddRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIMySQLAddResponse ¶ added in v1.16.0
type APIMySQLAddResponse struct {
// id
ID int32 `json:"id,omitempty"`
}
APIMySQLAddResponse api my SQL add response swagger:model apiMySQLAddResponse
func (*APIMySQLAddResponse) MarshalBinary ¶ added in v1.16.0
func (m *APIMySQLAddResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIMySQLAddResponse) UnmarshalBinary ¶ added in v1.16.0
func (m *APIMySQLAddResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIMySQLInstance ¶ added in v1.16.0
type APIMySQLInstance struct {
// node
Node *APIMySQLNode `json:"node,omitempty"`
// service
Service *APIMySQLService `json:"service,omitempty"`
}
APIMySQLInstance api my SQL instance swagger:model apiMySQLInstance
func (*APIMySQLInstance) MarshalBinary ¶ added in v1.16.0
func (m *APIMySQLInstance) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIMySQLInstance) UnmarshalBinary ¶ added in v1.16.0
func (m *APIMySQLInstance) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIMySQLListResponse ¶ added in v1.16.0
type APIMySQLListResponse struct {
// instances
Instances []*APIMySQLInstance `json:"instances"`
}
APIMySQLListResponse api my SQL list response swagger:model apiMySQLListResponse
func (*APIMySQLListResponse) MarshalBinary ¶ added in v1.16.0
func (m *APIMySQLListResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIMySQLListResponse) UnmarshalBinary ¶ added in v1.16.0
func (m *APIMySQLListResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIMySQLNode ¶ added in v1.16.0
type APIMySQLNode struct {
// name
Name string `json:"name,omitempty"`
}
APIMySQLNode api my SQL node swagger:model apiMySQLNode
func (*APIMySQLNode) MarshalBinary ¶ added in v1.16.0
func (m *APIMySQLNode) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIMySQLNode) UnmarshalBinary ¶ added in v1.16.0
func (m *APIMySQLNode) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIMySQLRemoveResponse ¶ added in v1.16.0
type APIMySQLRemoveResponse interface{}
APIMySQLRemoveResponse api my SQL remove response swagger:model apiMySQLRemoveResponse
type APIMySQLService ¶ added in v1.16.0
type APIMySQLService struct {
// address
Address string `json:"address,omitempty"`
// engine
Engine string `json:"engine,omitempty"`
// engine version
EngineVersion string `json:"engine_version,omitempty"`
// port
Port int64 `json:"port,omitempty"`
}
APIMySQLService api my SQL service swagger:model apiMySQLService
func (*APIMySQLService) MarshalBinary ¶ added in v1.16.0
func (m *APIMySQLService) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIMySQLService) UnmarshalBinary ¶ added in v1.16.0
func (m *APIMySQLService) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIPostgreSQLAddRequest ¶ added in v1.16.0
type APIPostgreSQLAddRequest struct {
// address
Address string `json:"address,omitempty"`
// name
Name string `json:"name,omitempty"`
// password
Password string `json:"password,omitempty"`
// port
Port int64 `json:"port,omitempty"`
// username
Username string `json:"username,omitempty"`
}
APIPostgreSQLAddRequest api postgre SQL add request swagger:model apiPostgreSQLAddRequest
func (*APIPostgreSQLAddRequest) MarshalBinary ¶ added in v1.16.0
func (m *APIPostgreSQLAddRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIPostgreSQLAddRequest) UnmarshalBinary ¶ added in v1.16.0
func (m *APIPostgreSQLAddRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIPostgreSQLAddResponse ¶ added in v1.16.0
type APIPostgreSQLAddResponse struct {
// id
ID int32 `json:"id,omitempty"`
}
APIPostgreSQLAddResponse api postgre SQL add response swagger:model apiPostgreSQLAddResponse
func (*APIPostgreSQLAddResponse) MarshalBinary ¶ added in v1.16.0
func (m *APIPostgreSQLAddResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIPostgreSQLAddResponse) UnmarshalBinary ¶ added in v1.16.0
func (m *APIPostgreSQLAddResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIPostgreSQLInstance ¶ added in v1.16.0
type APIPostgreSQLInstance struct {
// node
Node *APIPostgreSQLNode `json:"node,omitempty"`
// service
Service *APIPostgreSQLService `json:"service,omitempty"`
}
APIPostgreSQLInstance api postgre SQL instance swagger:model apiPostgreSQLInstance
func (*APIPostgreSQLInstance) MarshalBinary ¶ added in v1.16.0
func (m *APIPostgreSQLInstance) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIPostgreSQLInstance) UnmarshalBinary ¶ added in v1.16.0
func (m *APIPostgreSQLInstance) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIPostgreSQLListResponse ¶ added in v1.16.0
type APIPostgreSQLListResponse struct {
// instances
Instances []*APIPostgreSQLInstance `json:"instances"`
}
APIPostgreSQLListResponse api postgre SQL list response swagger:model apiPostgreSQLListResponse
func (*APIPostgreSQLListResponse) MarshalBinary ¶ added in v1.16.0
func (m *APIPostgreSQLListResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIPostgreSQLListResponse) UnmarshalBinary ¶ added in v1.16.0
func (m *APIPostgreSQLListResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIPostgreSQLNode ¶ added in v1.16.0
type APIPostgreSQLNode struct {
// name
Name string `json:"name,omitempty"`
}
APIPostgreSQLNode api postgre SQL node swagger:model apiPostgreSQLNode
func (*APIPostgreSQLNode) MarshalBinary ¶ added in v1.16.0
func (m *APIPostgreSQLNode) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIPostgreSQLNode) UnmarshalBinary ¶ added in v1.16.0
func (m *APIPostgreSQLNode) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIPostgreSQLRemoveResponse ¶ added in v1.16.0
type APIPostgreSQLRemoveResponse interface{}
APIPostgreSQLRemoveResponse api postgre SQL remove response swagger:model apiPostgreSQLRemoveResponse
type APIPostgreSQLService ¶ added in v1.16.0
type APIPostgreSQLService struct {
// address
Address string `json:"address,omitempty"`
// engine
Engine string `json:"engine,omitempty"`
// engine version
EngineVersion string `json:"engine_version,omitempty"`
// port
Port int64 `json:"port,omitempty"`
}
APIPostgreSQLService api postgre SQL service swagger:model apiPostgreSQLService
func (*APIPostgreSQLService) MarshalBinary ¶ added in v1.16.0
func (m *APIPostgreSQLService) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIPostgreSQLService) UnmarshalBinary ¶ added in v1.16.0
func (m *APIPostgreSQLService) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIRDSAddRequest ¶ added in v1.5.0
type APIRDSAddRequest struct {
// aws access key id
AwsAccessKeyID string `json:"aws_access_key_id,omitempty"`
// aws secret access key
AwsSecretAccessKey string `json:"aws_secret_access_key,omitempty"`
// id
ID *APIRDSInstanceID `json:"id,omitempty"`
// password
Password string `json:"password,omitempty"`
// username
Username string `json:"username,omitempty"`
}
APIRDSAddRequest api r d s add request swagger:model apiRDSAddRequest
func (*APIRDSAddRequest) MarshalBinary ¶ added in v1.5.0
func (m *APIRDSAddRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIRDSAddRequest) UnmarshalBinary ¶ added in v1.5.0
func (m *APIRDSAddRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIRDSAddResponse ¶ added in v1.5.0
type APIRDSAddResponse interface{}
APIRDSAddResponse api r d s add response swagger:model apiRDSAddResponse
type APIRDSDiscoverRequest ¶ added in v1.5.0
type APIRDSDiscoverRequest struct {
// aws access key id
AwsAccessKeyID string `json:"aws_access_key_id,omitempty"`
// aws secret access key
AwsSecretAccessKey string `json:"aws_secret_access_key,omitempty"`
}
APIRDSDiscoverRequest api r d s discover request swagger:model apiRDSDiscoverRequest
func (*APIRDSDiscoverRequest) MarshalBinary ¶ added in v1.5.0
func (m *APIRDSDiscoverRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIRDSDiscoverRequest) UnmarshalBinary ¶ added in v1.5.0
func (m *APIRDSDiscoverRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIRDSDiscoverResponse ¶ added in v1.5.0
type APIRDSDiscoverResponse struct {
// instances
Instances []*APIRDSInstance `json:"instances"`
}
APIRDSDiscoverResponse api r d s discover response swagger:model apiRDSDiscoverResponse
func (*APIRDSDiscoverResponse) MarshalBinary ¶ added in v1.5.0
func (m *APIRDSDiscoverResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIRDSDiscoverResponse) UnmarshalBinary ¶ added in v1.5.0
func (m *APIRDSDiscoverResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIRDSInstance ¶ added in v1.5.0
type APIRDSInstance struct {
// node
Node *APIRDSNode `json:"node,omitempty"`
// service
Service *APIRDSService `json:"service,omitempty"`
}
APIRDSInstance api r d s instance swagger:model apiRDSInstance
func (*APIRDSInstance) MarshalBinary ¶ added in v1.5.0
func (m *APIRDSInstance) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIRDSInstance) UnmarshalBinary ¶ added in v1.5.0
func (m *APIRDSInstance) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIRDSInstanceID ¶ added in v1.5.0
type APIRDSInstanceID struct {
// name
Name string `json:"name,omitempty"`
// region
Region string `json:"region,omitempty"`
}
APIRDSInstanceID api r d s instance ID swagger:model apiRDSInstanceID
func (*APIRDSInstanceID) MarshalBinary ¶ added in v1.5.0
func (m *APIRDSInstanceID) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIRDSInstanceID) UnmarshalBinary ¶ added in v1.5.0
func (m *APIRDSInstanceID) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIRDSListResponse ¶ added in v1.5.0
type APIRDSListResponse struct {
// instances
Instances []*APIRDSInstance `json:"instances"`
}
APIRDSListResponse api r d s list response swagger:model apiRDSListResponse
func (*APIRDSListResponse) MarshalBinary ¶ added in v1.5.0
func (m *APIRDSListResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIRDSListResponse) UnmarshalBinary ¶ added in v1.5.0
func (m *APIRDSListResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIRDSNode ¶ added in v1.5.0
type APIRDSNode struct {
// name
Name string `json:"name,omitempty"`
// region
Region string `json:"region,omitempty"`
}
APIRDSNode api r d s node swagger:model apiRDSNode
func (*APIRDSNode) MarshalBinary ¶ added in v1.5.0
func (m *APIRDSNode) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIRDSNode) UnmarshalBinary ¶ added in v1.5.0
func (m *APIRDSNode) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIRDSRemoveRequest ¶ added in v1.5.0
type APIRDSRemoveRequest struct {
// id
ID *APIRDSInstanceID `json:"id,omitempty"`
}
APIRDSRemoveRequest api r d s remove request swagger:model apiRDSRemoveRequest
func (*APIRDSRemoveRequest) MarshalBinary ¶ added in v1.5.0
func (m *APIRDSRemoveRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIRDSRemoveRequest) UnmarshalBinary ¶ added in v1.5.0
func (m *APIRDSRemoveRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIRDSRemoveResponse ¶ added in v1.5.0
type APIRDSRemoveResponse interface{}
APIRDSRemoveResponse api r d s remove response swagger:model apiRDSRemoveResponse
type APIRDSService ¶ added in v1.5.0
type APIRDSService struct {
// address
Address string `json:"address,omitempty"`
// engine
Engine string `json:"engine,omitempty"`
// engine version
EngineVersion string `json:"engine_version,omitempty"`
// port
Port int64 `json:"port,omitempty"`
}
APIRDSService api r d s service swagger:model apiRDSService
func (*APIRDSService) MarshalBinary ¶ added in v1.5.0
func (m *APIRDSService) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIRDSService) UnmarshalBinary ¶ added in v1.5.0
func (m *APIRDSService) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIRemoteInstance ¶ added in v1.16.0
type APIRemoteInstance struct {
// node
Node *APIRemoteNode `json:"node,omitempty"`
// service
Service *APIRemoteService `json:"service,omitempty"`
}
APIRemoteInstance api remote instance swagger:model apiRemoteInstance
func (*APIRemoteInstance) MarshalBinary ¶ added in v1.16.0
func (m *APIRemoteInstance) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIRemoteInstance) UnmarshalBinary ¶ added in v1.16.0
func (m *APIRemoteInstance) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIRemoteListResponse ¶ added in v1.16.0
type APIRemoteListResponse struct {
// instances
Instances []*APIRemoteInstance `json:"instances"`
}
APIRemoteListResponse api remote list response swagger:model apiRemoteListResponse
func (*APIRemoteListResponse) MarshalBinary ¶ added in v1.16.0
func (m *APIRemoteListResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIRemoteListResponse) UnmarshalBinary ¶ added in v1.16.0
func (m *APIRemoteListResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIRemoteNode ¶ added in v1.16.0
type APIRemoteNode struct {
// id
ID int32 `json:"id,omitempty"`
// name
Name string `json:"name,omitempty"`
// region
Region string `json:"region,omitempty"`
}
APIRemoteNode api remote node swagger:model apiRemoteNode
func (*APIRemoteNode) MarshalBinary ¶ added in v1.16.0
func (m *APIRemoteNode) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIRemoteNode) UnmarshalBinary ¶ added in v1.16.0
func (m *APIRemoteNode) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIRemoteService ¶ added in v1.16.0
type APIRemoteService struct {
// address
Address string `json:"address,omitempty"`
// engine
Engine string `json:"engine,omitempty"`
// engine version
EngineVersion string `json:"engine_version,omitempty"`
// port
Port int64 `json:"port,omitempty"`
// type
Type string `json:"type,omitempty"`
}
APIRemoteService api remote service swagger:model apiRemoteService
func (*APIRemoteService) MarshalBinary ¶ added in v1.16.0
func (m *APIRemoteService) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIRemoteService) UnmarshalBinary ¶ added in v1.16.0
func (m *APIRemoteService) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIScrapeConfig ¶
type APIScrapeConfig struct {
// Sets the `Authorization` header on every scrape request with the configured username and password
BasicAuth *APIBasicAuth `json:"basic_auth,omitempty"`
// The job name assigned to scraped metrics by default: "example-job" (required)
JobName string `json:"job_name,omitempty"`
// The HTTP resource path on which to fetch metrics from targets: "/metrics"
MetricsPath string `json:"metrics_path,omitempty"`
// Configures the protocol scheme used for requests: "http" or "https"
Scheme string `json:"scheme,omitempty"`
// How frequently to scrape targets from this job: "10s"
ScrapeInterval string `json:"scrape_interval,omitempty"`
// Per-scrape timeout when scraping this job: "5s"
ScrapeTimeout string `json:"scrape_timeout,omitempty"`
// List of labeled statically configured targets for this job
StaticConfigs []*APIStaticConfig `json:"static_configs"`
// Configures the scrape request's TLS settings
TLSConfig *APITLSConfig `json:"tls_config,omitempty"`
}
APIScrapeConfig api scrape config swagger:model apiScrapeConfig
func (*APIScrapeConfig) MarshalBinary ¶
func (m *APIScrapeConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIScrapeConfig) UnmarshalBinary ¶
func (m *APIScrapeConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIScrapeConfigsCreateRequest ¶
type APIScrapeConfigsCreateRequest struct {
// Check that added targets can be scraped from PMM Server
CheckReachability bool `json:"check_reachability,omitempty"`
// scrape config
ScrapeConfig *APIScrapeConfig `json:"scrape_config,omitempty"`
}
APIScrapeConfigsCreateRequest api scrape configs create request swagger:model apiScrapeConfigsCreateRequest
func (*APIScrapeConfigsCreateRequest) MarshalBinary ¶
func (m *APIScrapeConfigsCreateRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIScrapeConfigsCreateRequest) UnmarshalBinary ¶
func (m *APIScrapeConfigsCreateRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIScrapeConfigsCreateResponse ¶
type APIScrapeConfigsCreateResponse interface{}
APIScrapeConfigsCreateResponse api scrape configs create response swagger:model apiScrapeConfigsCreateResponse
type APIScrapeConfigsDeleteResponse ¶
type APIScrapeConfigsDeleteResponse interface{}
APIScrapeConfigsDeleteResponse api scrape configs delete response swagger:model apiScrapeConfigsDeleteResponse
type APIScrapeConfigsGetResponse ¶
type APIScrapeConfigsGetResponse struct {
// scrape config
ScrapeConfig *APIScrapeConfig `json:"scrape_config,omitempty"`
// Scrape targets health for this scrape job
ScrapeTargetsHealth []*APIScrapeTargetHealth `json:"scrape_targets_health"`
}
APIScrapeConfigsGetResponse api scrape configs get response swagger:model apiScrapeConfigsGetResponse
func (*APIScrapeConfigsGetResponse) MarshalBinary ¶
func (m *APIScrapeConfigsGetResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIScrapeConfigsGetResponse) UnmarshalBinary ¶
func (m *APIScrapeConfigsGetResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIScrapeConfigsListResponse ¶
type APIScrapeConfigsListResponse struct {
// scrape configs
ScrapeConfigs []*APIScrapeConfig `json:"scrape_configs"`
// Scrape targets health for all managed scrape jobs
ScrapeTargetsHealth []*APIScrapeTargetHealth `json:"scrape_targets_health"`
}
APIScrapeConfigsListResponse api scrape configs list response swagger:model apiScrapeConfigsListResponse
func (*APIScrapeConfigsListResponse) MarshalBinary ¶
func (m *APIScrapeConfigsListResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIScrapeConfigsListResponse) UnmarshalBinary ¶
func (m *APIScrapeConfigsListResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIScrapeConfigsUpdateRequest ¶ added in v1.7.0
type APIScrapeConfigsUpdateRequest struct {
// Check that added targets can be scraped from PMM Server
CheckReachability bool `json:"check_reachability,omitempty"`
// scrape config
ScrapeConfig *APIScrapeConfig `json:"scrape_config,omitempty"`
}
APIScrapeConfigsUpdateRequest api scrape configs update request swagger:model apiScrapeConfigsUpdateRequest
func (*APIScrapeConfigsUpdateRequest) MarshalBinary ¶ added in v1.7.0
func (m *APIScrapeConfigsUpdateRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIScrapeConfigsUpdateRequest) UnmarshalBinary ¶ added in v1.7.0
func (m *APIScrapeConfigsUpdateRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIScrapeConfigsUpdateResponse ¶ added in v1.7.0
type APIScrapeConfigsUpdateResponse interface{}
APIScrapeConfigsUpdateResponse api scrape configs update response swagger:model apiScrapeConfigsUpdateResponse
type APIScrapeTargetHealth ¶ added in v1.7.0
type APIScrapeTargetHealth struct {
// health
Health ScrapeTargetHealthHealth `json:"health,omitempty"`
// "instance" label value, may be different from target due to relabeling
Instance string `json:"instance,omitempty"`
// "job" label value, may be different from job_name due to relabeling
Job string `json:"job,omitempty"`
// Original scrape job name
JobName string `json:"job_name,omitempty"`
// Original target
Target string `json:"target,omitempty"`
}
APIScrapeTargetHealth ScrapeTargetHealth represents Prometheus scrape target health: unknown, down, or up. swagger:model apiScrapeTargetHealth
func (*APIScrapeTargetHealth) MarshalBinary ¶ added in v1.7.0
func (m *APIScrapeTargetHealth) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIScrapeTargetHealth) UnmarshalBinary ¶ added in v1.7.0
func (m *APIScrapeTargetHealth) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIStaticConfig ¶
type APIStaticConfig struct {
// Labels assigned to all metrics scraped from the targets
Labels []*APILabelPair `json:"labels"`
// Hostnames or IPs followed by an optional port number: "1.2.3.4:9090"
Targets []string `json:"targets"`
}
APIStaticConfig api static config swagger:model apiStaticConfig
func (*APIStaticConfig) MarshalBinary ¶
func (m *APIStaticConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIStaticConfig) UnmarshalBinary ¶
func (m *APIStaticConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APITLSConfig ¶
type APITLSConfig struct {
// insecure skip verify
InsecureSkipVerify bool `json:"insecure_skip_verify,omitempty"`
}
APITLSConfig api TLS config swagger:model apiTLSConfig
func (*APITLSConfig) MarshalBinary ¶
func (m *APITLSConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APITLSConfig) UnmarshalBinary ¶
func (m *APITLSConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ScrapeTargetHealthHealth ¶ added in v1.7.0
type ScrapeTargetHealthHealth string
ScrapeTargetHealthHealth Target health : unknown, down, or up. swagger:model ScrapeTargetHealthHealth
const ( // ScrapeTargetHealthHealthUNKNOWN captures enum value "UNKNOWN" ScrapeTargetHealthHealthUNKNOWN ScrapeTargetHealthHealth = "UNKNOWN" // ScrapeTargetHealthHealthDOWN captures enum value "DOWN" ScrapeTargetHealthHealthDOWN ScrapeTargetHealthHealth = "DOWN" // ScrapeTargetHealthHealthUP captures enum value "UP" ScrapeTargetHealthHealthUP ScrapeTargetHealthHealth = "UP" )
Source Files
¶
- api_annotations_create_request.go
- api_annotations_create_response.go
- api_base_version_response.go
- api_basic_auth.go
- api_demo_error_response.go
- api_label_pair.go
- api_log.go
- api_logs_all_response.go
- api_my_sql_add_request.go
- api_my_sql_add_response.go
- api_my_sql_instance.go
- api_my_sql_list_response.go
- api_my_sql_node.go
- api_my_sql_remove_response.go
- api_my_sql_service.go
- api_postgre_sql_add_request.go
- api_postgre_sql_add_response.go
- api_postgre_sql_instance.go
- api_postgre_sql_list_response.go
- api_postgre_sql_node.go
- api_postgre_sql_remove_response.go
- api_postgre_sql_service.go
- api_r_d_s_add_request.go
- api_r_d_s_add_response.go
- api_r_d_s_discover_request.go
- api_r_d_s_discover_response.go
- api_r_d_s_instance.go
- api_r_d_s_instance_id.go
- api_r_d_s_list_response.go
- api_r_d_s_node.go
- api_r_d_s_remove_request.go
- api_r_d_s_remove_response.go
- api_r_d_s_service.go
- api_remote_instance.go
- api_remote_list_response.go
- api_remote_node.go
- api_remote_service.go
- api_scrape_config.go
- api_scrape_configs_create_request.go
- api_scrape_configs_create_response.go
- api_scrape_configs_delete_response.go
- api_scrape_configs_get_response.go
- api_scrape_configs_list_response.go
- api_scrape_configs_update_request.go
- api_scrape_configs_update_response.go
- api_scrape_target_health.go
- api_static_config.go
- api_tls_config.go
- scrape_target_health_health.go