v1alpha1

Documentation

Index

• Constants
• Variables
• type MonitoringDashboard
  • func (in *MonitoringDashboard) DeepCopy() *MonitoringDashboard
  • func (in *MonitoringDashboard) DeepCopyInto(out *MonitoringDashboard)
  • func (in *MonitoringDashboard) DeepCopyObject() runtime.Object
• type MonitoringDashboardAggregation
• type MonitoringDashboardChart
  • func (in *MonitoringDashboardChart) GetMetrics() []MonitoringDashboardMetric
• type MonitoringDashboardExternalLink
• type MonitoringDashboardExternalLinkVariables
• type MonitoringDashboardItem
• type MonitoringDashboardMetric
• type MonitoringDashboardSpec
• type MonitoringDashboardsList
  • func (in *MonitoringDashboardsList) DeepCopy() *MonitoringDashboardsList
  • func (in *MonitoringDashboardsList) DeepCopyInto(out *MonitoringDashboardsList)
  • func (in *MonitoringDashboardsList) DeepCopyObject() runtime.Object

Constants

const (
	// Raw constant for DataType
	Raw = "raw"
	// Rate constant for DataType
	Rate = "rate"
	// Histogram constant for DataType
	Histogram = "histogram"
)

Variables

var GroupVersion = schema.GroupVersion{
	Group:   "monitoring.kiali.io",
	Version: "v1alpha1",
}

Types

type MonitoringDashboard

type MonitoringDashboard struct {
	meta_v1.TypeMeta   `json:",inline"`
	meta_v1.ObjectMeta `json:"metadata"`
	Spec               MonitoringDashboardSpec `json:"spec"`
}

func (*MonitoringDashboard) DeepCopy

func (in *MonitoringDashboard) DeepCopy() *MonitoringDashboard

func (*MonitoringDashboard) DeepCopyInto

func (in *MonitoringDashboard) DeepCopyInto(out *MonitoringDashboard)

func (*MonitoringDashboard) DeepCopyObject

func (in *MonitoringDashboard) DeepCopyObject() runtime.Object

type MonitoringDashboardAggregation

type MonitoringDashboardAggregation struct {
	Label           string `json:"label"`
	DisplayName     string `json:"displayName"`
	SingleSelection bool   `json:"singleSelection"`
}

type MonitoringDashboardChart

type MonitoringDashboardChart struct {
	Name             string                           `json:"name"`
	Unit             string                           `json:"unit"`      // Stands for the base unit (regardless its scale in datasource)
	UnitScale        float64                          `json:"unitScale"` // Stands for the scale of the values in datasource, related to the base unit provided. E.g. unit: "seconds" and unitScale: 0.001 means that values in datasource are actually in milliseconds.
	Spans            int                              `json:"spans"`
	StartCollapsed   bool                             `json:"startCollapsed"`
	ChartType        *string                          `json:"chartType"`
	Min              *int                             `json:"min"`
	Max              *int                             `json:"max"`
	MetricName       string                           `json:"metricName"` // Deprecated; use Metrics instead
	Metrics          []MonitoringDashboardMetric      `json:"metrics"`
	DataType         string                           `json:"dataType"`   // DataType is either "raw", "rate" or "histogram"
	Aggregator       string                           `json:"aggregator"` // Aggregator can be set for raw data. Ex: "sum", "avg". See https://prometheus.io/docs/prometheus/latest/querying/operators/#aggregation-operators
	Aggregations     []MonitoringDashboardAggregation `json:"aggregations"`
	XAxis            *string                          `json:"xAxis"`            // "time" (default) or "series"
	GroupLabels      []string                         `json:"groupLabels"`      // Prometheus label to be used for grouping; Similar to Aggregations, except this grouping will be always turned on
	SortLabel        string                           `json:"sortLabel"`        // Prometheus label to be used for sorting
	SortLabelParseAs string                           `json:"sortLabelParseAs"` // Set "int" if the SortLabel needs to be parsed and compared as an integer
}

func (*MonitoringDashboardChart) GetMetrics

func (in *MonitoringDashboardChart) GetMetrics() []MonitoringDashboardMetric

GetMetrics provides consistent MonitoringDashboardMetric slice in a backward-compatible way, if deprecated field MetricName is used instead of Metrics in Spec.

type MonitoringDashboardExternalLink

type MonitoringDashboardExternalLink struct {
	Type      string                                   `json:"type"`
	Name      string                                   `json:"name"`
	Variables MonitoringDashboardExternalLinkVariables `json:"variables"`
}

type MonitoringDashboardExternalLinkVariables

type MonitoringDashboardExternalLinkVariables struct {
	Namespace string `json:"namespace,omitempty"`
	App       string `json:"app,omitempty"`
	Service   string `json:"service,omitempty"`
	Version   string `json:"version,omitempty"`
	Workload  string `json:"workload,omitempty"`
}

type MonitoringDashboardItem

type MonitoringDashboardItem struct {
	// Items are exclusive: either Include or Chart must be set (if both are set, Chart will be ignored)
	// Include is a reference to another dashboard and/or chart
	// Ex: "microprofile-1.0" will include the whole dashboard named "microprofile-1.0" at this position
	//		 "microprofile-1.0$Thread count" will include only the chart named "Thread count" from that dashboard at this position
	Include string                   `json:"include"`
	Chart   MonitoringDashboardChart `json:"chart"`
}

type MonitoringDashboardMetric

type MonitoringDashboardMetric struct {
	MetricName  string `json:"metricName"`
	DisplayName string `json:"displayName"`
}

type MonitoringDashboardSpec

type MonitoringDashboardSpec struct {
	Title         string                            `json:"title"`
	Runtime       string                            `json:"runtime"`
	DiscoverOn    string                            `json:"discoverOn"`
	Items         []MonitoringDashboardItem         `json:"items"`
	ExternalLinks []MonitoringDashboardExternalLink `json:"externalLinks"`
}

type MonitoringDashboardsList

type MonitoringDashboardsList struct {
	meta_v1.TypeMeta `json:",inline"`
	meta_v1.ListMeta `json:"metadata"`
	Items            []MonitoringDashboard `json:"items"`
}

func (*MonitoringDashboardsList) DeepCopy

func (in *MonitoringDashboardsList) DeepCopy() *MonitoringDashboardsList

func (*MonitoringDashboardsList) DeepCopyInto

func (in *MonitoringDashboardsList) DeepCopyInto(out *MonitoringDashboardsList)

func (*MonitoringDashboardsList) DeepCopyObject

func (in *MonitoringDashboardsList) DeepCopyObject() runtime.Object