utils

README

Configuration Utilities

This module allows users to create a Config struct from a YAML file. This functionality is separate from the main module as it relies on Viper, a large dependency that users may not wish to install.

Usage

// Create a custom HTTP client.
client := http.DefaultClient

// Search for a YAML file named config.yml in "." and "./configs" and use it to create a
// Config struct with the provided HTTP client.
config, err := NewConfig("config.yml", WithFilepath("./configs"), WithClient(client))
if err != nil {
    // Handle error
}

// Use newly created Config struct!

Functionality

Users should use this module if they wish to use YAML files to configure the exporter. The module provides the following functions:

1. func NewConfig(filename string, opts ...Option) (*cortex.Config, error)

NewConfig is the primary function of this module. It create and returns a new cortex.Config struct. By default, it searches for a YAML file (.yaml or .yml) in the directory the function was called from. However, users can also provide multiple Options to add new filepaths to search for the YAML file in, a custom HTTP client, or an alternate filesystem to use.

1. func WithFilepath(filepath string) Option

WithFilepath adds a new filepath that Viper will search for YAML files in. This can be called multiple times to add different filepaths. The local directory is searched by default.

1. func WithClient(client *http.Client) Option

WithClient sets the a custom HTTP client inside the Config struct. This is useful if the provided configuration options are insufficient or if the user wants to customize other HTTP client settings. For example, the client can be used to set up custom authentication.

1. func WithFilesystem(fs afero.Fs) Option

WithFilesystem allows users to specify which filesystem Viper should search for the YAML file in. This Option is used in the config_utils_test.go to search an in-memory filesystem for created test files.

Supported YAML Properties

The YAML file can contain the following properties. This is sourced from the Prometheus Remote Write Configuration documentation.

# The URL of the endpoint to send samples to.
url: <string>

# Timeout for requests to the remote write endpoint.
[ remote_timeout: <duration> | default = 30s ]

# Name of the remote write config, which if specified must be unique among remote write configs. The name will be used in metrics and logging in place of a generated value to help users distinguish between remote write configs.
[ name: <string>]

# Sets the `Authorization` header on every remote write request with the
# configured username and password.
# password and password_file are mutually exclusive.
basic_auth:
  [ username: <string>]
  [ password: <string>]
  [ password_file: <string> ]

# Sets the `Authorization` header on every remote write request with
# the configured bearer token. It is mutually exclusive with `bearer_token_file`.
[ bearer_token: <string> ]

# Sets the `Authorization` header on every remote write request with the bearer token
# read from the configured file. It is mutually exclusive with `bearer_token`.
[ bearer_token_file: /path/to/bearer/token/file ]

# Configures the remote write request's TLS settings.
tls_config:
  # CA certificate to validate API server certificate with.
  [ ca_file: <filename>]

  # Certificate and key files for client cert authentication to the   server.
  [ cert_file: <filename> ]
  [ key_file: <filename> ]

  # ServerName extension to indicate the name of the server.
  # https://tools.ietf.org/html/rfc4366#section-3.1
  [ server_name: <string> ]

  # Disable validation of the server certificate.
  [ insecure_skip_verify: <boolean> ]

# Optional proxy URL.
[ proxy_url: <string>]

# Quantiles for Distribution aggregations
[ quantiles: ]
  - <string>
  - <string>
  - ...

# Histogram Buckets
[ histogram_buckets: ]
  - <string>
  - <string>
  - ...

Documentation

Overview

Package utils provides utilities for the Cortex exporter.

Deprecated: This package is no longer supported.

Index

• func NewConfig(filename string, opts ...Option) (*cortex.Config, error)
• func SemVersion() string
• func Version() string
• type Option
  • func WithClient(client *http.Client) Option
  • func WithFilepath(filepath string) Option
  • func WithFilesystem(fs afero.Fs) Option

Functions

func NewConfig

func NewConfig(filename string, opts ...Option) (*cortex.Config, error)

NewConfig creates a Config struct with a YAML file and applies Option functions to the Config struct.

func SemVersion

func SemVersion() string

SemVersion is the semantic version to be supplied to tracer/meter creation.

func Version

func Version() string

Version is the current release version of the Cortex utils module.

Types

type Option

type Option interface {
	Apply(*cortex.Config)
}

Option sets an option for a Config struct.

func WithClient

func WithClient(client *http.Client) Option

WithClient adds a custom http.Client to the Config struct.

func WithFilepath

func WithFilepath(filepath string) Option

WithFilepath adds a path where Viper will search for the YAML file in.

func WithFilesystem

func WithFilesystem(fs afero.Fs) Option

WithFilesystem tells Viper which file system to search for the YAML file in. By default, Viper will search the OS file system, but users can pass in an in-memory filesystem for testing.