Documentation
¶
Index ¶
- Constants
- func WithStartTime(startTime pcommon.Timestamp) metricBuilderOption
- type MetricSettings
- type MetricsBuilder
- func (mb *MetricsBuilder) Emit(rmo ...ResourceMetricsOption) pmetric.Metrics
- func (mb *MetricsBuilder) EmitForResource(rmo ...ResourceMetricsOption)
- func (mb *MetricsBuilder) RecordOracledbCPUTimeDataPoint(ts pcommon.Timestamp, val float64)
- func (mb *MetricsBuilder) RecordOracledbDmlLocksLimitDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) RecordOracledbDmlLocksUsageDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) RecordOracledbEnqueueDeadlocksDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) RecordOracledbEnqueueLocksLimitDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) RecordOracledbEnqueueLocksUsageDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) RecordOracledbEnqueueResourcesLimitDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) RecordOracledbEnqueueResourcesUsageDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) RecordOracledbExchangeDeadlocksDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) RecordOracledbExecutionsDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) RecordOracledbHardParsesDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) RecordOracledbLogicalReadsDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) RecordOracledbParseCallsDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) RecordOracledbPgaMemoryDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) RecordOracledbPhysicalReadsDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) RecordOracledbProcessesLimitDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) RecordOracledbProcessesUsageDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) RecordOracledbSessionsLimitDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) RecordOracledbSessionsUsageDataPoint(ts pcommon.Timestamp, inputVal string, sessionTypeAttributeValue string, ...) error
- func (mb *MetricsBuilder) RecordOracledbTablespaceSizeLimitDataPoint(ts pcommon.Timestamp, val int64, tablespaceNameAttributeValue string)
- func (mb *MetricsBuilder) RecordOracledbTablespaceSizeUsageDataPoint(ts pcommon.Timestamp, inputVal string, tablespaceNameAttributeValue string) error
- func (mb *MetricsBuilder) RecordOracledbTransactionsLimitDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) RecordOracledbTransactionsUsageDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) RecordOracledbUserCommitsDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) RecordOracledbUserRollbacksDataPoint(ts pcommon.Timestamp, inputVal string) error
- func (mb *MetricsBuilder) Reset(options ...metricBuilderOption)
- type MetricsBuilderConfig
- type MetricsSettings
- type ResourceAttributeSettings
- type ResourceAttributesSettings
- type ResourceMetricsOption
Constants ¶
const Stability = component.StabilityLevelAlpha
Variables ¶
This section is empty.
Functions ¶
func WithStartTime ¶
WithStartTime sets startTime on the metrics builder.
Types ¶
type MetricSettings ¶
type MetricSettings struct { Enabled bool `mapstructure:"enabled"` // contains filtered or unexported fields }
MetricSettings provides common settings for a particular metric.
type MetricsBuilder ¶
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 settings.
func NewMetricsBuilder ¶
func NewMetricsBuilder(mbc MetricsBuilderConfig, settings receiver.CreateSettings, options ...metricBuilderOption) *MetricsBuilder
func (*MetricsBuilder) Emit ¶
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 settings, e.g. delta or cumulative.
func (*MetricsBuilder) EmitForResource ¶
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) RecordOracledbCPUTimeDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbCPUTimeDataPoint(ts pcommon.Timestamp, val float64)
RecordOracledbCPUTimeDataPoint adds a data point to oracledb.cpu_time metric.
func (*MetricsBuilder) RecordOracledbDmlLocksLimitDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbDmlLocksLimitDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbDmlLocksLimitDataPoint adds a data point to oracledb.dml_locks.limit metric.
func (*MetricsBuilder) RecordOracledbDmlLocksUsageDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbDmlLocksUsageDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbDmlLocksUsageDataPoint adds a data point to oracledb.dml_locks.usage metric.
func (*MetricsBuilder) RecordOracledbEnqueueDeadlocksDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbEnqueueDeadlocksDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbEnqueueDeadlocksDataPoint adds a data point to oracledb.enqueue_deadlocks metric.
func (*MetricsBuilder) RecordOracledbEnqueueLocksLimitDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbEnqueueLocksLimitDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbEnqueueLocksLimitDataPoint adds a data point to oracledb.enqueue_locks.limit metric.
func (*MetricsBuilder) RecordOracledbEnqueueLocksUsageDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbEnqueueLocksUsageDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbEnqueueLocksUsageDataPoint adds a data point to oracledb.enqueue_locks.usage metric.
func (*MetricsBuilder) RecordOracledbEnqueueResourcesLimitDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbEnqueueResourcesLimitDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbEnqueueResourcesLimitDataPoint adds a data point to oracledb.enqueue_resources.limit metric.
func (*MetricsBuilder) RecordOracledbEnqueueResourcesUsageDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbEnqueueResourcesUsageDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbEnqueueResourcesUsageDataPoint adds a data point to oracledb.enqueue_resources.usage metric.
func (*MetricsBuilder) RecordOracledbExchangeDeadlocksDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbExchangeDeadlocksDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbExchangeDeadlocksDataPoint adds a data point to oracledb.exchange_deadlocks metric.
func (*MetricsBuilder) RecordOracledbExecutionsDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbExecutionsDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbExecutionsDataPoint adds a data point to oracledb.executions metric.
func (*MetricsBuilder) RecordOracledbHardParsesDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbHardParsesDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbHardParsesDataPoint adds a data point to oracledb.hard_parses metric.
func (*MetricsBuilder) RecordOracledbLogicalReadsDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbLogicalReadsDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbLogicalReadsDataPoint adds a data point to oracledb.logical_reads metric.
func (*MetricsBuilder) RecordOracledbParseCallsDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbParseCallsDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbParseCallsDataPoint adds a data point to oracledb.parse_calls metric.
func (*MetricsBuilder) RecordOracledbPgaMemoryDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbPgaMemoryDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbPgaMemoryDataPoint adds a data point to oracledb.pga_memory metric.
func (*MetricsBuilder) RecordOracledbPhysicalReadsDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbPhysicalReadsDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbPhysicalReadsDataPoint adds a data point to oracledb.physical_reads metric.
func (*MetricsBuilder) RecordOracledbProcessesLimitDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbProcessesLimitDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbProcessesLimitDataPoint adds a data point to oracledb.processes.limit metric.
func (*MetricsBuilder) RecordOracledbProcessesUsageDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbProcessesUsageDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbProcessesUsageDataPoint adds a data point to oracledb.processes.usage metric.
func (*MetricsBuilder) RecordOracledbSessionsLimitDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbSessionsLimitDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbSessionsLimitDataPoint adds a data point to oracledb.sessions.limit metric.
func (*MetricsBuilder) RecordOracledbSessionsUsageDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbSessionsUsageDataPoint(ts pcommon.Timestamp, inputVal string, sessionTypeAttributeValue string, sessionStatusAttributeValue string) error
RecordOracledbSessionsUsageDataPoint adds a data point to oracledb.sessions.usage metric.
func (*MetricsBuilder) RecordOracledbTablespaceSizeLimitDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbTablespaceSizeLimitDataPoint(ts pcommon.Timestamp, val int64, tablespaceNameAttributeValue string)
RecordOracledbTablespaceSizeLimitDataPoint adds a data point to oracledb.tablespace_size.limit metric.
func (*MetricsBuilder) RecordOracledbTablespaceSizeUsageDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbTablespaceSizeUsageDataPoint(ts pcommon.Timestamp, inputVal string, tablespaceNameAttributeValue string) error
RecordOracledbTablespaceSizeUsageDataPoint adds a data point to oracledb.tablespace_size.usage metric.
func (*MetricsBuilder) RecordOracledbTransactionsLimitDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbTransactionsLimitDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbTransactionsLimitDataPoint adds a data point to oracledb.transactions.limit metric.
func (*MetricsBuilder) RecordOracledbTransactionsUsageDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbTransactionsUsageDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbTransactionsUsageDataPoint adds a data point to oracledb.transactions.usage metric.
func (*MetricsBuilder) RecordOracledbUserCommitsDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbUserCommitsDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbUserCommitsDataPoint adds a data point to oracledb.user_commits metric.
func (*MetricsBuilder) RecordOracledbUserRollbacksDataPoint ¶
func (mb *MetricsBuilder) RecordOracledbUserRollbacksDataPoint(ts pcommon.Timestamp, inputVal string) error
RecordOracledbUserRollbacksDataPoint adds a data point to oracledb.user_rollbacks metric.
func (*MetricsBuilder) Reset ¶
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.73.0
type MetricsBuilderConfig struct { Metrics MetricsSettings `mapstructure:"metrics"` ResourceAttributes ResourceAttributesSettings `mapstructure:"resource_attributes"` }
MetricsBuilderConfig is a structural subset of an otherwise 1-1 copy of metadata.yaml
func DefaultMetricsBuilderConfig ¶ added in v0.73.0
func DefaultMetricsBuilderConfig() MetricsBuilderConfig
func NewMetricsBuilderConfig ¶ added in v0.73.0
func NewMetricsBuilderConfig(ms MetricsSettings, ras ResourceAttributesSettings) MetricsBuilderConfig
type MetricsSettings ¶
type MetricsSettings struct { OracledbCPUTime MetricSettings `mapstructure:"oracledb.cpu_time"` OracledbDmlLocksLimit MetricSettings `mapstructure:"oracledb.dml_locks.limit"` OracledbDmlLocksUsage MetricSettings `mapstructure:"oracledb.dml_locks.usage"` OracledbEnqueueDeadlocks MetricSettings `mapstructure:"oracledb.enqueue_deadlocks"` OracledbEnqueueLocksLimit MetricSettings `mapstructure:"oracledb.enqueue_locks.limit"` OracledbEnqueueLocksUsage MetricSettings `mapstructure:"oracledb.enqueue_locks.usage"` OracledbEnqueueResourcesLimit MetricSettings `mapstructure:"oracledb.enqueue_resources.limit"` OracledbEnqueueResourcesUsage MetricSettings `mapstructure:"oracledb.enqueue_resources.usage"` OracledbExchangeDeadlocks MetricSettings `mapstructure:"oracledb.exchange_deadlocks"` OracledbExecutions MetricSettings `mapstructure:"oracledb.executions"` OracledbHardParses MetricSettings `mapstructure:"oracledb.hard_parses"` OracledbLogicalReads MetricSettings `mapstructure:"oracledb.logical_reads"` OracledbParseCalls MetricSettings `mapstructure:"oracledb.parse_calls"` OracledbPgaMemory MetricSettings `mapstructure:"oracledb.pga_memory"` OracledbPhysicalReads MetricSettings `mapstructure:"oracledb.physical_reads"` OracledbProcessesLimit MetricSettings `mapstructure:"oracledb.processes.limit"` OracledbProcessesUsage MetricSettings `mapstructure:"oracledb.processes.usage"` OracledbSessionsLimit MetricSettings `mapstructure:"oracledb.sessions.limit"` OracledbSessionsUsage MetricSettings `mapstructure:"oracledb.sessions.usage"` OracledbTablespaceSizeLimit MetricSettings `mapstructure:"oracledb.tablespace_size.limit"` OracledbTablespaceSizeUsage MetricSettings `mapstructure:"oracledb.tablespace_size.usage"` OracledbTransactionsLimit MetricSettings `mapstructure:"oracledb.transactions.limit"` OracledbTransactionsUsage MetricSettings `mapstructure:"oracledb.transactions.usage"` OracledbUserCommits MetricSettings `mapstructure:"oracledb.user_commits"` OracledbUserRollbacks MetricSettings `mapstructure:"oracledb.user_rollbacks"` }
MetricsSettings provides settings for oracledbreceiver metrics.
func DefaultMetricsSettings ¶
func DefaultMetricsSettings() MetricsSettings
type ResourceAttributeSettings ¶ added in v0.70.0
type ResourceAttributeSettings struct {
Enabled bool `mapstructure:"enabled"`
}
ResourceAttributeSettings provides common settings for a particular metric.
type ResourceAttributesSettings ¶ added in v0.70.0
type ResourceAttributesSettings struct {
OracledbInstanceName ResourceAttributeSettings `mapstructure:"oracledb.instance.name"`
}
ResourceAttributesSettings provides settings for oracledbreceiver metrics.
func DefaultResourceAttributesSettings ¶ added in v0.70.0
func DefaultResourceAttributesSettings() ResourceAttributesSettings
type ResourceMetricsOption ¶
type ResourceMetricsOption func(ResourceAttributesSettings, pmetric.ResourceMetrics)
ResourceMetricsOption applies changes to provided resource metrics.
func WithOracledbInstanceName ¶
func WithOracledbInstanceName(val string) ResourceMetricsOption
WithOracledbInstanceName sets provided value as "oracledb.instance.name" attribute for current resource.
func WithStartTimeOverride ¶
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.