metadata

package
v0.99.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 22, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	MetricsStability = component.StabilityLevelDevelopment
)

Variables

View Source 
var (
	Type = component.MustNewType("splunkenterprise")
)

Functions

func Meter added in v0.92.0 

func Meter(settings component.TelemetrySettings) metric.Meter

func Tracer added in v0.92.0 

func Tracer(settings component.TelemetrySettings) trace.Tracer

func WithStartTime added in v0.86.0 

func WithStartTime(startTime pcommon.Timestamp) metricBuilderOption

WithStartTime sets startTime on the metrics builder.

Types

type MetricConfig added in v0.86.0 

type MetricConfig struct {
	Enabled bool `mapstructure:"enabled"`
	// contains filtered or unexported fields
}

MetricConfig provides common config for a particular metric.

func (*MetricConfig) Unmarshal added in v0.86.0 

func (ms *MetricConfig) Unmarshal(parser *confmap.Conf) error

type MetricsBuilder added in v0.86.0 

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

MetricsBuilder provides an interface for scrapers to report metrics while taking care of all the transformations required to produce metric representation defined in metadata and user config.

func NewMetricsBuilder added in v0.86.0 

func NewMetricsBuilder(mbc MetricsBuilderConfig, settings receiver.CreateSettings, options ...metricBuilderOption) *MetricsBuilder

func (*MetricsBuilder) Emit added in v0.86.0 

func (mb *MetricsBuilder) Emit(rmo ...ResourceMetricsOption) pmetric.Metrics

Emit returns all the metrics accumulated by the metrics builder and updates the internal state to be ready for recording another set of metrics. This function will be responsible for applying all the transformations required to produce metric representation defined in metadata and user config, e.g. delta or cumulative.

func (*MetricsBuilder) EmitForResource added in v0.86.0 

func (mb *MetricsBuilder) EmitForResource(rmo ...ResourceMetricsOption)

EmitForResource saves all the generated metrics under a new resource and updates the internal state to be ready for recording another set of data points as part of another resource. This function can be helpful when one scraper needs to emit metrics from several resources. Otherwise calling this function is not required, just `Emit` function can be called instead. Resource attributes should be provided as ResourceMetricsOption arguments.

func (*MetricsBuilder) RecordSplunkAggregationQueueRatioDataPoint added in v0.95.0 

func (mb *MetricsBuilder) RecordSplunkAggregationQueueRatioDataPoint(ts pcommon.Timestamp, val float64, splunkHostAttributeValue string)

RecordSplunkAggregationQueueRatioDataPoint adds a data point to splunk.aggregation.queue.ratio metric.

func (*MetricsBuilder) RecordSplunkBucketsSearchableStatusDataPoint added in v0.95.0 

func (mb *MetricsBuilder) RecordSplunkBucketsSearchableStatusDataPoint(ts pcommon.Timestamp, val int64, splunkHostAttributeValue string, splunkIndexerSearchableAttributeValue string)

RecordSplunkBucketsSearchableStatusDataPoint adds a data point to splunk.buckets.searchable.status metric.

func (*MetricsBuilder) RecordSplunkDataIndexesExtendedBucketCountDataPoint added in v0.87.0 

func (mb *MetricsBuilder) RecordSplunkDataIndexesExtendedBucketCountDataPoint(ts pcommon.Timestamp, val int64, splunkIndexNameAttributeValue string)

RecordSplunkDataIndexesExtendedBucketCountDataPoint adds a data point to splunk.data.indexes.extended.bucket.count metric.

func (*MetricsBuilder) RecordSplunkDataIndexesExtendedBucketEventCountDataPoint added in v0.87.0 

func (mb *MetricsBuilder) RecordSplunkDataIndexesExtendedBucketEventCountDataPoint(ts pcommon.Timestamp, val int64, splunkIndexNameAttributeValue string, splunkBucketDirAttributeValue string)

RecordSplunkDataIndexesExtendedBucketEventCountDataPoint adds a data point to splunk.data.indexes.extended.bucket.event.count metric.

