metricscontroller

Documentation

Overview

TODO: Describe package

TODO: Describe package

TODO: Describe function

TODO: Describe function

Index

• func GetByClusterId() gin.HandlerFunc
• func GetByDatacenterName() gin.HandlerFunc
• func GetByWorkspaceName() gin.HandlerFunc
• func GetForClusters() gin.HandlerFunc
• func GetForClustersByWorkspace() gin.HandlerFunc
• func GetForDatacenters() gin.HandlerFunc
• func GetForWorkspaces() gin.HandlerFunc
• func GetForWorkspacesByDatacenter() gin.HandlerFunc
• func GetTotal() gin.HandlerFunc
• func GetTotalByUser() gin.HandlerFunc
• func MetricsForClustersByProperty() gin.HandlerFunc
• func RegisterResourceMetricsReport() gin.HandlerFunc

Functions

func GetByClusterId

func GetByClusterId() gin.HandlerFunc

TODO: Describe function

@Summary	Get metrics for clusterid
@Schemes
@Description	Get metrics for clusterid
@Tags			metrics
@Accept			application/json
@Produce		application/json
@Success		200	{object}	apicontracts.MetricItem
@Failure		403	{string}	Forbidden
@Failure		401	{string}	Unauthorized
@Failure		500	{string}	Failure	message
@Router			/v1/metrics/cluster/{clusterId} [get]
@Param			clusterId	path	string	true	"clusterId"
@Security		ApiKey || AccessToken

func GetByDatacenterName

func GetByDatacenterName() gin.HandlerFunc

TODO: Describe function

@Summary	Get metrics for datacenter name
@Schemes
@Description	Get metrics for datacenter name
@Tags			metrics
@Accept			application/json
@Produce		application/json
@Success		200										{object}	apicontracts.MetricItem
@Failure		403										{string}	Forbidden
@Failure		401										{string}	Unauthorized
@Failure		500										{string}	Failure	message
@Router			/v1/metrics/datacenter/{datacenterName}	[get]
@Param			datacenterName							path	string	true	"datacenterName"
@Security		ApiKey || AccessToken

func GetByWorkspaceName

func GetByWorkspaceName() gin.HandlerFunc

TODO: Describe function

@Summary	Get metrics for workspace name
@Schemes
@Description	Get metrics for workspace name
@Tags			metrics
@Accept			application/json
@Produce		application/json
@Success		200										{object}	apicontracts.MetricItem
@Failure		403										{string}	Forbidden
@Failure		401										{string}	Unauthorized
@Failure		500										{string}	Failure	message
@Router			/v1/metrics/workspace/{workspaceName}	[get]
@Param			workspaceName							path	string	true	"workspaceName"
@Security		ApiKey || AccessToken

func GetForClusters

func GetForClusters() gin.HandlerFunc

TODO: Describe function

@Summary	Get metrics for clusters
@Schemes
@Description	Get metrics for clusters
@Tags			metrics
@Accept			application/json
@Produce		application/json
@Success		200						{object}	apicontracts.MetricList
@Failure		403						{string}	Forbidden
@Failure		401						{string}	Unauthorized
@Failure		500						{string}	Failure	message
@Router			/v1/metrics/clusters	[get]
@Security		ApiKey || AccessToken

func GetForClustersByWorkspace

func GetForClustersByWorkspace() gin.HandlerFunc

TODO: Describe function

@Summary	Get metrics for clusters by workspace
@Schemes
@Description	Get metrics for clusters by workspace
@Tags			metrics
@Accept			application/json
@Produce		application/json
@Success		200												{object}	apicontracts.MetricList
@Failure		403												{string}	Forbidden
@Failure		401												{string}	Unauthorized
@Failure		500												{string}	Failure	message
@Param			workspaceName									path		string	true	"workspaceName"
@Router			/v1/metrics/clusters/workspace/{workspaceName}	[get]
@Security		ApiKey || AccessToken

func GetForDatacenters

func GetForDatacenters() gin.HandlerFunc

TODO: Describe function

