m3

Documentation

Index

• type AggregatedClusterNamespaceDefinition
  • func (def AggregatedClusterNamespaceDefinition) Validate() error
• type Cleanup
• type ClusterNamespace
• type ClusterNamespaceDownsampleOptions
• type ClusterNamespaceOptions
  • func (o ClusterNamespaceOptions) Attributes() storage.Attributes
  • func (o ClusterNamespaceOptions) DownsampleOptions() (ClusterNamespaceDownsampleOptions, error)
• type ClusterNamespaces
  • func (n ClusterNamespaces) NumAggregatedClusterNamespaces() int
• type ClusterNamespacesByResolutionAsc
  • func (a ClusterNamespacesByResolutionAsc) Len() int
  • func (a ClusterNamespacesByResolutionAsc) Less(i, j int) bool
  • func (a ClusterNamespacesByResolutionAsc) Swap(i, j int)
• type ClusterNamespacesByRetentionAsc
  • func (a ClusterNamespacesByRetentionAsc) Len() int
  • func (a ClusterNamespacesByRetentionAsc) Less(i, j int) bool
  • func (a ClusterNamespacesByRetentionAsc) Swap(i, j int)
• type ClusterStaticConfiguration
• type ClusterStaticNamespaceConfiguration
• type Clusters
  • func NewClusters(unaggregatedClusterNamespace UnaggregatedClusterNamespaceDefinition, ...) (Clusters, error)
• type ClustersStaticConfiguration
  • func (c ClustersStaticConfiguration) NewClusters(opts ClustersStaticConfigurationOptions) (Clusters, error)
• type ClustersStaticConfigurationOptions
• type DownsampleClusterStaticNamespaceConfiguration
• type NewClientFromConfig
• type Querier
• type RetentionResolution
• type Storage
  • func NewStorage(clusters Clusters, readWorkerPool pool.ObjectPool, ...) Storage
• type UnaggregatedClusterNamespaceDefinition
  • func (def UnaggregatedClusterNamespaceDefinition) Validate() error

Types

type AggregatedClusterNamespaceDefinition

type AggregatedClusterNamespaceDefinition struct {
	NamespaceID ident.ID
	Session     client.Session
	Retention   time.Duration
	Resolution  time.Duration
	Downsample  *ClusterNamespaceDownsampleOptions
}

AggregatedClusterNamespaceDefinition is a definition for a cluster namespace that holds aggregated metrics data at a specific retention and resolution.

func (AggregatedClusterNamespaceDefinition) Validate

func (def AggregatedClusterNamespaceDefinition) Validate() error

Validate validates the cluster namespace definition.

type Cleanup

type Cleanup func() error

Cleanup is a cleanup function to be called after resources are freed

type ClusterNamespace

type ClusterNamespace interface {
	NamespaceID() ident.ID
	Options() ClusterNamespaceOptions
	Session() client.Session
}

ClusterNamespace is a local storage cluster namespace.

type ClusterNamespaceDownsampleOptions

type ClusterNamespaceDownsampleOptions struct {
	All bool
}

ClusterNamespaceDownsampleOptions is the downsample options for a cluster namespace.

type ClusterNamespaceOptions

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

ClusterNamespaceOptions is a set of options

func (ClusterNamespaceOptions) Attributes

func (o ClusterNamespaceOptions) Attributes() storage.Attributes

Attributes returns the storage attributes of the cluster namespace.

func (ClusterNamespaceOptions) DownsampleOptions

func (o ClusterNamespaceOptions) DownsampleOptions() (
	ClusterNamespaceDownsampleOptions,
	error,
)

DownsampleOptions returns the downsample options for a cluster namespace, which is only valid if the namespace is an aggregated cluster namespace.

type ClusterNamespaces

type ClusterNamespaces []ClusterNamespace

ClusterNamespaces is a slice of ClusterNamespace instances.

func (ClusterNamespaces) NumAggregatedClusterNamespaces

func (n ClusterNamespaces) NumAggregatedClusterNamespaces() int

NumAggregatedClusterNamespaces returns the number of aggregated cluster namespaces.

type ClusterNamespacesByResolutionAsc

type ClusterNamespacesByResolutionAsc []ClusterNamespace

ClusterNamespacesByResolutionAsc is a slice of ClusterNamespace instances is sortable by resolution.

func (ClusterNamespacesByResolutionAsc) Len

func (a ClusterNamespacesByResolutionAsc) Len() int

func (ClusterNamespacesByResolutionAsc) Less

func (a ClusterNamespacesByResolutionAsc) Less(i, j int) bool

func (ClusterNamespacesByResolutionAsc) Swap

func (a ClusterNamespacesByResolutionAsc) Swap(i, j int)

type ClusterNamespacesByRetentionAsc

type ClusterNamespacesByRetentionAsc []ClusterNamespace

ClusterNamespacesByRetentionAsc is a slice of ClusterNamespace instances is sortable by retention.

func (ClusterNamespacesByRetentionAsc) Len

func (a ClusterNamespacesByRetentionAsc) Len() int

func (ClusterNamespacesByRetentionAsc) Less

