statistics

Documentation

Overview

Copyright 2019 Cohesity Inc.

Copyright 2019 Cohesity Inc.

Index

• type STATISTICS
• type STATISTICS_IMPL
  • func NewSTATISTICS(config configuration.CONFIGURATION) *STATISTICS_IMPL
  • func (me *STATISTICS_IMPL) GetEntities(schemaName string, includeAggrMetricSources *bool, metricNames []string) ([]*models.EntityProto, error)
  • func (me *STATISTICS_IMPL) GetEntitiesSchema(schemaNames []string, metricNames []string) ([]*models.EntitySchemaProto, error)
  • func (me *STATISTICS_IMPL) GetEntitySchemaByName(schemaName string) ([]*models.EntitySchemaProto, error)
  • func (me *STATISTICS_IMPL) GetTasks(taskPaths []string, includeFinishedTasks *bool, startTimeSeconds *int64, ...) ([]*models.Task, error)
  • func (me *STATISTICS_IMPL) GetTimeSeriesSchema(entityType models.EntityTypeEnum, entityId int64, entityName string) (*models.TimeSeriesSchemaResponse, error)
  • func (me *STATISTICS_IMPL) GetTimeSeriesStats(schemaName string, metricName string, startTimeMsecs int64, entityId *string, ...) (*models.MetricDataBlock, error)

Types

type STATISTICS

type STATISTICS interface {
	GetEntities(string, *bool, []string) ([]*models.EntityProto, error)

	GetEntitiesSchema([]string, []string) ([]*models.EntitySchemaProto, error)

	GetEntitySchemaByName(string) ([]*models.EntitySchemaProto, error)

	GetTimeSeriesSchema(models.EntityTypeEnum, int64, string) (*models.TimeSeriesSchemaResponse, error)

	GetTimeSeriesStats(string, string, int64, *string, []string, *int64, *string, *int64) (*models.MetricDataBlock, error)

	GetTasks([]string, *bool, *int64, *int64, *int64, *bool, []string) ([]*models.Task, error)
}

* Interface for the STATISTICS_IMPL

type STATISTICS_IMPL

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

* Client structure as interface implementation

func NewSTATISTICS

func NewSTATISTICS(config configuration.CONFIGURATION) *STATISTICS_IMPL

* Factory for the STATISTICS interaface returning STATISTICS_IMPL

func (*STATISTICS_IMPL) GetEntities

func (me *STATISTICS_IMPL) GetEntities(
	schemaName string,
	includeAggrMetricSources *bool,
	metricNames []string) ([]*models.EntityProto, error)

*

• An entity is an object found on the Cohesity Cluster, such as a disk or a
• Node.
• In the Cohesity Dashboard, similar functionality is provided in Advanced
• Diagnostics.
• @param string schemaName parameter: Required
• @param *bool includeAggrMetricSources parameter: Optional
• @param []string metricNames parameter: Optional
• @return Returns the []*models.EntityProto response from the API call

func (*STATISTICS_IMPL) GetEntitiesSchema

func (me *STATISTICS_IMPL) GetEntitiesSchema(
	schemaNames []string,
	metricNames []string) ([]*models.EntitySchemaProto, error)

*

• An entity schema specifies the meta-data associated with entity such as
• the list of attributes and a time series of data.
• For example for a Disk entity, the entity schema specifies the Node that is
• using this Disk, the type of the Disk, and Metrics about the Disk such as Space
• Usage, Read IOs and Write IOs. Metrics define data points (time series data)
• to track over a period of time for a specific interval.
• If no parameters are specified, all entity schemas found on the Cohesity
• Cluster are returned.
• Specifying parameters filters the results that are returned.
• In the Cohesity Dashboard, similar functionality is provided in Advanced
• Diagnostics.
• @param []string schemaNames parameter: Optional
• @param []string metricNames parameter: Optional
• @return Returns the []*models.EntitySchemaProto response from the API call

func (*STATISTICS_IMPL) GetEntitySchemaByName

func (me *STATISTICS_IMPL) GetEntitySchemaByName(
	schemaName string) ([]*models.EntitySchemaProto, error)

*

• An entity schema specifies the meta-data associated with entity such as the
• list of attributes and a time series of data.
• For example for a Disk entity, the entity schema specifies the Node that is
• using this Disk, the type of the Disk, and Metrics about the Disk such as
• Space Usage, Read IOs and Write IOs. Metrics define data points (time series
• data) to track over a period of time for a specific interval.
• In the Cohesity Dashboard, similar functionality is provided in Advanced
• Diagnostics.
• @param string schemaName parameter: Required
• @return Returns the []*models.EntitySchemaProto response from the API call

func (*STATISTICS_IMPL) GetTasks

func (me *STATISTICS_IMPL) GetTasks(
	taskPaths []string,
	includeFinishedTasks *bool,
	startTimeSeconds *int64,
	endTimeSeconds *int64,
	maxTasks *int64,
	excludeSubTasks *bool,
	attributes []string) ([]*models.Task, error)

*

• Gets the progress and status of tasks.
• @param []string taskPaths parameter: Optional
• @param *bool includeFinishedTasks parameter: Optional
• @param *int64 startTimeSeconds parameter: Optional
• @param *int64 endTimeSeconds parameter: Optional
• @param *int64 maxTasks parameter: Optional
• @param *bool excludeSubTasks parameter: Optional
• @param []string attributes parameter: Optional
• @return Returns the []*models.Task response from the API call

func (*STATISTICS_IMPL) GetTimeSeriesSchema

func (me *STATISTICS_IMPL) GetTimeSeriesSchema(
	entityType models.EntityTypeEnum,
	entityId int64,
	entityName string) (*models.TimeSeriesSchemaResponse, error)

*

• Gets the Apollo schema information for an entity to list a series of data
• points.
• @param models.EntityTypeEnum entityType parameter: Required
• @param int64 entityId parameter: Required
• @param string entityName parameter: Required
• @return Returns the *models.TimeSeriesSchemaResponse response from the API call

func (*STATISTICS_IMPL) GetTimeSeriesStats

func (me *STATISTICS_IMPL) GetTimeSeriesStats(
	schemaName string,
	metricName string,
	startTimeMsecs int64,
	entityId *string,
	entityIdList []string,
	endTimeMsecs *int64,
	rollupFunction *string,
	rollupIntervalSecs *int64) (*models.MetricDataBlock, error)

*

• A Metric specifies a data point (such as CPU usage and IOPS) to track over a
• period of time.
• For example for a disk in the Cluster, you can report on the 'Disk Health'
• (kDiskAwaitTimeMsecs) Metric of the 'Disk Health Metrics' (kSentryDiskStats)
• Schema for the last week.
• You must specify the 'k' names as input and not the descriptive names.
• You must also specify the id of the entity that you are reporting on such as
• a Cluster, disk drive, job, etc.
• Get the entityId by running the GET /public/statistics/entities operation.
• In the Cohesity Dashboard, similar functionality is provided in Advanced
• Diagnostics.
• @param string schemaName parameter: Required
• @param string metricName parameter: Required
• @param int64 startTimeMsecs parameter: Required
• @param *string entityId parameter: Optional
• @param []string entityIdList parameter: Optional
• @param *int64 endTimeMsecs parameter: Optional
• @param *string rollupFunction parameter: Optional
• @param *int64 rollupIntervalSecs parameter: Optional
• @return Returns the *models.MetricDataBlock response from the API call