Documentation ¶
Index ¶
- Constants
- Variables
- func BuildConfigureClusterCmd() *cobra.Command
- func BuildCortexOpsCmd() *cobra.Command
- func BuildGetClusterConfigurationCmd() *cobra.Command
- func BuildGetClusterStatusCmd() *cobra.Command
- func BuildUninstallClusterCmd() *cobra.Command
- func ContextWithCortexOpsClient(ctx context.Context, client CortexOpsClient) context.Context
- func RegisterCortexOpsServer(s grpc.ServiceRegistrar, srv CortexOpsServer)
- type ClusterConfiguration
- func (*ClusterConfiguration) Descriptor() ([]byte, []int)deprecated
- func (in *ClusterConfiguration) FlagSet(prefix ...string) *pflag.FlagSet
- func (x *ClusterConfiguration) GetCortex() *CortexConfig
- func (x *ClusterConfiguration) GetGrafana() *GrafanaConfig
- func (x *ClusterConfiguration) GetMode() DeploymentMode
- func (x *ClusterConfiguration) GetStorage() *v1.StorageSpec
- func (x *ClusterConfiguration) GetWorkloads() *Workloads
- func (*ClusterConfiguration) ProtoMessage()
- func (x *ClusterConfiguration) ProtoReflect() protoreflect.Message
- func (in *ClusterConfiguration) RedactSecrets()
- func (x *ClusterConfiguration) Reset()
- func (x *ClusterConfiguration) String() string
- func (in *ClusterConfiguration) UnredactSecrets(unredacted *ClusterConfiguration) error
- type CompactorConfig
- func (*CompactorConfig) Descriptor() ([]byte, []int)deprecated
- func (in *CompactorConfig) FlagSet(prefix ...string) *pflag.FlagSet
- func (x *CompactorConfig) GetBlockRanges() []*durationpb.Duration
- func (x *CompactorConfig) GetCleanupInterval() *durationpb.Duration
- func (x *CompactorConfig) GetCompactionInterval() *durationpb.Duration
- func (x *CompactorConfig) GetDeletionDelay() *durationpb.Duration
- func (x *CompactorConfig) GetTenantCleanupDelay() *durationpb.Duration
- func (*CompactorConfig) ProtoMessage()
- func (x *CompactorConfig) ProtoReflect() protoreflect.Message
- func (x *CompactorConfig) Reset()
- func (x *CompactorConfig) String() string
- type CortexConfig
- func (*CortexConfig) Descriptor() ([]byte, []int)deprecated
- func (in *CortexConfig) FlagSet(prefix ...string) *pflag.FlagSet
- func (x *CortexConfig) GetCompactor() *CompactorConfig
- func (x *CortexConfig) GetDistributor() *DistributorConfig
- func (x *CortexConfig) GetIngester() *IngesterConfig
- func (x *CortexConfig) GetQuerier() *QuerierConfig
- func (*CortexConfig) ProtoMessage()
- func (x *CortexConfig) ProtoReflect() protoreflect.Message
- func (x *CortexConfig) Reset()
- func (x *CortexConfig) String() string
- type CortexOpsClient
- type CortexOpsServer
- type CortexWorkloadSpec
- func (*CortexWorkloadSpec) Descriptor() ([]byte, []int)deprecated
- func (in *CortexWorkloadSpec) FlagSet(prefix ...string) *pflag.FlagSet
- func (x *CortexWorkloadSpec) GetExtraArgs() []string
- func (x *CortexWorkloadSpec) GetReplicas() int32
- func (*CortexWorkloadSpec) ProtoMessage()
- func (x *CortexWorkloadSpec) ProtoReflect() protoreflect.Message
- func (x *CortexWorkloadSpec) Reset()
- func (x *CortexWorkloadSpec) String() string
- type DeploymentMode
- func (DeploymentMode) Descriptor() protoreflect.EnumDescriptor
- func (x DeploymentMode) Enum() *DeploymentMode
- func (DeploymentMode) EnumDescriptor() ([]byte, []int)deprecated
- func (x DeploymentMode) Number() protoreflect.EnumNumber
- func (x DeploymentMode) String() string
- func (DeploymentMode) Type() protoreflect.EnumType
- type DistributorConfig
- func (*DistributorConfig) Descriptor() ([]byte, []int)deprecated
- func (in *DistributorConfig) FlagSet(prefix ...string) *pflag.FlagSet
- func (x *DistributorConfig) GetIngestionBurstSize() int32
- func (x *DistributorConfig) GetIngestionRate() float64
- func (x *DistributorConfig) GetIngestionRateStrategy() string
- func (*DistributorConfig) ProtoMessage()
- func (x *DistributorConfig) ProtoReflect() protoreflect.Message
- func (x *DistributorConfig) Reset()
- func (x *DistributorConfig) String() string
- type GrafanaConfig
- func (*GrafanaConfig) Descriptor() ([]byte, []int)deprecated
- func (in *GrafanaConfig) FlagSet(prefix ...string) *pflag.FlagSet
- func (x *GrafanaConfig) GetEnabled() bool
- func (x *GrafanaConfig) GetHostname() string
- func (*GrafanaConfig) ProtoMessage()
- func (x *GrafanaConfig) ProtoReflect() protoreflect.Message
- func (x *GrafanaConfig) Reset()
- func (x *GrafanaConfig) String() string
- type IngesterConfig
- func (*IngesterConfig) Descriptor() ([]byte, []int)deprecated
- func (in *IngesterConfig) FlagSet(prefix ...string) *pflag.FlagSet
- func (x *IngesterConfig) GetMaxGlobalMetadataPerMetric() int32
- func (x *IngesterConfig) GetMaxGlobalMetricsWithMetadataPerUser() int32
- func (x *IngesterConfig) GetMaxGlobalSeriesPerMetric() int32
- func (x *IngesterConfig) GetMaxGlobalSeriesPerUser() int32
- func (x *IngesterConfig) GetMaxLocalMetadataPerMetric() int32
- func (x *IngesterConfig) GetMaxLocalMetricsWithMetadataPerUser() int32
- func (x *IngesterConfig) GetMaxLocalSeriesPerMetric() int32
- func (x *IngesterConfig) GetMaxLocalSeriesPerUser() int32
- func (*IngesterConfig) ProtoMessage()
- func (x *IngesterConfig) ProtoReflect() protoreflect.Message
- func (x *IngesterConfig) Reset()
- func (x *IngesterConfig) String() string
- type InstallState
- func (InstallState) Descriptor() protoreflect.EnumDescriptor
- func (x InstallState) Enum() *InstallState
- func (InstallState) EnumDescriptor() ([]byte, []int)deprecated
- func (x InstallState) Number() protoreflect.EnumNumber
- func (x InstallState) String() string
- func (InstallState) Type() protoreflect.EnumType
- type InstallStatus
- func (*InstallStatus) Descriptor() ([]byte, []int)deprecated
- func (x *InstallStatus) GetMetadata() map[string]string
- func (x *InstallStatus) GetState() InstallState
- func (x *InstallStatus) GetVersion() string
- func (*InstallStatus) ProtoMessage()
- func (x *InstallStatus) ProtoReflect() protoreflect.Message
- func (s *InstallStatus) RenderText(out cli.Writer)
- func (x *InstallStatus) Reset()
- func (x *InstallStatus) String() string
- type OpsClientOption
- type OpsClientOptions
- type QuerierConfig
- func (*QuerierConfig) Descriptor() ([]byte, []int)deprecated
- func (in *QuerierConfig) FlagSet(prefix ...string) *pflag.FlagSet
- func (x *QuerierConfig) GetDefaultEvaluationInterval() *durationpb.Duration
- func (x *QuerierConfig) GetLookbackDelta() *durationpb.Duration
- func (x *QuerierConfig) GetMaxFetchedSeriesPerQuery() int32
- func (x *QuerierConfig) GetMaxQueryIntoFuture() *durationpb.Duration
- func (x *QuerierConfig) GetMaxSamples() int32
- func (x *QuerierConfig) GetQueryIngestersWithin() *durationpb.Duration
- func (x *QuerierConfig) GetQueryStoreAfter() *durationpb.Duration
- func (x *QuerierConfig) GetQueryTimeout() *durationpb.Duration
- func (x *QuerierConfig) GetShuffleShardingIngestersLookbackPeriod() *durationpb.Duration
- func (*QuerierConfig) ProtoMessage()
- func (x *QuerierConfig) ProtoReflect() protoreflect.Message
- func (x *QuerierConfig) Reset()
- func (x *QuerierConfig) String() string
- type UnimplementedCortexOpsServer
- func (UnimplementedCortexOpsServer) ConfigureCluster(context.Context, *ClusterConfiguration) (*emptypb.Empty, error)
- func (UnimplementedCortexOpsServer) GetClusterConfiguration(context.Context, *emptypb.Empty) (*ClusterConfiguration, error)
- func (UnimplementedCortexOpsServer) GetClusterStatus(context.Context, *emptypb.Empty) (*InstallStatus, error)
- func (UnimplementedCortexOpsServer) UninstallCluster(context.Context, *emptypb.Empty) (*emptypb.Empty, error)
- type UnsafeCortexOpsServer
- type Workloads
- func (*Workloads) Descriptor() ([]byte, []int)deprecated
- func (in *Workloads) FlagSet(prefix ...string) *pflag.FlagSet
- func (x *Workloads) GetCompactor() *CortexWorkloadSpec
- func (x *Workloads) GetDistributor() *CortexWorkloadSpec
- func (x *Workloads) GetIngester() *CortexWorkloadSpec
- func (x *Workloads) GetPurger() *CortexWorkloadSpec
- func (x *Workloads) GetQuerier() *CortexWorkloadSpec
- func (x *Workloads) GetQueryFrontend() *CortexWorkloadSpec
- func (x *Workloads) GetRuler() *CortexWorkloadSpec
- func (x *Workloads) GetStoreGateway() *CortexWorkloadSpec
- func (*Workloads) ProtoMessage()
- func (x *Workloads) ProtoReflect() protoreflect.Message
- func (x *Workloads) Reset()
- func (x *Workloads) String() string
Constants ¶
const ( CortexOps_GetClusterConfiguration_FullMethodName = "/cortexops.CortexOps/GetClusterConfiguration" CortexOps_ConfigureCluster_FullMethodName = "/cortexops.CortexOps/ConfigureCluster" CortexOps_GetClusterStatus_FullMethodName = "/cortexops.CortexOps/GetClusterStatus" CortexOps_UninstallCluster_FullMethodName = "/cortexops.CortexOps/UninstallCluster" )
Variables ¶
var ( InstallState_name = map[int32]string{ 0: "Unknown", 1: "NotInstalled", 2: "Updating", 3: "Installed", 4: "Uninstalling", } InstallState_value = map[string]int32{ "Unknown": 0, "NotInstalled": 1, "Updating": 2, "Installed": 3, "Uninstalling": 4, } )
Enum value maps for InstallState.
var ( DeploymentMode_name = map[int32]string{ 0: "AllInOne", 1: "HighlyAvailable", } DeploymentMode_value = map[string]int32{ "AllInOne": 0, "HighlyAvailable": 1, } )
Enum value maps for DeploymentMode.
var CortexOps_ServiceDesc = grpc.ServiceDesc{ ServiceName: "cortexops.CortexOps", HandlerType: (*CortexOpsServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetClusterConfiguration", Handler: _CortexOps_GetClusterConfiguration_Handler, }, { MethodName: "ConfigureCluster", Handler: _CortexOps_ConfigureCluster_Handler, }, { MethodName: "GetClusterStatus", Handler: _CortexOps_GetClusterStatus_Handler, }, { MethodName: "UninstallCluster", Handler: _CortexOps_UninstallCluster_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "github.com/rancher/opni/plugins/metrics/apis/cortexops/cortexops.proto", }
CortexOps_ServiceDesc is the grpc.ServiceDesc for CortexOps service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_github_com_rancher_opni_plugins_metrics_apis_cortexops_cortexops_proto protoreflect.FileDescriptor
Functions ¶
func BuildCortexOpsCmd ¶
func ContextWithCortexOpsClient ¶
func ContextWithCortexOpsClient(ctx context.Context, client CortexOpsClient) context.Context
func RegisterCortexOpsServer ¶
func RegisterCortexOpsServer(s grpc.ServiceRegistrar, srv CortexOpsServer)
Types ¶
type ClusterConfiguration ¶
type ClusterConfiguration struct { // The deployment mode to use for Cortex. Mode DeploymentMode `protobuf:"varint,1,opt,name=mode,proto3,enum=cortexops.DeploymentMode" json:"mode,omitempty"` Storage *v1.StorageSpec `protobuf:"bytes,2,opt,name=storage,proto3" json:"storage,omitempty"` Grafana *GrafanaConfig `protobuf:"bytes,3,opt,name=grafana,proto3" json:"grafana,omitempty"` Workloads *Workloads `protobuf:"bytes,4,opt,name=workloads,proto3" json:"workloads,omitempty"` Cortex *CortexConfig `protobuf:"bytes,5,opt,name=cortex,proto3" json:"cortex,omitempty"` // contains filtered or unexported fields }
func (*ClusterConfiguration) Descriptor
deprecated
func (*ClusterConfiguration) Descriptor() ([]byte, []int)
Deprecated: Use ClusterConfiguration.ProtoReflect.Descriptor instead.
func (*ClusterConfiguration) FlagSet ¶
func (in *ClusterConfiguration) FlagSet(prefix ...string) *pflag.FlagSet
func (*ClusterConfiguration) GetCortex ¶
func (x *ClusterConfiguration) GetCortex() *CortexConfig
func (*ClusterConfiguration) GetGrafana ¶
func (x *ClusterConfiguration) GetGrafana() *GrafanaConfig
func (*ClusterConfiguration) GetMode ¶
func (x *ClusterConfiguration) GetMode() DeploymentMode
func (*ClusterConfiguration) GetStorage ¶
func (x *ClusterConfiguration) GetStorage() *v1.StorageSpec
func (*ClusterConfiguration) GetWorkloads ¶
func (x *ClusterConfiguration) GetWorkloads() *Workloads
func (*ClusterConfiguration) ProtoMessage ¶
func (*ClusterConfiguration) ProtoMessage()
func (*ClusterConfiguration) ProtoReflect ¶
func (x *ClusterConfiguration) ProtoReflect() protoreflect.Message
func (*ClusterConfiguration) RedactSecrets ¶
func (in *ClusterConfiguration) RedactSecrets()
func (*ClusterConfiguration) Reset ¶
func (x *ClusterConfiguration) Reset()
func (*ClusterConfiguration) String ¶
func (x *ClusterConfiguration) String() string
func (*ClusterConfiguration) UnredactSecrets ¶
func (in *ClusterConfiguration) UnredactSecrets(unredacted *ClusterConfiguration) error
type CompactorConfig ¶
type CompactorConfig struct { // List of compaction time ranges BlockRanges []*durationpb.Duration `protobuf:"bytes,1,rep,name=blockRanges,proto3" json:"blockRanges,omitempty"` // The frequency at which the compaction runs CompactionInterval *durationpb.Duration `protobuf:"bytes,2,opt,name=compactionInterval,proto3" json:"compactionInterval,omitempty"` // How frequently compactor should run blocks cleanup and maintenance, as well as update the bucket index CleanupInterval *durationpb.Duration `protobuf:"bytes,3,opt,name=cleanupInterval,proto3" json:"cleanupInterval,omitempty"` // Time before a block marked for deletion is deleted from the bucket DeletionDelay *durationpb.Duration `protobuf:"bytes,4,opt,name=deletionDelay,proto3" json:"deletionDelay,omitempty"` // For tenants marked for deletion, this is time between deleting of last block, and doing final cleanup (marker files, debug files) of the tenant TenantCleanupDelay *durationpb.Duration `protobuf:"bytes,5,opt,name=tenantCleanupDelay,proto3" json:"tenantCleanupDelay,omitempty"` // contains filtered or unexported fields }
func (*CompactorConfig) Descriptor
deprecated
func (*CompactorConfig) Descriptor() ([]byte, []int)
Deprecated: Use CompactorConfig.ProtoReflect.Descriptor instead.
func (*CompactorConfig) FlagSet ¶
func (in *CompactorConfig) FlagSet(prefix ...string) *pflag.FlagSet
func (*CompactorConfig) GetBlockRanges ¶
func (x *CompactorConfig) GetBlockRanges() []*durationpb.Duration
func (*CompactorConfig) GetCleanupInterval ¶
func (x *CompactorConfig) GetCleanupInterval() *durationpb.Duration
func (*CompactorConfig) GetCompactionInterval ¶
func (x *CompactorConfig) GetCompactionInterval() *durationpb.Duration
func (*CompactorConfig) GetDeletionDelay ¶
func (x *CompactorConfig) GetDeletionDelay() *durationpb.Duration
func (*CompactorConfig) GetTenantCleanupDelay ¶
func (x *CompactorConfig) GetTenantCleanupDelay() *durationpb.Duration
func (*CompactorConfig) ProtoMessage ¶
func (*CompactorConfig) ProtoMessage()
func (*CompactorConfig) ProtoReflect ¶
func (x *CompactorConfig) ProtoReflect() protoreflect.Message
func (*CompactorConfig) Reset ¶
func (x *CompactorConfig) Reset()
func (*CompactorConfig) String ¶
func (x *CompactorConfig) String() string
type CortexConfig ¶
type CortexConfig struct { Compactor *CompactorConfig `protobuf:"bytes,1,opt,name=compactor,proto3" json:"compactor,omitempty"` Querier *QuerierConfig `protobuf:"bytes,2,opt,name=querier,proto3" json:"querier,omitempty"` Distributor *DistributorConfig `protobuf:"bytes,3,opt,name=distributor,proto3" json:"distributor,omitempty"` Ingester *IngesterConfig `protobuf:"bytes,4,opt,name=ingester,proto3" json:"ingester,omitempty"` // contains filtered or unexported fields }
func (*CortexConfig) Descriptor
deprecated
func (*CortexConfig) Descriptor() ([]byte, []int)
Deprecated: Use CortexConfig.ProtoReflect.Descriptor instead.
func (*CortexConfig) GetCompactor ¶
func (x *CortexConfig) GetCompactor() *CompactorConfig
func (*CortexConfig) GetDistributor ¶
func (x *CortexConfig) GetDistributor() *DistributorConfig
func (*CortexConfig) GetIngester ¶
func (x *CortexConfig) GetIngester() *IngesterConfig
func (*CortexConfig) GetQuerier ¶
func (x *CortexConfig) GetQuerier() *QuerierConfig
func (*CortexConfig) ProtoMessage ¶
func (*CortexConfig) ProtoMessage()
func (*CortexConfig) ProtoReflect ¶
func (x *CortexConfig) ProtoReflect() protoreflect.Message
func (*CortexConfig) Reset ¶
func (x *CortexConfig) Reset()
func (*CortexConfig) String ¶
func (x *CortexConfig) String() string
type CortexOpsClient ¶
type CortexOpsClient interface { // Gets the current configuration of the managed Cortex cluster. GetClusterConfiguration(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*ClusterConfiguration, error) // Updates the configuration of the managed Cortex cluster to match the provided configuration. // If the cluster is not installed, it will be configured and installed. // Otherwise, the already-installed cluster will be reconfigured. // // Note: some fields may contain secrets. The placeholder value "***" can be used to // keep an existing secret when updating the cluster configuration. ConfigureCluster(ctx context.Context, in *ClusterConfiguration, opts ...grpc.CallOption) (*emptypb.Empty, error) // Gets the current status of the managed Cortex cluster. // The status includes the current install state, version, and metadata. If // the cluster is in the process of being reconfigured or uninstalled, it will // be reflected in the install state. // No guarantees are made about the contents of the metadata field; its // contents are strictly informational. GetClusterStatus(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*InstallStatus, error) // Uninstalls the managed Cortex cluster. // Implementation details including error handling and system state requirements // are left to the cluster driver, and this API makes no guarantees about // the state of the cluster after the call completes (regardless of success). UninstallCluster(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*emptypb.Empty, error) }
CortexOpsClient is the client API for CortexOps service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func CortexOpsClientFromContext ¶
func CortexOpsClientFromContext(ctx context.Context) (CortexOpsClient, bool)
func NewClient ¶
func NewClient(ctx waitctx.PermissiveContext, opts ...OpsClientOption) (CortexOpsClient, error)
func NewCortexOpsClient ¶
func NewCortexOpsClient(cc grpc.ClientConnInterface) CortexOpsClient
type CortexOpsServer ¶
type CortexOpsServer interface { // Gets the current configuration of the managed Cortex cluster. GetClusterConfiguration(context.Context, *emptypb.Empty) (*ClusterConfiguration, error) // Updates the configuration of the managed Cortex cluster to match the provided configuration. // If the cluster is not installed, it will be configured and installed. // Otherwise, the already-installed cluster will be reconfigured. // // Note: some fields may contain secrets. The placeholder value "***" can be used to // keep an existing secret when updating the cluster configuration. ConfigureCluster(context.Context, *ClusterConfiguration) (*emptypb.Empty, error) // Gets the current status of the managed Cortex cluster. // The status includes the current install state, version, and metadata. If // the cluster is in the process of being reconfigured or uninstalled, it will // be reflected in the install state. // No guarantees are made about the contents of the metadata field; its // contents are strictly informational. GetClusterStatus(context.Context, *emptypb.Empty) (*InstallStatus, error) // Uninstalls the managed Cortex cluster. // Implementation details including error handling and system state requirements // are left to the cluster driver, and this API makes no guarantees about // the state of the cluster after the call completes (regardless of success). UninstallCluster(context.Context, *emptypb.Empty) (*emptypb.Empty, error) // contains filtered or unexported methods }
CortexOpsServer is the server API for CortexOps service. All implementations must embed UnimplementedCortexOpsServer for forward compatibility
type CortexWorkloadSpec ¶
type CortexWorkloadSpec struct { // Number of replicas to run for this workload. Should be an odd number. Replicas int32 `protobuf:"varint,1,opt,name=replicas,proto3" json:"replicas,omitempty"` // Any additional arguments to pass to Cortex. ExtraArgs []string `protobuf:"bytes,2,rep,name=extraArgs,proto3" json:"extraArgs,omitempty"` // contains filtered or unexported fields }
func (*CortexWorkloadSpec) Descriptor
deprecated
func (*CortexWorkloadSpec) Descriptor() ([]byte, []int)
Deprecated: Use CortexWorkloadSpec.ProtoReflect.Descriptor instead.
func (*CortexWorkloadSpec) FlagSet ¶
func (in *CortexWorkloadSpec) FlagSet(prefix ...string) *pflag.FlagSet
func (*CortexWorkloadSpec) GetExtraArgs ¶
func (x *CortexWorkloadSpec) GetExtraArgs() []string
func (*CortexWorkloadSpec) GetReplicas ¶
func (x *CortexWorkloadSpec) GetReplicas() int32
func (*CortexWorkloadSpec) ProtoMessage ¶
func (*CortexWorkloadSpec) ProtoMessage()
func (*CortexWorkloadSpec) ProtoReflect ¶
func (x *CortexWorkloadSpec) ProtoReflect() protoreflect.Message
func (*CortexWorkloadSpec) Reset ¶
func (x *CortexWorkloadSpec) Reset()
func (*CortexWorkloadSpec) String ¶
func (x *CortexWorkloadSpec) String() string
type DeploymentMode ¶
type DeploymentMode int32
const ( // All components are together in a single process. Not recommended for production use. DeploymentMode_AllInOne DeploymentMode = 0 // Components are distributed across multiple processes. DeploymentMode_HighlyAvailable DeploymentMode = 1 )
func (DeploymentMode) Descriptor ¶
func (DeploymentMode) Descriptor() protoreflect.EnumDescriptor
func (DeploymentMode) Enum ¶
func (x DeploymentMode) Enum() *DeploymentMode
func (DeploymentMode) EnumDescriptor
deprecated
func (DeploymentMode) EnumDescriptor() ([]byte, []int)
Deprecated: Use DeploymentMode.Descriptor instead.
func (DeploymentMode) Number ¶
func (x DeploymentMode) Number() protoreflect.EnumNumber
func (DeploymentMode) String ¶
func (x DeploymentMode) String() string
func (DeploymentMode) Type ¶
func (DeploymentMode) Type() protoreflect.EnumType
type DistributorConfig ¶
type DistributorConfig struct { // Per-user ingestion rate limit in samples per second. IngestionRate float64 `protobuf:"fixed64,1,opt,name=ingestionRate,proto3" json:"ingestionRate,omitempty"` // Whether the ingestion rate limit should be applied individually to each distributor instance (local), or evenly shared across the cluster (global). IngestionRateStrategy string `protobuf:"bytes,2,opt,name=ingestionRateStrategy,proto3" json:"ingestionRateStrategy,omitempty"` // Per-user allowed ingestion burst size (in number of samples). IngestionBurstSize int32 `protobuf:"varint,3,opt,name=ingestionBurstSize,proto3" json:"ingestionBurstSize,omitempty"` // contains filtered or unexported fields }
func (*DistributorConfig) Descriptor
deprecated
func (*DistributorConfig) Descriptor() ([]byte, []int)
Deprecated: Use DistributorConfig.ProtoReflect.Descriptor instead.
func (*DistributorConfig) FlagSet ¶
func (in *DistributorConfig) FlagSet(prefix ...string) *pflag.FlagSet
func (*DistributorConfig) GetIngestionBurstSize ¶
func (x *DistributorConfig) GetIngestionBurstSize() int32
func (*DistributorConfig) GetIngestionRate ¶
func (x *DistributorConfig) GetIngestionRate() float64
func (*DistributorConfig) GetIngestionRateStrategy ¶
func (x *DistributorConfig) GetIngestionRateStrategy() string
func (*DistributorConfig) ProtoMessage ¶
func (*DistributorConfig) ProtoMessage()
func (*DistributorConfig) ProtoReflect ¶
func (x *DistributorConfig) ProtoReflect() protoreflect.Message
func (*DistributorConfig) Reset ¶
func (x *DistributorConfig) Reset()
func (*DistributorConfig) String ¶
func (x *DistributorConfig) String() string
type GrafanaConfig ¶
type GrafanaConfig struct { // Whether to deploy a managed Grafana instance. Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"` // DNS name at which Grafana will be available in the browser. Hostname string `protobuf:"bytes,2,opt,name=hostname,proto3" json:"hostname,omitempty"` // contains filtered or unexported fields }
func (*GrafanaConfig) Descriptor
deprecated
func (*GrafanaConfig) Descriptor() ([]byte, []int)
Deprecated: Use GrafanaConfig.ProtoReflect.Descriptor instead.
func (*GrafanaConfig) GetEnabled ¶
func (x *GrafanaConfig) GetEnabled() bool
func (*GrafanaConfig) GetHostname ¶
func (x *GrafanaConfig) GetHostname() string
func (*GrafanaConfig) ProtoMessage ¶
func (*GrafanaConfig) ProtoMessage()
func (*GrafanaConfig) ProtoReflect ¶
func (x *GrafanaConfig) ProtoReflect() protoreflect.Message
func (*GrafanaConfig) Reset ¶
func (x *GrafanaConfig) Reset()
func (*GrafanaConfig) String ¶
func (x *GrafanaConfig) String() string
type IngesterConfig ¶
type IngesterConfig struct { // The maximum number of active series per user, per ingester. 0 to disable. MaxLocalSeriesPerUser int32 `protobuf:"varint,1,opt,name=maxLocalSeriesPerUser,proto3" json:"maxLocalSeriesPerUser,omitempty"` // The maximum number of active series per metric name, per ingester. 0 to disable. MaxLocalSeriesPerMetric int32 `protobuf:"varint,2,opt,name=maxLocalSeriesPerMetric,proto3" json:"maxLocalSeriesPerMetric,omitempty"` // The maximum number of active series per user, across the cluster before replication. 0 to disable. MaxGlobalSeriesPerUser int32 `protobuf:"varint,3,opt,name=maxGlobalSeriesPerUser,proto3" json:"maxGlobalSeriesPerUser,omitempty"` // The maximum number of active series per metric name, across the cluster before replication. 0 to disable. MaxGlobalSeriesPerMetric int32 `protobuf:"varint,4,opt,name=maxGlobalSeriesPerMetric,proto3" json:"maxGlobalSeriesPerMetric,omitempty"` // The maximum number of active metrics with metadata per user, per ingester. 0 to disable. MaxLocalMetricsWithMetadataPerUser int32 `protobuf:"varint,5,opt,name=maxLocalMetricsWithMetadataPerUser,proto3" json:"maxLocalMetricsWithMetadataPerUser,omitempty"` // The maximum number of metadata per metric, per ingester. 0 to disable. MaxLocalMetadataPerMetric int32 `protobuf:"varint,6,opt,name=maxLocalMetadataPerMetric,proto3" json:"maxLocalMetadataPerMetric,omitempty"` // The maximum number of active metrics with metadata per user, across the cluster. 0 to disable. MaxGlobalMetricsWithMetadataPerUser int32 `protobuf:"varint,7,opt,name=maxGlobalMetricsWithMetadataPerUser,proto3" json:"maxGlobalMetricsWithMetadataPerUser,omitempty"` // The maximum number of metadata per metric, across the cluster. 0 to disable. MaxGlobalMetadataPerMetric int32 `protobuf:"varint,8,opt,name=maxGlobalMetadataPerMetric,proto3" json:"maxGlobalMetadataPerMetric,omitempty"` // contains filtered or unexported fields }
func (*IngesterConfig) Descriptor
deprecated
func (*IngesterConfig) Descriptor() ([]byte, []int)
Deprecated: Use IngesterConfig.ProtoReflect.Descriptor instead.
func (*IngesterConfig) GetMaxGlobalMetadataPerMetric ¶
func (x *IngesterConfig) GetMaxGlobalMetadataPerMetric() int32
func (*IngesterConfig) GetMaxGlobalMetricsWithMetadataPerUser ¶
func (x *IngesterConfig) GetMaxGlobalMetricsWithMetadataPerUser() int32
func (*IngesterConfig) GetMaxGlobalSeriesPerMetric ¶
func (x *IngesterConfig) GetMaxGlobalSeriesPerMetric() int32
func (*IngesterConfig) GetMaxGlobalSeriesPerUser ¶
func (x *IngesterConfig) GetMaxGlobalSeriesPerUser() int32
func (*IngesterConfig) GetMaxLocalMetadataPerMetric ¶
func (x *IngesterConfig) GetMaxLocalMetadataPerMetric() int32
func (*IngesterConfig) GetMaxLocalMetricsWithMetadataPerUser ¶
func (x *IngesterConfig) GetMaxLocalMetricsWithMetadataPerUser() int32
func (*IngesterConfig) GetMaxLocalSeriesPerMetric ¶
func (x *IngesterConfig) GetMaxLocalSeriesPerMetric() int32
func (*IngesterConfig) GetMaxLocalSeriesPerUser ¶
func (x *IngesterConfig) GetMaxLocalSeriesPerUser() int32
func (*IngesterConfig) ProtoMessage ¶
func (*IngesterConfig) ProtoMessage()
func (*IngesterConfig) ProtoReflect ¶
func (x *IngesterConfig) ProtoReflect() protoreflect.Message
func (*IngesterConfig) Reset ¶
func (x *IngesterConfig) Reset()
func (*IngesterConfig) String ¶
func (x *IngesterConfig) String() string
type InstallState ¶
type InstallState int32
const ( InstallState_Unknown InstallState = 0 InstallState_NotInstalled InstallState = 1 InstallState_Updating InstallState = 2 InstallState_Installed InstallState = 3 InstallState_Uninstalling InstallState = 4 )
func (InstallState) Descriptor ¶
func (InstallState) Descriptor() protoreflect.EnumDescriptor
func (InstallState) Enum ¶
func (x InstallState) Enum() *InstallState
func (InstallState) EnumDescriptor
deprecated
func (InstallState) EnumDescriptor() ([]byte, []int)
Deprecated: Use InstallState.Descriptor instead.
func (InstallState) Number ¶
func (x InstallState) Number() protoreflect.EnumNumber
func (InstallState) String ¶
func (x InstallState) String() string
func (InstallState) Type ¶
func (InstallState) Type() protoreflect.EnumType
type InstallStatus ¶
type InstallStatus struct { State InstallState `protobuf:"varint,1,opt,name=state,proto3,enum=cortexops.InstallState" json:"state,omitempty"` Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"` Metadata map[string]string `` /* 157-byte string literal not displayed */ // contains filtered or unexported fields }
func (*InstallStatus) Descriptor
deprecated
func (*InstallStatus) Descriptor() ([]byte, []int)
Deprecated: Use InstallStatus.ProtoReflect.Descriptor instead.
func (*InstallStatus) GetMetadata ¶
func (x *InstallStatus) GetMetadata() map[string]string
func (*InstallStatus) GetState ¶
func (x *InstallStatus) GetState() InstallState
func (*InstallStatus) GetVersion ¶
func (x *InstallStatus) GetVersion() string
func (*InstallStatus) ProtoMessage ¶
func (*InstallStatus) ProtoMessage()
func (*InstallStatus) ProtoReflect ¶
func (x *InstallStatus) ProtoReflect() protoreflect.Message
func (*InstallStatus) RenderText ¶
func (s *InstallStatus) RenderText(out cli.Writer)
func (*InstallStatus) Reset ¶
func (x *InstallStatus) Reset()
func (*InstallStatus) String ¶
func (x *InstallStatus) String() string
type OpsClientOption ¶
type OpsClientOption func(*OpsClientOptions)
func WithDialOptions ¶
func WithDialOptions(options ...grpc.DialOption) OpsClientOption
func WithListenAddress ¶
func WithListenAddress(addr string) OpsClientOption
type OpsClientOptions ¶
type OpsClientOptions struct {
// contains filtered or unexported fields
}
type QuerierConfig ¶
type QuerierConfig struct { // The timeout for a query QueryTimeout *durationpb.Duration `protobuf:"bytes,1,opt,name=queryTimeout,proto3" json:"queryTimeout,omitempty"` // Maximum number of samples a single query can load into memory MaxSamples int32 `protobuf:"varint,2,opt,name=maxSamples,proto3" json:"maxSamples,omitempty"` // Maximum lookback beyond which queries are not sent to ingester. 0 means all queries are sent to ingester. QueryIngestersWithin *durationpb.Duration `protobuf:"bytes,3,opt,name=queryIngestersWithin,proto3" json:"queryIngestersWithin,omitempty"` // Maximum duration into the future you can query. 0 to disable MaxQueryIntoFuture *durationpb.Duration `protobuf:"bytes,4,opt,name=maxQueryIntoFuture,proto3" json:"maxQueryIntoFuture,omitempty"` // The default evaluation interval or step size for subqueries DefaultEvaluationInterval *durationpb.Duration `protobuf:"bytes,5,opt,name=defaultEvaluationInterval,proto3" json:"defaultEvaluationInterval,omitempty"` // The time after which a metric should be queried from storage and not just ingesters. 0 means all queries are sent to store. // When running the blocks storage, if this option is enabled, the time range of the query sent to the store will be manipulated // to ensure the query end is not more recent than 'now - query-store-after'. QueryStoreAfter *durationpb.Duration `protobuf:"bytes,6,opt,name=queryStoreAfter,proto3" json:"queryStoreAfter,omitempty"` // Time since the last sample after which a time series is considered stale and ignored by expression evaluations LookbackDelta *durationpb.Duration `protobuf:"bytes,7,opt,name=lookbackDelta,proto3" json:"lookbackDelta,omitempty"` // When distributor's sharding strategy is shuffle-sharding and this setting is > 0, queriers fetch in-memory series from // the minimum set of required ingesters, selecting only ingesters which may have received series since 'now - lookback period'. // The lookback period should be greater or equal than the configured 'query store after' and 'query ingesters within'. // If this setting is 0, queriers always query all ingesters (ingesters shuffle sharding on read path is disabled). ShuffleShardingIngestersLookbackPeriod *durationpb.Duration `` /* 129-byte string literal not displayed */ // The maximum number of unique series for which a query can fetch samples from each ingesters and blocks storage. This limit is enforced in the querier, ruler and store-gateway. 0 to disable MaxFetchedSeriesPerQuery int32 `protobuf:"varint,9,opt,name=maxFetchedSeriesPerQuery,proto3" json:"maxFetchedSeriesPerQuery,omitempty"` // contains filtered or unexported fields }
func (*QuerierConfig) Descriptor
deprecated
func (*QuerierConfig) Descriptor() ([]byte, []int)
Deprecated: Use QuerierConfig.ProtoReflect.Descriptor instead.
func (*QuerierConfig) GetDefaultEvaluationInterval ¶
func (x *QuerierConfig) GetDefaultEvaluationInterval() *durationpb.Duration
func (*QuerierConfig) GetLookbackDelta ¶
func (x *QuerierConfig) GetLookbackDelta() *durationpb.Duration
func (*QuerierConfig) GetMaxFetchedSeriesPerQuery ¶
func (x *QuerierConfig) GetMaxFetchedSeriesPerQuery() int32
func (*QuerierConfig) GetMaxQueryIntoFuture ¶
func (x *QuerierConfig) GetMaxQueryIntoFuture() *durationpb.Duration
func (*QuerierConfig) GetMaxSamples ¶
func (x *QuerierConfig) GetMaxSamples() int32
func (*QuerierConfig) GetQueryIngestersWithin ¶
func (x *QuerierConfig) GetQueryIngestersWithin() *durationpb.Duration
func (*QuerierConfig) GetQueryStoreAfter ¶
func (x *QuerierConfig) GetQueryStoreAfter() *durationpb.Duration
func (*QuerierConfig) GetQueryTimeout ¶
func (x *QuerierConfig) GetQueryTimeout() *durationpb.Duration
func (*QuerierConfig) GetShuffleShardingIngestersLookbackPeriod ¶
func (x *QuerierConfig) GetShuffleShardingIngestersLookbackPeriod() *durationpb.Duration
func (*QuerierConfig) ProtoMessage ¶
func (*QuerierConfig) ProtoMessage()
func (*QuerierConfig) ProtoReflect ¶
func (x *QuerierConfig) ProtoReflect() protoreflect.Message
func (*QuerierConfig) Reset ¶
func (x *QuerierConfig) Reset()
func (*QuerierConfig) String ¶
func (x *QuerierConfig) String() string
type UnimplementedCortexOpsServer ¶
type UnimplementedCortexOpsServer struct { }
UnimplementedCortexOpsServer must be embedded to have forward compatible implementations.
func (UnimplementedCortexOpsServer) ConfigureCluster ¶
func (UnimplementedCortexOpsServer) ConfigureCluster(context.Context, *ClusterConfiguration) (*emptypb.Empty, error)
func (UnimplementedCortexOpsServer) GetClusterConfiguration ¶
func (UnimplementedCortexOpsServer) GetClusterConfiguration(context.Context, *emptypb.Empty) (*ClusterConfiguration, error)
func (UnimplementedCortexOpsServer) GetClusterStatus ¶
func (UnimplementedCortexOpsServer) GetClusterStatus(context.Context, *emptypb.Empty) (*InstallStatus, error)
func (UnimplementedCortexOpsServer) UninstallCluster ¶
type UnsafeCortexOpsServer ¶
type UnsafeCortexOpsServer interface {
// contains filtered or unexported methods
}
UnsafeCortexOpsServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to CortexOpsServer will result in compilation errors.
type Workloads ¶
type Workloads struct { Distributor *CortexWorkloadSpec `protobuf:"bytes,1,opt,name=distributor,proto3" json:"distributor,omitempty"` Ingester *CortexWorkloadSpec `protobuf:"bytes,2,opt,name=ingester,proto3" json:"ingester,omitempty"` Compactor *CortexWorkloadSpec `protobuf:"bytes,3,opt,name=compactor,proto3" json:"compactor,omitempty"` StoreGateway *CortexWorkloadSpec `protobuf:"bytes,4,opt,name=storeGateway,proto3" json:"storeGateway,omitempty"` Ruler *CortexWorkloadSpec `protobuf:"bytes,5,opt,name=ruler,proto3" json:"ruler,omitempty"` QueryFrontend *CortexWorkloadSpec `protobuf:"bytes,6,opt,name=queryFrontend,proto3" json:"queryFrontend,omitempty"` Querier *CortexWorkloadSpec `protobuf:"bytes,7,opt,name=querier,proto3" json:"querier,omitempty"` Purger *CortexWorkloadSpec `protobuf:"bytes,8,opt,name=purger,proto3" json:"purger,omitempty"` // contains filtered or unexported fields }
func (*Workloads) Descriptor
deprecated
func (*Workloads) GetCompactor ¶
func (x *Workloads) GetCompactor() *CortexWorkloadSpec
func (*Workloads) GetDistributor ¶
func (x *Workloads) GetDistributor() *CortexWorkloadSpec
func (*Workloads) GetIngester ¶
func (x *Workloads) GetIngester() *CortexWorkloadSpec
func (*Workloads) GetPurger ¶
func (x *Workloads) GetPurger() *CortexWorkloadSpec
func (*Workloads) GetQuerier ¶
func (x *Workloads) GetQuerier() *CortexWorkloadSpec
func (*Workloads) GetQueryFrontend ¶
func (x *Workloads) GetQueryFrontend() *CortexWorkloadSpec
func (*Workloads) GetRuler ¶
func (x *Workloads) GetRuler() *CortexWorkloadSpec
func (*Workloads) GetStoreGateway ¶
func (x *Workloads) GetStoreGateway() *CortexWorkloadSpec
func (*Workloads) ProtoMessage ¶
func (*Workloads) ProtoMessage()
func (*Workloads) ProtoReflect ¶
func (x *Workloads) ProtoReflect() protoreflect.Message