cortex

Documentation

Index

• func Scheme(ctx context.Context) meta.Scheme
• type CortexUserIDStats
• type DataFormat
• type MultiTenantRuleAggregator
  • func NewMultiTenantRuleAggregator(client managementv1.ManagementClient, cortexClient *http.Client, ...) *MultiTenantRuleAggregator
  • func (a *MultiTenantRuleAggregator) Handle(c *gin.Context)
• type Plugin
  • func NewPlugin(ctx context.Context) *Plugin
  • func (p *Plugin) AllUserStats(ctx context.Context, _ *emptypb.Empty) (*cortexadmin.UserIDStatsList, error)
  • func (p *Plugin) CanInstall() error
  • func (p *Plugin) ConfigureRoutes(router *gin.Engine)
  • func (p *Plugin) DeleteRule(ctx context.Context, in *cortexadmin.RuleRequest) (*emptypb.Empty, error)
  • func (p *Plugin) GetRule(ctx context.Context, in *cortexadmin.RuleRequest) (*cortexadmin.QueryResponse, error)
  • func (p *Plugin) Install(cluster *corev1.Reference) error
  • func (p *Plugin) InstallerTemplate() string
  • func (p *Plugin) LoadRules(ctx context.Context, in *cortexadmin.YamlRequest) (*emptypb.Empty, error)
  • func (p *Plugin) Query(ctx context.Context, in *cortexadmin.QueryRequest) (*cortexadmin.QueryResponse, error)
  • func (p *Plugin) QueryRange(ctx context.Context, in *cortexadmin.QueryRangeRequest) (*cortexadmin.QueryResponse, error)
  • func (p *Plugin) StreamServers() []streamext.Server
  • func (p *Plugin) Uninstall(clustre *corev1.Reference) error
  • func (p *Plugin) UseManagementAPI(client managementv1.ManagementClient)
  • func (p *Plugin) WriteMetrics(ctx context.Context, in *cortexadmin.WriteRequest) (*cortexadmin.WriteResponse, error)

Functions

func Scheme

func Scheme(ctx context.Context) meta.Scheme

Types

type CortexUserIDStats

type CortexUserIDStats struct {
	UserID            string  `json:"userID"`
	IngestionRate     float64 `json:"ingestionRate"`
	NumSeries         uint64  `json:"numSeries"`
	APIIngestionRate  float64 `json:"APIIngestionRate"`
	RuleIngestionRate float64 `json:"RuleIngestionRate"`
}

this is 'github.com/cortexproject/cortex/pkg/distributor.UserIDStats' but importing it causes impossible dependency errors

type DataFormat

type DataFormat string

const (
	// Rule data formatted as a single YAML document containing yaml-encoded
	// []rulefmt.RuleGroup keyed by tenant ID:
	// <tenantID>:
	//   - name: ...
	//     rules: [...]
	NamespaceKeyedYAML DataFormat = "namespace-keyed-yaml"
	// Rule data formatted as JSON containing the prometheus response metadata
	// and a list of rule groups, each of which has a field "file" containing
	// the tenant ID:
	// {"status":"success","data":{"groups":["file":"<tenantID>", ...]}}
	PrometheusRuleGroupsJSON DataFormat = "prometheus-rule-groups-json"
)

type MultiTenantRuleAggregator

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

func NewMultiTenantRuleAggregator

func NewMultiTenantRuleAggregator(
	client managementv1.ManagementClient,
	cortexClient *http.Client,
	headerCodec rbac.HeaderCodec,
	format DataFormat,
) *MultiTenantRuleAggregator

func (*MultiTenantRuleAggregator) Handle

func (a *MultiTenantRuleAggregator) Handle(c *gin.Context)

type Plugin

type Plugin struct {
	cortexadmin.UnsafeCortexAdminServer
	system.UnimplementedSystemPluginClient
	collector.CollectorServer
	// contains filtered or unexported fields
}

func NewPlugin

func NewPlugin(ctx context.Context) *Plugin

func (*Plugin) AllUserStats

func (p *Plugin) AllUserStats(ctx context.Context, _ *emptypb.Empty) (*cortexadmin.UserIDStatsList, error)

func (*Plugin) CanInstall

func (p *Plugin) CanInstall() error

func (*Plugin) ConfigureRoutes

func (p *Plugin) ConfigureRoutes(router *gin.Engine)

func (*Plugin) DeleteRule

func (p *Plugin) DeleteRule(
	ctx context.Context, in *cortexadmin.RuleRequest,
) (*emptypb.Empty, error)

func (*Plugin) GetRule

func (p *Plugin) GetRule(ctx context.Context,
	in *cortexadmin.RuleRequest,
) (*cortexadmin.QueryResponse, error)

func (*Plugin) Install

func (p *Plugin) Install(cluster *corev1.Reference) error

func (*Plugin) InstallerTemplate

func (p *Plugin) InstallerTemplate() string

func (*Plugin) LoadRules

func (p *Plugin) LoadRules(ctx context.Context,
	in *cortexadmin.YamlRequest,
) (*emptypb.Empty, error)

This method is responsible for Creating and Updating Rules

func (*Plugin) Query

func (p *Plugin) Query(
	ctx context.Context,
	in *cortexadmin.QueryRequest,
) (*cortexadmin.QueryResponse, error)

func (*Plugin) QueryRange

func (p *Plugin) QueryRange(
	ctx context.Context,
	in *cortexadmin.QueryRangeRequest,
) (*cortexadmin.QueryResponse, error)

func (*Plugin) StreamServers

func (p *Plugin) StreamServers() []streamext.Server

func (*Plugin) Uninstall

func (p *Plugin) Uninstall(clustre *corev1.Reference) error

func (*Plugin) UseManagementAPI

func (p *Plugin) UseManagementAPI(client managementv1.ManagementClient)

func (*Plugin) WriteMetrics

func (p *Plugin) WriteMetrics(ctx context.Context, in *cortexadmin.WriteRequest) (*cortexadmin.WriteResponse, error)