googlemanagedprometheus

Documentation

Index

• func GetMetricName(baseName, compliantName string, metric pmetric.Metric) (string, error)
• type Config
  • func DefaultConfig() Config
  • func (c Config) ExtraMetrics(m pmetric.Metrics)
  • func (c Config) MapToPrometheusTarget(res pcommon.Resource) *monitoredrespb.MonitoredResource
  • func (cfg *Config) Validate() error
• type ExtraMetricsConfig

Functions

func GetMetricName

func GetMetricName(baseName, compliantName string, metric pmetric.Metric) (string, error)

GetMetricName returns the GMP-specific suffix. baseName includes type (e.g. summary) suffixes. compliantName is the name of the metric with any sanitization already performed.

Types

type Config

type Config struct {
	// AddMetricSuffixes controls whether suffixes are added to metric names. Defaults to true.
	AddMetricSuffixes bool `mapstructure:"add_metric_suffixes"`
	// ExtraMetricsConfig configures the target_info and otel_scope_info metrics.
	ExtraMetricsConfig ExtraMetricsConfig `mapstructure:"extra_metrics_config"`
	// DestinationProjectQuota enables per-request usage of the destination project's quota.
	DestinationProjectQuota bool `mapstructure:"destination_project_quota"`
}

Config provides configuration options specific to the GMP translation. It is meant to be embedded in the googlemanagedprometheus configuration.

func DefaultConfig

func DefaultConfig() Config

func (Config) ExtraMetrics

func (c Config) ExtraMetrics(m pmetric.Metrics)

func (Config) MapToPrometheusTarget

func (c Config) MapToPrometheusTarget(res pcommon.Resource) *monitoredrespb.MonitoredResource

func (*Config) Validate

func (cfg *Config) Validate() error

Validate checks if the exporter configuration is valid.

type ExtraMetricsConfig

type ExtraMetricsConfig struct {
	// Add `target_info` metric based on the resource. On by default.
	EnableTargetInfo bool `mapstructure:"enable_target_info"`
	// Add `otel_scope_info` metric and `scope_name`/`scope_version` attributes to all other metrics. On by default.
	EnableScopeInfo bool `mapstructure:"enable_scope_info"`
}

ExtraMetricsConfig controls the inclusion of additional metrics.