// Copyright (c) HashiCorp, Inc. // SPDX-License-Identifier: BUSL-1.1 package hcp import ( "context" "net/url" "regexp" "sync" "time" "github.com/armon/go-metrics" "github.com/go-openapi/runtime" "github.com/hashicorp/go-hclog" "github.com/hashicorp/consul/agent/hcp/client" "github.com/hashicorp/consul/agent/hcp/telemetry" ) var ( // internalMetricRefreshFailure is a metric to monitor refresh failures. internalMetricRefreshFailure []string = []string{"hcp", "telemetry_config_provider", "refresh", "failure"} // internalMetricRefreshSuccess is a metric to monitor refresh successes. internalMetricRefreshSuccess []string = []string{"hcp", "telemetry_config_provider", "refresh", "success"} // defaultTelemetryConfigRefreshInterval is a default fallback in case the first HCP fetch fails. defaultTelemetryConfigRefreshInterval = 1 * time.Minute ) // Ensure hcpProviderImpl implements telemetry provider interfaces. var _ telemetry.ConfigProvider = &hcpProviderImpl{} var _ telemetry.EndpointProvider = &hcpProviderImpl{} // hcpProviderImpl holds telemetry configuration and settings for continuous fetch of new config from HCP. // it updates configuration, if changes are detected. type hcpProviderImpl struct { // cfg holds configuration that can be dynamically updated. cfg *dynamicConfig // A reader-writer mutex is used as the provider is read heavy. // OTEL components access telemetryConfig during metrics collection and export (read). // Meanwhile, config is only updated when there are changes (write). rw sync.RWMutex // hcpClient is an authenticated client used to make HTTP requests to HCP. hcpClient client.Client } // dynamicConfig is a set of configurable settings for metrics collection, processing and export. // fields MUST be exported to compute hash for equals method. type dynamicConfig struct { disabled bool endpoint *url.URL labels map[string]string filters *regexp.Regexp // refreshInterval controls the interval at which configuration is fetched from HCP to refresh config. refreshInterval time.Duration } // defaultDisabledCfg disables metric collection and contains default config values. func defaultDisabledCfg() *dynamicConfig { return &dynamicConfig{ labels: map[string]string{}, filters: client.DefaultMetricFilters, refreshInterval: defaultTelemetryConfigRefreshInterval, endpoint: nil, disabled: true, } } // NewHCPProvider initializes and starts a HCP Telemetry provider. func NewHCPProvider(ctx context.Context, hcpClient client.Client) *hcpProviderImpl { h := &hcpProviderImpl{ // Initialize with default config values. cfg: defaultDisabledCfg(), hcpClient: hcpClient, } go h.run(ctx) return h } // run continously checks for updates to the telemetry configuration by making a request to HCP. func (h *hcpProviderImpl) run(ctx context.Context) { // Try to initialize config once before starting periodic fetch. h.updateConfig(ctx) ticker := time.NewTicker(h.cfg.refreshInterval) defer ticker.Stop() for { select { case <-ticker.C: if newRefreshInterval := h.updateConfig(ctx); newRefreshInterval > 0 { ticker.Reset(newRefreshInterval) } case <-ctx.Done(): return } } } // updateConfig makes a HTTP request to HCP to update metrics configuration held in the provider. func (h *hcpProviderImpl) updateConfig(ctx context.Context) time.Duration { logger := hclog.FromContext(ctx).Named("telemetry_config_provider") ctx, cancel := context.WithTimeout(ctx, 5*time.Second) defer cancel() telemetryCfg, err := h.hcpClient.FetchTelemetryConfig(ctx) if err != nil { // Only disable metrics on 404 or 401 to handle the case of an unlinked cluster. // For other errors such as 5XX ones, we continue metrics collection, as these are potentially transient server-side errors. apiErr, ok := err.(*runtime.APIError) if ok && apiErr.IsClientError() { disabledMetricsCfg := defaultDisabledCfg() h.modifyDynamicCfg(disabledMetricsCfg) return disabledMetricsCfg.refreshInterval } logger.Error("failed to fetch telemetry config from HCP", "error", err) metrics.IncrCounter(internalMetricRefreshFailure, 1) return 0 } // newRefreshInterval of 0 or less can cause ticker Reset() panic. newRefreshInterval := telemetryCfg.RefreshConfig.RefreshInterval if newRefreshInterval <= 0 { logger.Error("invalid refresh interval duration", "refreshInterval", newRefreshInterval) metrics.IncrCounter(internalMetricRefreshFailure, 1) return 0 } newCfg := &dynamicConfig{ filters: telemetryCfg.MetricsConfig.Filters, endpoint: telemetryCfg.MetricsConfig.Endpoint, labels: telemetryCfg.MetricsConfig.Labels, refreshInterval: telemetryCfg.RefreshConfig.RefreshInterval, disabled: telemetryCfg.MetricsConfig.Disabled, } h.modifyDynamicCfg(newCfg) return newCfg.refreshInterval } // modifyDynamicCfg acquires a write lock to update new configuration and emits a success metric. func (h *hcpProviderImpl) modifyDynamicCfg(newCfg *dynamicConfig) { h.rw.Lock() h.cfg = newCfg h.rw.Unlock() metrics.IncrCounter(internalMetricRefreshSuccess, 1) } // GetEndpoint acquires a read lock to return endpoint configuration for consumers. func (h *hcpProviderImpl) GetEndpoint() *url.URL { h.rw.RLock() defer h.rw.RUnlock() return h.cfg.endpoint } // GetFilters acquires a read lock to return filters configuration for consumers. func (h *hcpProviderImpl) GetFilters() *regexp.Regexp { h.rw.RLock() defer h.rw.RUnlock() return h.cfg.filters } // GetLabels acquires a read lock to return labels configuration for consumers. func (h *hcpProviderImpl) GetLabels() map[string]string { h.rw.RLock() defer h.rw.RUnlock() return h.cfg.labels } // IsDisabled acquires a read lock and return true if metrics are enabled. func (h *hcpProviderImpl) IsDisabled() bool { h.rw.RLock() defer h.rw.RUnlock() return h.cfg.disabled }