metadata

Documentation

Index

• Constants
• Variables
• func Meter(settings component.TelemetrySettings) metric.Meter
• func Tracer(settings component.TelemetrySettings) trace.Tracer
• func TruncateString(str string, length int) string
• type LabelValue
• type LabelValueMetadata
  • func NewLabelValueMetadata(name string, columnName string, valueType ValueType) (LabelValueMetadata, error)
• type MetricType
  • func NewMetricType(dataType pmetric.MetricType, ...) MetricType
• type MetricValue
• type MetricValueMetadata
  • func NewMetricValueMetadata(name string, columnName string, dataType MetricType, unit string, ...) (MetricValueMetadata, error)
• type MetricsBuilder
  • func NewMetricsFromDataPointBuilder(filterResolver filter.ItemFilterResolver) MetricsBuilder
• type MetricsDataPoint
  • func (mdp *MetricsDataPoint) CopyTo(dataPoint pmetric.NumberDataPoint)
  • func (mdp *MetricsDataPoint) GroupingKey() MetricsDataPointKey
  • func (mdp *MetricsDataPoint) HideLockStatsRowrangestartkeyPII()
  • func (mdp *MetricsDataPoint) ToItem() (*filter.Item, error)
  • func (mdp *MetricsDataPoint) TruncateQueryText(length int)
• type MetricsDataPointKey
• type MetricsMetadata
  • func (metadata *MetricsMetadata) MetadataType() MetricsMetadataType
  • func (metadata *MetricsMetadata) RowToMetricsDataPoints(databaseID *datasource.DatabaseID, row *spanner.Row) ([]*MetricsDataPoint, error)
• type MetricsMetadataType
• type ValueMetadata
• type ValueType

Constants

const (
	MetricsStability = component.StabilityLevelBeta
)

Variables

var (
	Type = component.MustNewType("googlecloudspanner")
)

Functions

func Meter

func Meter(settings component.TelemetrySettings) metric.Meter

func Tracer

func Tracer(settings component.TelemetrySettings) trace.Tracer

func TruncateString

func TruncateString(str string, length int) string

Types

type LabelValue

type LabelValue interface {
	Metadata() LabelValueMetadata
	Value() any
	SetValueTo(attributes pcommon.Map)
}

type LabelValueMetadata

type LabelValueMetadata interface {
	ValueMetadata
	ValueType() ValueType
	NewLabelValue(value any) LabelValue
}

func NewLabelValueMetadata

func NewLabelValueMetadata(name string, columnName string, valueType ValueType) (LabelValueMetadata, error)

type MetricType

type MetricType interface {
	MetricType() pmetric.MetricType
	AggregationTemporality() pmetric.AggregationTemporality
	IsMonotonic() bool
}

func NewMetricType

func NewMetricType(dataType pmetric.MetricType, aggregationTemporality pmetric.AggregationTemporality,
	isMonotonic bool) MetricType

type MetricValue

type MetricValue interface {
	Metadata() MetricValueMetadata
	Value() any
	SetValueTo(ndp pmetric.NumberDataPoint)
}

type MetricValueMetadata

type MetricValueMetadata interface {
	ValueMetadata
	ValueType() ValueType
	DataType() MetricType
	Unit() string
	NewMetricValue(value any) MetricValue
}

func NewMetricValueMetadata

func NewMetricValueMetadata(name string, columnName string, dataType MetricType, unit string,
	valueType ValueType) (MetricValueMetadata, error)

type MetricsBuilder

type MetricsBuilder interface {
	Build(dataPoints []*MetricsDataPoint) (pmetric.Metrics, error)
	Shutdown() error
}

func NewMetricsFromDataPointBuilder

func NewMetricsFromDataPointBuilder(filterResolver filter.ItemFilterResolver) MetricsBuilder

type MetricsDataPoint

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

func (*MetricsDataPoint) CopyTo

func (mdp *MetricsDataPoint) CopyTo(dataPoint pmetric.NumberDataPoint)

func (*MetricsDataPoint) GroupingKey

func (mdp *MetricsDataPoint) GroupingKey() MetricsDataPointKey

func (*MetricsDataPoint) HideLockStatsRowrangestartkeyPII

func (mdp *MetricsDataPoint) HideLockStatsRowrangestartkeyPII()

func (*MetricsDataPoint) ToItem

func (mdp *MetricsDataPoint) ToItem() (*filter.Item, error)

func (*MetricsDataPoint) TruncateQueryText

func (mdp *MetricsDataPoint) TruncateQueryText(length int)

type MetricsDataPointKey

type MetricsDataPointKey struct {
	MetricName string
	MetricUnit string
	MetricType MetricType
}

type MetricsMetadata

type MetricsMetadata struct {
	Name                string
	Query               string
	MetricNamePrefix    string
	TimestampColumnName string
	HighCardinality     bool
	// In addition to common metric labels
	QueryLabelValuesMetadata  []LabelValueMetadata
	QueryMetricValuesMetadata []MetricValueMetadata
}

func (*MetricsMetadata) MetadataType

func (metadata *MetricsMetadata) MetadataType() MetricsMetadataType

func (*MetricsMetadata) RowToMetricsDataPoints

func (metadata *MetricsMetadata) RowToMetricsDataPoints(databaseID *datasource.DatabaseID, row *spanner.Row) ([]*MetricsDataPoint, error)

type MetricsMetadataType

type MetricsMetadataType int32

const (
	MetricsMetadataTypeCurrentStats MetricsMetadataType = iota
	MetricsMetadataTypeIntervalStats
)

type ValueMetadata

type ValueMetadata interface {
	Name() string
	ColumnName() string
	ValueHolder() any
}

type ValueType

type ValueType string

const (
	UnknownValueType          ValueType = "unknown"
	StringValueType           ValueType = "string"
	IntValueType              ValueType = "int"
	FloatValueType            ValueType = "float"
	NullFloatValueType        ValueType = "null_float"
	BoolValueType             ValueType = "bool"
	StringSliceValueType      ValueType = "string_slice"
	ByteSliceValueType        ValueType = "byte_slice"
	LockRequestSliceValueType ValueType = "lock_request_slice"
)