googlemanagedprometheus

Documentation

Index

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

Constants

const (
	// Special attribute key used by Ops Agent prometheus receiver to denote untyped
	// prometheus metric. Internal use only.
	GCPOpsAgentUntypedMetricKey = "prometheus.googleapis.com/internal/untyped_metric"
)

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"`
}

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) GetMetricName

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

GetMetricName returns the metric name with GMP-specific suffixes. The.

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.