func (*MetricsBuilder) RecordSplunkDataIndexesExtendedBucketHotCountDataPoint added in v0.87.0 

func (mb *MetricsBuilder) RecordSplunkDataIndexesExtendedBucketHotCountDataPoint(ts pcommon.Timestamp, val int64, splunkIndexNameAttributeValue string, splunkBucketDirAttributeValue string)

RecordSplunkDataIndexesExtendedBucketHotCountDataPoint adds a data point to splunk.data.indexes.extended.bucket.hot.count metric.

func (*MetricsBuilder) RecordSplunkDataIndexesExtendedBucketWarmCountDataPoint added in v0.87.0 

func (mb *MetricsBuilder) RecordSplunkDataIndexesExtendedBucketWarmCountDataPoint(ts pcommon.Timestamp, val int64, splunkIndexNameAttributeValue string, splunkBucketDirAttributeValue string)

RecordSplunkDataIndexesExtendedBucketWarmCountDataPoint adds a data point to splunk.data.indexes.extended.bucket.warm.count metric.

func (*MetricsBuilder) RecordSplunkDataIndexesExtendedEventCountDataPoint added in v0.87.0 

func (mb *MetricsBuilder) RecordSplunkDataIndexesExtendedEventCountDataPoint(ts pcommon.Timestamp, val int64, splunkIndexNameAttributeValue string)

RecordSplunkDataIndexesExtendedEventCountDataPoint adds a data point to splunk.data.indexes.extended.event.count metric.

func (*MetricsBuilder) RecordSplunkDataIndexesExtendedRawSizeDataPoint added in v0.87.0 

func (mb *MetricsBuilder) RecordSplunkDataIndexesExtendedRawSizeDataPoint(ts pcommon.Timestamp, val int64, splunkIndexNameAttributeValue string)

RecordSplunkDataIndexesExtendedRawSizeDataPoint adds a data point to splunk.data.indexes.extended.raw.size metric.

func (*MetricsBuilder) RecordSplunkDataIndexesExtendedTotalSizeDataPoint added in v0.87.0 

func (mb *MetricsBuilder) RecordSplunkDataIndexesExtendedTotalSizeDataPoint(ts pcommon.Timestamp, val int64, splunkIndexNameAttributeValue string)

RecordSplunkDataIndexesExtendedTotalSizeDataPoint adds a data point to splunk.data.indexes.extended.total.size metric.

func (*MetricsBuilder) RecordSplunkIndexerAvgRateDataPoint added in v0.95.0 

func (mb *MetricsBuilder) RecordSplunkIndexerAvgRateDataPoint(ts pcommon.Timestamp, val float64, splunkHostAttributeValue string)

RecordSplunkIndexerAvgRateDataPoint adds a data point to splunk.indexer.avg.rate metric.

func (*MetricsBuilder) RecordSplunkIndexerCPUTimeDataPoint added in v0.95.0 

func (mb *MetricsBuilder) RecordSplunkIndexerCPUTimeDataPoint(ts pcommon.Timestamp, val float64, splunkHostAttributeValue string)

RecordSplunkIndexerCPUTimeDataPoint adds a data point to splunk.indexer.cpu.time metric.

func (*MetricsBuilder) RecordSplunkIndexerQueueRatioDataPoint added in v0.95.0 

func (mb *MetricsBuilder) RecordSplunkIndexerQueueRatioDataPoint(ts pcommon.Timestamp, val float64, splunkHostAttributeValue string)

RecordSplunkIndexerQueueRatioDataPoint adds a data point to splunk.indexer.queue.ratio metric.

func (*MetricsBuilder) RecordSplunkIndexerRawWriteTimeDataPoint added in v0.95.0 

func (mb *MetricsBuilder) RecordSplunkIndexerRawWriteTimeDataPoint(ts pcommon.Timestamp, val float64, splunkHostAttributeValue string)

