common

package

v1.35.0 Latest Latest Go to latest Published: Oct 4, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/observiq/bindplane-op

Documentation ¶

Overview ¶

Package common contains common functions and types used by BindPlane.

Index ¶

Constants
Variables
func DefaultResource() *resource.Resource
func GetHome() string
func GetProfilesFolder() string
func ValidatePort(port string) error
func ValidateURL(urlString string, validSchemes []string) error

Constants ¶

View Source

const (
	// ProfilesFolderName is the name of the profiles folder.
	ProfilesFolderName = "profiles"

	// DefaultHomeName is the default directory name for bindplane.
	DefaultHomeName = ".bindplane"

	// DefaultProfileName is the name of the default profile
	DefaultProfileName = "default"

	// HomeEnv is the environment variable for the bindplane home path.
	HomeEnv = "BINDPLANE_CONFIG_HOME"
)

Variables ¶

View Source

var (
	// ValidHTTPSchemes are the valid http schemes to be used with ValidateURL function
	ValidHTTPSchemes = []string{"http", "https"}

	// ValidWSSchemes are the valid websocket schemes to be used with ValidateURL function
	ValidWSSchemes = []string{"ws", "wss"}
)

list of valid schemes for different protocols

Functions ¶

func DefaultResource ¶ added in v1.25.0

func DefaultResource() *resource.Resource

DefaultResource returns the default resource for OTLP exporters

func GetHome ¶ added in v1.16.0

func GetHome() string

GetHome returns the bindplane home path.

func GetProfilesFolder ¶ added in v1.16.0

func GetProfilesFolder() string

GetProfilesFolder returns the profiles folder path.

func ValidatePort ¶ added in v1.16.0

func ValidatePort(port string) error

ValidatePort validates the port

func ValidateURL ¶ added in v1.16.0

func ValidateURL(urlString string, validSchemes []string) error

ValidateURL validates the URL and ensures the scheme matches one of the valid schemes in the list

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL