config

Documentation

Overview

Package config provides Auklet client configuration data.

Index

• Constants
• type Getenv
  • func (getenv Getenv) APIKey() string
  • func (getenv Getenv) AppID() string
  • func (getenv Getenv) BaseURL(fromcli string) string
  • func (getenv Getenv) LogErrors() bool
  • func (getenv Getenv) LogInfo() bool

Constants

const Production = "https://api.auklet.io"

Production defines the base URL for the production environment.

Types

type Getenv

type Getenv func(string) string

Getenv is a function to retrieve the values of environment variables.

var OS Getenv = os.Getenv

OS is the Getenv provided by the operating system.

func (Getenv) APIKey

func (getenv Getenv) APIKey() string

APIKey returns the API granted to the customer upon onboarding. It is used in most API calls, such as requesting SSL certs and getting and posting a device.

func (Getenv) AppID

func (getenv Getenv) AppID() string

AppID identifies a customer's application as a whole, but not a particular release of it. It is used in API calls relating to devices and in profile data sent to broker.

func (Getenv) BaseURL

func (getenv Getenv) BaseURL(fromcli string) string

BaseURL returns the base URL, as dependent on the CLI args or env vars.

func (Getenv) LogErrors

func (getenv Getenv) LogErrors() bool

LogErrors returns whether we should log errors.

func (Getenv) LogInfo

func (getenv Getenv) LogInfo() bool

LogInfo returns whether we should log info.