RecordSplunkIndexerRawWriteTimeDataPoint adds a data point to splunk.indexer.raw.write.time metric.

func (*MetricsBuilder) RecordSplunkIndexerThroughputDataPoint added in v0.86.0 

func (mb *MetricsBuilder) RecordSplunkIndexerThroughputDataPoint(ts pcommon.Timestamp, val float64, splunkIndexerStatusAttributeValue string)

RecordSplunkIndexerThroughputDataPoint adds a data point to splunk.indexer.throughput metric.

func (*MetricsBuilder) RecordSplunkIndexesAvgSizeDataPoint added in v0.95.0 

func (mb *MetricsBuilder) RecordSplunkIndexesAvgSizeDataPoint(ts pcommon.Timestamp, val float64, splunkIndexNameAttributeValue string)

RecordSplunkIndexesAvgSizeDataPoint adds a data point to splunk.indexes.avg.size metric.

func (*MetricsBuilder) RecordSplunkIndexesAvgUsageDataPoint added in v0.95.0 

func (mb *MetricsBuilder) RecordSplunkIndexesAvgUsageDataPoint(ts pcommon.Timestamp, val float64, splunkIndexNameAttributeValue string)

RecordSplunkIndexesAvgUsageDataPoint adds a data point to splunk.indexes.avg.usage metric.

func (*MetricsBuilder) RecordSplunkIndexesBucketCountDataPoint added in v0.95.0 

func (mb *MetricsBuilder) RecordSplunkIndexesBucketCountDataPoint(ts pcommon.Timestamp, val int64, splunkIndexNameAttributeValue string)

RecordSplunkIndexesBucketCountDataPoint adds a data point to splunk.indexes.bucket.count metric.

func (*MetricsBuilder) RecordSplunkIndexesMedianDataAgeDataPoint added in v0.95.0 

func (mb *MetricsBuilder) RecordSplunkIndexesMedianDataAgeDataPoint(ts pcommon.Timestamp, val int64, splunkIndexNameAttributeValue string)

RecordSplunkIndexesMedianDataAgeDataPoint adds a data point to splunk.indexes.median.data.age metric.

func (*MetricsBuilder) RecordSplunkIndexesSizeDataPoint added in v0.95.0 

func (mb *MetricsBuilder) RecordSplunkIndexesSizeDataPoint(ts pcommon.Timestamp, val float64, splunkIndexNameAttributeValue string)

RecordSplunkIndexesSizeDataPoint adds a data point to splunk.indexes.size metric.

func (*MetricsBuilder) RecordSplunkIoAvgIopsDataPoint added in v0.95.0 

func (mb *MetricsBuilder) RecordSplunkIoAvgIopsDataPoint(ts pcommon.Timestamp, val int64, splunkHostAttributeValue string)

RecordSplunkIoAvgIopsDataPoint adds a data point to splunk.io.avg.iops metric.

func (*MetricsBuilder) RecordSplunkLicenseIndexUsageDataPoint added in v0.86.0 

func (mb *MetricsBuilder) RecordSplunkLicenseIndexUsageDataPoint(ts pcommon.Timestamp, val int64, splunkIndexNameAttributeValue string)

RecordSplunkLicenseIndexUsageDataPoint adds a data point to splunk.license.index.usage metric.

func (*MetricsBuilder) RecordSplunkParseQueueRatioDataPoint added in v0.95.0 

func (mb *MetricsBuilder) RecordSplunkParseQueueRatioDataPoint(ts pcommon.Timestamp, val float64, splunkHostAttributeValue string)

RecordSplunkParseQueueRatioDataPoint adds a data point to splunk.parse.queue.ratio metric.

func (*MetricsBuilder) RecordSplunkPipelineSetCountDataPoint added in v0.95.0 

func (mb *MetricsBuilder) RecordSplunkPipelineSetCountDataPoint(ts pcommon.Timestamp, val int64, splunkHostAttributeValue string)