@Summary	Get metrics for datacenters
@Schemes
@Description	Get metrics for datacenters
@Tags			metrics
@Accept			application/json
@Produce		application/json
@Success		200						{object}	apicontracts.MetricList
@Failure		403						{string}	Forbidden
@Failure		401						{string}	Unauthorized
@Failure		500						{string}	Failure	message
@Router			/v1/metrics/datacenters	[get]
@Security		ApiKey || AccessToken

func GetForWorkspaces

func GetForWorkspaces() gin.HandlerFunc

TODO: Describe function

@Summary	Get metrics for workspaces
@Schemes
@Description	Get metrics for workspaces
@Tags			metrics
@Accept			application/json
@Produce		application/json
@Success		200								{object}	apicontracts.PaginatedResult[apicontracts.Metric]
@Failure		403								{string}	Forbidden
@Failure		401								{string}	Unauthorized
@Failure		500								{string}	Failure	message
@Router			/v1/metrics/workspaces/filter	[post]
@Param			filter							body	apicontracts.Filter	true	"Filter"
@Security		ApiKey || AccessToken

func GetForWorkspacesByDatacenter

func GetForWorkspacesByDatacenter() gin.HandlerFunc

TODO: Describe function

@Summary	Get metrics for workspaces by datacenter name
@Schemes
@Description	Get metrics for workspaces by datacenter name
@Tags			metrics
@Accept			application/json
@Produce		application/json
@Success		200															{object}	apicontracts.MetricList
@Failure		403															{string}	Forbidden
@Failure		401															{string}	Unauthorized
@Failure		500															{string}	Failure	message
@Param			datacenterName												path		string	true	"datacenterName"
@Router			/v1/metrics/workspaces/datacenter/{datacenterName}/filter	[post]
@Param			filter														body	apicontracts.Filter	true	"Filter"
@Security		ApiKey || AccessToken

func GetTotal

func GetTotal() gin.HandlerFunc

TODO: Describe function

@Summary	Get metrics
@Schemes
@Description	Get metrics
@Tags			metrics
@Accept			application/json
@Produce		application/json
@Success		200					{object}	apicontracts.MetricsTotal
@Failure		403					{string}	Forbidden
@Failure		401					{string}	Unauthorized
@Failure		500					{string}	Failure	message
@Router			/v1/metrics/total	[get]
@Security		ApiKey || AccessToken

func GetTotalByUser

func GetTotalByUser() gin.HandlerFunc

TODO: Describe function

@Summary	Get metrics by user
@Schemes
@Description	Get metrics by user
@Tags			metrics
@Accept			application/json
@Produce		application/json
@Success		200			{object}	apicontracts.MetricsTotal
@Failure		403			{string}	Forbidden
@Failure		401			{string}	Unauthorized
@Failure		500			{string}	Failure	message
@Router			/v1/metrics	[get]
@Security		ApiKey || AccessToken

func MetricsForClustersByProperty

func MetricsForClustersByProperty() gin.HandlerFunc

TODO: Describe function

@Summary	Get metrics for clusters by a property
@Schemes
@Description	Get metrics for clusters by a property
@Tags			metrics
@Accept			application/json
@Produce		application/json
@Success		200	{object}	apicontracts.MetricsCustom
@Failure		403	{string}	Forbidden
@Failure		401	{string}	Unauthorized
@Failure		500	{string}	Failure	message
@Router			/v1/metrics/custom/cluster/{property} [get]
@Param			property	path	string	true	"property"
@Security		ApiKey || AccessToken

func RegisterResourceMetricsReport

func RegisterResourceMetricsReport() gin.HandlerFunc

Registers metrics from ror-agent

@Summary	Register metrics
@Schemes
@Description	Register metrics
@Tags			metrics
@Accept			application/json
@Produce		application/json
@Param			metrics		body		apicontracts.MetricsReport	true	"MetricsReport"
@Success		200			{object}	apicontracts.MetricsTotal
@Failure		403			{string}	Forbidden
@Failure		401			{string}	Unauthorized
@Failure		500			{string}	Failure	message
@Router			/v1/metrics	[post]
@Security		ApiKey || AccessToken