Documentation ¶
Index ¶
- type APIBaseVersionResponse
- type APIBasicAuth
- type APIDemoErrorResponse
- type APILabelPair
- type APIRDSAddRequest
- type APIRDSAddResponse
- type APIRDSDiscoverRequest
- type APIRDSDiscoverResponse
- type APIRDSInstance
- type APIRDSInstanceID
- type APIRDSListResponse
- type APIRDSNode
- type APIRDSRemoveRequest
- type APIRDSRemoveResponse
- type APIRDSService
- 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 APIBaseVersionResponse ¶
type APIBaseVersionResponse struct { // version Version string `json:"version,omitempty"` }
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"` }
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{}
type APILabelPair ¶
type APILabelPair struct { // Label name Name string `json:"name,omitempty"` // Label value Value string `json:"value,omitempty"` }
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 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"` }
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{}
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"` }
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"` }
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"` }
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"` }
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"` }
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"` }
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"` }
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{}
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"` }
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 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"` }
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"` }
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{}
type APIScrapeConfigsDeleteResponse ¶
type APIScrapeConfigsDeleteResponse interface{}
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"` }
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"` }
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"` }
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{}
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"` }
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"` }
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"` }
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
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_base_version_response.go
- api_basic_auth.go
- api_demo_error_response.go
- api_label_pair.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_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