RecordSplunkPipelineSetCountDataPoint adds a data point to splunk.pipeline.set.count metric.

func (*MetricsBuilder) RecordSplunkSchedulerAvgExecutionLatencyDataPoint added in v0.95.0 

func (mb *MetricsBuilder) RecordSplunkSchedulerAvgExecutionLatencyDataPoint(ts pcommon.Timestamp, val float64, splunkHostAttributeValue string)

RecordSplunkSchedulerAvgExecutionLatencyDataPoint adds a data point to splunk.scheduler.avg.execution.latency metric.

func (*MetricsBuilder) RecordSplunkSchedulerAvgRunTimeDataPoint added in v0.95.0 

func (mb *MetricsBuilder) RecordSplunkSchedulerAvgRunTimeDataPoint(ts pcommon.Timestamp, val float64, splunkHostAttributeValue string)

RecordSplunkSchedulerAvgRunTimeDataPoint adds a data point to splunk.scheduler.avg.run.time metric.

func (*MetricsBuilder) RecordSplunkSchedulerCompletionRatioDataPoint added in v0.95.0 

func (mb *MetricsBuilder) RecordSplunkSchedulerCompletionRatioDataPoint(ts pcommon.Timestamp, val float64, splunkHostAttributeValue string)

RecordSplunkSchedulerCompletionRatioDataPoint adds a data point to splunk.scheduler.completion.ratio metric.

func (*MetricsBuilder) RecordSplunkServerIntrospectionQueuesCurrentBytesDataPoint added in v0.87.0 

func (mb *MetricsBuilder) RecordSplunkServerIntrospectionQueuesCurrentBytesDataPoint(ts pcommon.Timestamp, val int64, splunkQueueNameAttributeValue string)

RecordSplunkServerIntrospectionQueuesCurrentBytesDataPoint adds a data point to splunk.server.introspection.queues.current.bytes metric.

func (*MetricsBuilder) RecordSplunkServerIntrospectionQueuesCurrentDataPoint added in v0.87.0 

func (mb *MetricsBuilder) RecordSplunkServerIntrospectionQueuesCurrentDataPoint(ts pcommon.Timestamp, val int64, splunkQueueNameAttributeValue string)

RecordSplunkServerIntrospectionQueuesCurrentDataPoint adds a data point to splunk.server.introspection.queues.current metric.

func (*MetricsBuilder) RecordSplunkTypingQueueRatioDataPoint added in v0.95.0 

func (mb *MetricsBuilder) RecordSplunkTypingQueueRatioDataPoint(ts pcommon.Timestamp, val float64, splunkHostAttributeValue string)

RecordSplunkTypingQueueRatioDataPoint adds a data point to splunk.typing.queue.ratio metric.

func (*MetricsBuilder) Reset added in v0.86.0 

func (mb *MetricsBuilder) Reset(options ...metricBuilderOption)

Reset resets metrics builder to its initial state. It should be used when external metrics source is restarted, and metrics builder should update its startTime and reset it's internal state accordingly.

type MetricsBuilderConfig added in v0.86.0 

type MetricsBuilderConfig struct {
	Metrics MetricsConfig `mapstructure:"metrics"`
}

MetricsBuilderConfig is a configuration for splunkenterprise metrics builder.

func DefaultMetricsBuilderConfig added in v0.86.0 

func DefaultMetricsBuilderConfig() MetricsBuilderConfig

type MetricsConfig added in v0.86.0 

