Documentation
¶
Index ¶
- Constants
- Variables
- func FormatTime(t time.Time) string
- func GetDefaultImage() string
- type Client
- func (c *Client) DeleteAlertmanagerConfig(ctx context.Context) error
- func (c *Client) DeleteRuleGroup(namespace string, groupName string) error
- func (c *Client) DeleteRuleNamespace(namespace string) error
- func (c *Client) GetAlertmanagerConfig(ctx context.Context) (*alertConfig.Config, error)
- func (c *Client) GetRuleGroups() (map[string][]rulefmt.RuleGroup, error)
- func (c *Client) LabelNames(start, end time.Time) ([]string, error)
- func (c *Client) LabelValues(label string, start, end time.Time) (model.LabelValues, error)
- func (c *Client) PostRequest(url string, body io.Reader) (*http.Response, error)
- func (c *Client) Push(timeseries []prompb.TimeSeries) (*http.Response, error)
- func (c *Client) Query(query string, ts time.Time) (model.Value, error)
- func (c *Client) QueryRange(query string, start, end time.Time, step time.Duration) (model.Value, error)
- func (c *Client) QueryRangeRaw(query string, start, end time.Time, step time.Duration) (*http.Response, []byte, error)
- func (c *Client) QueryRaw(query string) (*http.Response, []byte, error)
- func (c *Client) SendAlertToAlermanager(ctx context.Context, alert *model.Alert) error
- func (c *Client) Series(matches []string, start, end time.Time) ([]model.LabelSet, error)
- func (c *Client) SetAlertmanagerConfig(ctx context.Context, amConfig string, templates map[string]string) error
- func (c *Client) SetRuleGroup(rulegroup rulefmt.RuleGroup, namespace string) error
- type CompositeCortexService
- type CortexService
- func NewAlertmanager(name string, flags map[string]string, image string) *CortexService
- func NewCompactor(name string, consulAddress string, flags map[string]string, image string) *CortexService
- func NewCompactorWithConfigFile(name, consulAddress, configFile string, flags map[string]string, image string) *CortexService
- func NewCortexService(name string, image string, command *e2e.Command, readiness e2e.ReadinessProbe, ...) *CortexService
- func NewDistributor(name string, consulAddress string, flags map[string]string, image string) *CortexService
- func NewDistributorWithConfigFile(name, consulAddress, configFile string, flags map[string]string, image string) *CortexService
- func NewIngester(name string, consulAddress string, flags map[string]string, image string) *CortexService
- func NewIngesterWithConfigFile(name, consulAddress, configFile string, flags map[string]string, image string) *CortexService
- func NewPurger(name string, flags map[string]string, image string) *CortexService
- func NewPurgerWithConfigFile(name, configFile string, flags map[string]string, image string) *CortexService
- func NewQuerier(name string, consulAddress string, flags map[string]string, image string) *CortexService
- func NewQuerierWithConfigFile(name, consulAddress, configFile string, flags map[string]string, image string) *CortexService
- func NewQueryFrontend(name string, flags map[string]string, image string) *CortexService
- func NewQueryFrontendWithConfigFile(name, configFile string, flags map[string]string, image string) *CortexService
- func NewQueryScheduler(name string, flags map[string]string, image string) *CortexService
- func NewQuerySchedulerWithConfigFile(name, configFile string, flags map[string]string, image string) *CortexService
- func NewRuler(name string, flags map[string]string, image string) *CortexService
- func NewSingleBinary(name string, flags map[string]string, image string, otherPorts ...int) *CortexService
- func NewSingleBinaryWithConfigFile(name string, configFile string, flags map[string]string, image string, ...) *CortexService
- func NewStoreGateway(name string, consulAddress string, flags map[string]string, image string) *CortexService
- func NewStoreGatewayWithConfigFile(name, consulAddress, configFile string, flags map[string]string, image string) *CortexService
- func NewTableManager(name string, flags map[string]string, image string) *CortexService
- func NewTableManagerWithConfigFile(name, configFile string, flags map[string]string, image string) *CortexService
- type S3Client
- type ServerStatus
Constants ¶
const (
GossipPort = 9094
)
Variables ¶
var (
ErrNotFound = errors.New("not found")
)
Functions ¶
func FormatTime ¶ added in v1.4.0
func FormatTime(t time.Time) string
FormatTime converts a time to a string acceptable by the Prometheus API.
func GetDefaultImage ¶
func GetDefaultImage() string
GetDefaultImage returns the Docker image to use to run Cortex.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is a client used to interact with Cortex in integration tests
func NewClient ¶
func NewClient(
distributorAddress string,
querierAddress string,
alertmanagerAddress string,
rulerAddress string,
orgID string,
) (*Client, error)
NewClient makes a new Cortex client
func (*Client) DeleteAlertmanagerConfig ¶ added in v1.3.0
func (c *Client) DeleteAlertmanagerConfig(ctx context.Context) error
DeleteAlertmanagerConfig gets the status of an alertmanager instance
func (*Client) DeleteRuleGroup ¶ added in v1.0.0
func (c *Client) DeleteRuleGroup(namespace string, groupName string) error
DeleteRuleGroup gets the status of an alertmanager instance
func (*Client) DeleteRuleNamespace ¶ added in v1.4.0
func (c *Client) DeleteRuleNamespace(namespace string) error
DeleteRuleNamespace deletes all the rule groups (and the namespace itself).
func (*Client) GetAlertmanagerConfig ¶
func (c *Client) GetAlertmanagerConfig(ctx context.Context) (*alertConfig.Config, error)
GetAlertmanagerConfig gets the status of an alertmanager instance
func (*Client) GetRuleGroups ¶ added in v1.0.0
func (c *Client) GetRuleGroups() (map[string][]rulefmt.RuleGroup, error)
GetRuleGroups gets the status of an alertmanager instance
func (*Client) LabelNames ¶ added in v1.1.0
func (c *Client) LabelNames(start, end time.Time) ([]string, error)
LabelNames gets label names
func (*Client) LabelValues ¶ added in v1.1.0
func (c *Client) LabelValues(label string, start, end time.Time) (model.LabelValues, error)
LabelValues gets label values
func (*Client) PostRequest ¶ added in v1.4.0
func (c *Client) PostRequest(url string, body io.Reader) (*http.Response, error)
func (*Client) Push ¶
func (c *Client) Push(timeseries []prompb.TimeSeries) (*http.Response, error)
Push the input timeseries to the remote endpoint
func (*Client) Query ¶
func (c *Client) Query(query string, ts time.Time) (model.Value, error)
Query runs an instant query.
func (*Client) QueryRange ¶ added in v1.4.0
func (c *Client) QueryRange(query string, start, end time.Time, step time.Duration) (model.Value, error)
Query runs a query range.
func (*Client) QueryRangeRaw ¶ added in v1.4.0
func (c *Client) QueryRangeRaw(query string, start, end time.Time, step time.Duration) (*http.Response, []byte, error)
QueryRangeRaw runs a ranged query directly against the querier API.
func (*Client) QueryRaw ¶ added in v1.2.0
func (c *Client) QueryRaw(query string) (*http.Response, []byte, error)
QueryRaw runs a query directly against the querier API.
func (*Client) SendAlertToAlermanager ¶ added in v1.4.0
func (c *Client) SendAlertToAlermanager(ctx context.Context, alert *model.Alert) error
SendAlertToAlermanager sends alerts to the Alertmanager API
func (*Client) Series ¶ added in v1.3.0
func (c *Client) Series(matches []string, start, end time.Time) ([]model.LabelSet, error)
Series finds series by label matchers.
func (*Client) SetAlertmanagerConfig ¶ added in v1.3.0
func (c *Client) SetAlertmanagerConfig(ctx context.Context, amConfig string, templates map[string]string) error
SetAlertmanagerConfig gets the status of an alertmanager instance
func (*Client) SetRuleGroup ¶ added in v1.0.0
func (c *Client) SetRuleGroup(rulegroup rulefmt.RuleGroup, namespace string) error
SetRuleGroup gets the status of an alertmanager instance
type CompositeCortexService ¶ added in v1.1.0
type CompositeCortexService struct {
*e2e.CompositeHTTPService
}
CompositeCortexService abstract an higher-level service composed, under the hood, by 2+ CortexService.
func NewCompositeCortexService ¶ added in v1.1.0
func NewCompositeCortexService(services ...*CortexService) *CompositeCortexService
type CortexService ¶
type CortexService struct {
*e2e.HTTPService
// contains filtered or unexported fields
}
CortexService represents a Cortex service with at least an HTTP and GRPC port exposed.
func NewAlertmanager ¶
func NewAlertmanager(name string, flags map[string]string, image string) *CortexService
func NewCompactor ¶ added in v1.7.0
func NewCompactor(name string, consulAddress string, flags map[string]string, image string) *CortexService
func NewCompactorWithConfigFile ¶ added in v1.7.0
func NewCompactorWithConfigFile(name, consulAddress, configFile string, flags map[string]string, image string) *CortexService
func NewCortexService ¶
func NewCortexService(
name string,
image string,
command *e2e.Command,
readiness e2e.ReadinessProbe,
httpPort int,
grpcPort int,
otherPorts ...int,
) *CortexService
func NewDistributor ¶
func NewDistributor(name string, consulAddress string, flags map[string]string, image string) *CortexService
func NewDistributorWithConfigFile ¶
func NewDistributorWithConfigFile(name, consulAddress, configFile string, flags map[string]string, image string) *CortexService
func NewIngester ¶
func NewIngester(name string, consulAddress string, flags map[string]string, image string) *CortexService
func NewIngesterWithConfigFile ¶
func NewIngesterWithConfigFile(name, consulAddress, configFile string, flags map[string]string, image string) *CortexService
func NewPurger ¶ added in v1.4.0
func NewPurger(name string, flags map[string]string, image string) *CortexService
func NewPurgerWithConfigFile ¶ added in v1.4.0
func NewPurgerWithConfigFile(name, configFile string, flags map[string]string, image string) *CortexService
func NewQuerier ¶
func NewQuerier(name string, consulAddress string, flags map[string]string, image string) *CortexService
func NewQuerierWithConfigFile ¶
func NewQuerierWithConfigFile(name, consulAddress, configFile string, flags map[string]string, image string) *CortexService
func NewQueryFrontend ¶
func NewQueryFrontend(name string, flags map[string]string, image string) *CortexService
func NewQueryFrontendWithConfigFile ¶
func NewQueryFrontendWithConfigFile(name, configFile string, flags map[string]string, image string) *CortexService
func NewQueryScheduler ¶ added in v1.6.0
func NewQueryScheduler(name string, flags map[string]string, image string) *CortexService
func NewQuerySchedulerWithConfigFile ¶ added in v1.6.0
func NewQuerySchedulerWithConfigFile(name, configFile string, flags map[string]string, image string) *CortexService
func NewRuler ¶ added in v1.0.0
func NewRuler(name string, flags map[string]string, image string) *CortexService
func NewSingleBinary ¶
func NewSingleBinary(name string, flags map[string]string, image string, otherPorts ...int) *CortexService
func NewSingleBinaryWithConfigFile ¶ added in v1.1.0
func NewSingleBinaryWithConfigFile(name string, configFile string, flags map[string]string, image string, httpPort, grpcPort int, otherPorts ...int) *CortexService
func NewStoreGateway ¶ added in v1.1.0
func NewStoreGateway(name string, consulAddress string, flags map[string]string, image string) *CortexService
func NewStoreGatewayWithConfigFile ¶ added in v1.1.0
func NewStoreGatewayWithConfigFile(name, consulAddress, configFile string, flags map[string]string, image string) *CortexService
func NewTableManager ¶
func NewTableManager(name string, flags map[string]string, image string) *CortexService
func NewTableManagerWithConfigFile ¶
func NewTableManagerWithConfigFile(name, configFile string, flags map[string]string, image string) *CortexService
func (*CortexService) GRPCEndpoint ¶
func (s *CortexService) GRPCEndpoint() string
func (*CortexService) NetworkGRPCEndpoint ¶
func (s *CortexService) NetworkGRPCEndpoint() string
type S3Client ¶
type S3Client struct {
// contains filtered or unexported fields
}
func NewS3Client ¶
func NewS3Client(cfg s3.Config) (*S3Client, error)
func NewS3ClientForMinio ¶
func NewS3ClientForMinio(minio *e2e.HTTPService, bucketName string) (*S3Client, error)
func (*S3Client) Delete ¶
func (c *S3Client) Delete(prefix string) error
Delete recursively deletes every object within the input prefix.
func (*S3Client) DeleteBlock ¶
func (c *S3Client) DeleteBlock(userID, blockID string) error
DeleteBlock deletes a single block.
func (*S3Client) DeleteBlocks ¶
func (c *S3Client) DeleteBlocks(userID string) error
DeleteBlocks deletes all blocks for a tenant.
type ServerStatus ¶
type ServerStatus struct {
Data struct {
ConfigYaml string `json:"configYAML"`
} `json:"data"`
}
ServerStatus represents a Alertmanager status response TODO: Upgrade to Alertmanager v0.20.0+ and utilize vendored structs