github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/query/storage/promremote/options.go

// Copyright (c) 2021  Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package promremote

import (
	"errors"
	"fmt"
	"strings"

	"github.com/m3db/m3/src/cmd/services/m3query/config"
	"github.com/m3db/m3/src/query/storage/m3"
	"github.com/m3db/m3/src/query/storage/m3/storagemetadata"
	xhttp "github.com/m3db/m3/src/x/net/http"

	"github.com/uber-go/tally"
	"go.uber.org/zap"
)

// NewOptions constructs Options based on the given config.
func NewOptions(
	cfg *config.PrometheusRemoteBackendConfiguration,
	scope tally.Scope,
	logger *zap.Logger,
) (Options, error) {
	err := validateBackendConfiguration(cfg)
	if err != nil {
		return Options{}, err
	}
	endpoints := make([]EndpointOptions, 0, len(cfg.Endpoints))

	for _, endpoint := range cfg.Endpoints {
		var (
			attr = storagemetadata.Attributes{
				MetricsType: storagemetadata.UnaggregatedMetricsType,
			}
			downsampleOptions *m3.ClusterNamespaceDownsampleOptions
		)
		if endpoint.StoragePolicy != nil {
			attr.MetricsType = storagemetadata.AggregatedMetricsType
			attr.Resolution = endpoint.StoragePolicy.Resolution
			attr.Retention = endpoint.StoragePolicy.Retention
			downsampleOptions = &m3.DefaultClusterNamespaceDownsampleOptions
			if downsample := endpoint.StoragePolicy.Downsample; downsample != nil {
				downsampleOptions = &m3.ClusterNamespaceDownsampleOptions{
					All: downsample.All,
				}
			}
		}
		endpoints = append(endpoints, EndpointOptions{
			name:              endpoint.Name,
			address:           endpoint.Address,
			attributes:        attr,
			downsampleOptions: downsampleOptions,
		})
	}
	clientOpts := xhttp.DefaultHTTPClientOptions()
	if cfg.RequestTimeout != nil {
		clientOpts.RequestTimeout = *cfg.RequestTimeout
	}
	if cfg.ConnectTimeout != nil {
		clientOpts.ConnectTimeout = *cfg.ConnectTimeout
	}
	if cfg.KeepAlive != nil {
		clientOpts.KeepAlive = *cfg.KeepAlive
	}
	if cfg.IdleConnTimeout != nil {
		clientOpts.IdleConnTimeout = *cfg.IdleConnTimeout
	}
	if cfg.MaxIdleConns != nil {
		clientOpts.MaxIdleConns = *cfg.MaxIdleConns
	}

	clientOpts.DisableCompression = true // Already snappy compressed.

	return Options{
		endpoints:   endpoints,
		httpOptions: clientOpts,
		scope:       scope,
		logger:      logger,
	}, nil
}

func validateBackendConfiguration(cfg *config.PrometheusRemoteBackendConfiguration) error {
	if cfg == nil {
		return fmt.Errorf("prometheusRemoteBackend configuration is required")
	}
	if len(cfg.Endpoints) == 0 {
		return fmt.Errorf(
			"at least one endpoint must be configured when using %s backend type",
			config.PromRemoteStorageType,
		)
	}
	if cfg.MaxIdleConns != nil && *cfg.MaxIdleConns < 0 {
		return errors.New("maxIdleConns can't be negative")
	}
	if cfg.KeepAlive != nil && *cfg.KeepAlive < 0 {
		return errors.New("keepAlive can't be negative")
	}
	if cfg.IdleConnTimeout != nil && *cfg.IdleConnTimeout < 0 {
		return errors.New("idleConnTimeout can't be negative")
	}
	if cfg.RequestTimeout != nil && *cfg.RequestTimeout < 0 {
		return errors.New("requestTimeout can't be negative")
	}
	if cfg.ConnectTimeout != nil && *cfg.ConnectTimeout < 0 {
		return errors.New("connectTimeout can't be negative")
	}

	seenNames := map[string]struct{}{}
	for _, endpoint := range cfg.Endpoints {
		if err := validateEndpointConfiguration(endpoint); err != nil {
			return err
		}
		if _, ok := seenNames[endpoint.Name]; ok {
			return fmt.Errorf("endpoint name %s is not unique, ensure all endpoint names are unique", endpoint.Name)
		}
		seenNames[endpoint.Name] = struct{}{}
	}
	return nil
}

func validateEndpointConfiguration(endpoint config.PrometheusRemoteBackendEndpointConfiguration) error {
	if endpoint.StoragePolicy != nil {
		if endpoint.StoragePolicy.Resolution <= 0 {
			return errors.New("endpoint resolution must be positive")
		}
		if endpoint.StoragePolicy.Retention <= 0 {
			return errors.New("endpoint retention must be positive")
		}
	}
	if strings.TrimSpace(endpoint.Address) == "" {
		return errors.New("endpoint address must be set")
	}
	if strings.TrimSpace(endpoint.Name) == "" {
		return errors.New("endpoint name must be set")
	}
	return nil
}