type MetricsConfig struct {
	SplunkAggregationQueueRatio                 MetricConfig `mapstructure:"splunk.aggregation.queue.ratio"`
	SplunkBucketsSearchableStatus               MetricConfig `mapstructure:"splunk.buckets.searchable.status"`
	SplunkDataIndexesExtendedBucketCount        MetricConfig `mapstructure:"splunk.data.indexes.extended.bucket.count"`
	SplunkDataIndexesExtendedBucketEventCount   MetricConfig `mapstructure:"splunk.data.indexes.extended.bucket.event.count"`
	SplunkDataIndexesExtendedBucketHotCount     MetricConfig `mapstructure:"splunk.data.indexes.extended.bucket.hot.count"`
	SplunkDataIndexesExtendedBucketWarmCount    MetricConfig `mapstructure:"splunk.data.indexes.extended.bucket.warm.count"`
	SplunkDataIndexesExtendedEventCount         MetricConfig `mapstructure:"splunk.data.indexes.extended.event.count"`
	SplunkDataIndexesExtendedRawSize            MetricConfig `mapstructure:"splunk.data.indexes.extended.raw.size"`
	SplunkDataIndexesExtendedTotalSize          MetricConfig `mapstructure:"splunk.data.indexes.extended.total.size"`
	SplunkIndexerAvgRate                        MetricConfig `mapstructure:"splunk.indexer.avg.rate"`
	SplunkIndexerCPUTime                        MetricConfig `mapstructure:"splunk.indexer.cpu.time"`
	SplunkIndexerQueueRatio                     MetricConfig `mapstructure:"splunk.indexer.queue.ratio"`
	SplunkIndexerRawWriteTime                   MetricConfig `mapstructure:"splunk.indexer.raw.write.time"`
	SplunkIndexerThroughput                     MetricConfig `mapstructure:"splunk.indexer.throughput"`
	SplunkIndexesAvgSize                        MetricConfig `mapstructure:"splunk.indexes.avg.size"`
	SplunkIndexesAvgUsage                       MetricConfig `mapstructure:"splunk.indexes.avg.usage"`
	SplunkIndexesBucketCount                    MetricConfig `mapstructure:"splunk.indexes.bucket.count"`
	SplunkIndexesMedianDataAge                  MetricConfig `mapstructure:"splunk.indexes.median.data.age"`
	SplunkIndexesSize                           MetricConfig `mapstructure:"splunk.indexes.size"`
	SplunkIoAvgIops                             MetricConfig `mapstructure:"splunk.io.avg.iops"`
	SplunkLicenseIndexUsage                     MetricConfig `mapstructure:"splunk.license.index.usage"`
	SplunkParseQueueRatio                       MetricConfig `mapstructure:"splunk.parse.queue.ratio"`
	SplunkPipelineSetCount                      MetricConfig `mapstructure:"splunk.pipeline.set.count"`
	SplunkSchedulerAvgExecutionLatency          MetricConfig `mapstructure:"splunk.scheduler.avg.execution.latency"`
	SplunkSchedulerAvgRunTime                   MetricConfig `mapstructure:"splunk.scheduler.avg.run.time"`
	SplunkSchedulerCompletionRatio              MetricConfig `mapstructure:"splunk.scheduler.completion.ratio"`
	SplunkServerIntrospectionQueuesCurrent      MetricConfig `mapstructure:"splunk.server.introspection.queues.current"`
	SplunkServerIntrospectionQueuesCurrentBytes MetricConfig `mapstructure:"splunk.server.introspection.queues.current.bytes"`
	SplunkTypingQueueRatio                      MetricConfig `mapstructure:"splunk.typing.queue.ratio"`
}

MetricsConfig provides config for splunkenterprise metrics.

func DefaultMetricsConfig added in v0.86.0 

func DefaultMetricsConfig() MetricsConfig

type ResourceMetricsOption added in v0.86.0 

type ResourceMetricsOption func(pmetric.ResourceMetrics)

ResourceMetricsOption applies changes to provided resource metrics.

func WithResource added in v0.86.0 

func WithResource(res pcommon.Resource) ResourceMetricsOption

WithResource sets the provided resource on the emitted ResourceMetrics. It's recommended to use ResourceBuilder to create the resource.

func WithStartTimeOverride added in v0.86.0 

func WithStartTimeOverride(start pcommon.Timestamp) ResourceMetricsOption

WithStartTimeOverride overrides start time for all the resource metrics data points. This option should be only used if different start time has to be set on metrics coming from different resources.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.