func (a ClusterNamespacesByRetentionAsc) Less(i, j int) bool

func (ClusterNamespacesByRetentionAsc) Swap

func (a ClusterNamespacesByRetentionAsc) Swap(i, j int)

type ClusterStaticConfiguration

type ClusterStaticConfiguration struct {
	NewClientFromConfig NewClientFromConfig
	Namespaces          []ClusterStaticNamespaceConfiguration `yaml:"namespaces"`
	Client              client.Configuration                  `yaml:"client"`
}

ClusterStaticConfiguration is a static cluster configuration.

type ClusterStaticNamespaceConfiguration

type ClusterStaticNamespaceConfiguration struct {
	// Namespace is namespace in the cluster that is specified.
	Namespace string `yaml:"namespace"`

	// Type is the type of values stored by the namespace, current
	// supported values are "unaggregated" or "aggregated".
	Type storage.MetricsType `yaml:"type"`

	// Retention is the length of which values are stored by the namespace.
	Retention time.Duration `yaml:"retention" validate:"nonzero"`

	// Resolution is the frequency of which values are stored by the namespace.
	Resolution time.Duration `yaml:"resolution" validate:"min=0"`

	// Downsample is the configuration for downsampling options to use with
	// the namespace.
	Downsample *DownsampleClusterStaticNamespaceConfiguration `yaml:"downsample"`

	// StorageMetricsType is the namespace type.
	//
	// Deprecated: Use "Type" field when specifying config instead, it is
	// invalid to use both.
	StorageMetricsType storage.MetricsType `yaml:"storageMetricsType"`
}

ClusterStaticNamespaceConfiguration describes the namespaces in a static cluster.

type Clusters

type Clusters interface {
	io.Closer

	// ClusterNamespaces returns all known cluster namespaces.
	ClusterNamespaces() ClusterNamespaces

	// UnaggregatedClusterNamespace returns the valid unaggregated
	// cluster namespace.
	UnaggregatedClusterNamespace() ClusterNamespace

	// AggregatedClusterNamespace returns an aggregated cluster namespace
	// at a specific retention and resolution.
	AggregatedClusterNamespace(attrs RetentionResolution) (ClusterNamespace, bool)
}

Clusters is a flattened collection of local storage clusters and namespaces.

func NewClusters

func NewClusters(
	unaggregatedClusterNamespace UnaggregatedClusterNamespaceDefinition,
	aggregatedClusterNamespaces ...AggregatedClusterNamespaceDefinition,
) (Clusters, error)

NewClusters instantiates a new Clusters instance.

type ClustersStaticConfiguration

type ClustersStaticConfiguration []ClusterStaticConfiguration

ClustersStaticConfiguration is a set of static cluster configurations.

func (ClustersStaticConfiguration) NewClusters

func (c ClustersStaticConfiguration) NewClusters(
	opts ClustersStaticConfigurationOptions,
) (Clusters, error)

NewClusters instantiates a new Clusters instance.

type ClustersStaticConfigurationOptions

type ClustersStaticConfigurationOptions struct {
	AsyncSessions bool
}

ClustersStaticConfigurationOptions are options to use when constructing clusters from config.

type DownsampleClusterStaticNamespaceConfiguration

type DownsampleClusterStaticNamespaceConfiguration struct {
	All bool `yaml:"all"`
}

DownsampleClusterStaticNamespaceConfiguration is configuration specified for downsampling options on an aggregated cluster namespace.

type NewClientFromConfig

type NewClientFromConfig func(
	cfg client.Configuration,
	params client.ConfigurationParameters,
	custom ...client.CustomOption,
) (client.Client, error)

NewClientFromConfig is a method that can be set on ClusterStaticConfiguration to allow overriding the client initialization.

type Querier

type Querier interface {
	// FetchRaw fetches timeseries data based on a query
	FetchRaw(
		ctx context.Context,
		query *genericstorage.FetchQuery,
		options *genericstorage.FetchOptions,
	) (encoding.SeriesIterators, Cleanup, error)
}

Querier handles queries against an M3 instance.

type RetentionResolution

type RetentionResolution struct {
	Retention  time.Duration
	Resolution time.Duration
}

RetentionResolution is a tuple of retention and resolution that describes an aggregated metrics policy.

type Storage

type Storage interface {
	genericstorage.Storage
	Querier
}

Storage provides an interface for reading and writing to the tsdb

func NewStorage

func NewStorage(
	clusters Clusters,
	readWorkerPool pool.ObjectPool,
	writeWorkerPool xsync.PooledWorkerPool,
) Storage

NewStorage creates a new local m3storage instance. TODO: Consider combining readWorkerPool and writeWorkerPool

type UnaggregatedClusterNamespaceDefinition

type UnaggregatedClusterNamespaceDefinition struct {
	NamespaceID ident.ID
	Session     client.Session
	Retention   time.Duration
}

UnaggregatedClusterNamespaceDefinition is the definition for the cluster namespace that holds unaggregated metrics data.

func (UnaggregatedClusterNamespaceDefinition) Validate

func (def UnaggregatedClusterNamespaceDefinition) Validate() error

Validate will validate the cluster namespace definition.