transport

Documentation

Overview

Package transport provides methods to create an HTTP transport that can communicate with the Chronosphere API.

Index

• Constants
• func New(config RuntimeConfig) (*httptransport.Runtime, error)
• type Component
• type CustomHeaderTransport
  • func (c CustomHeaderTransport) RoundTrip(req *http.Request) (*http.Response, error)
• type RuntimeConfig

Constants

const (

	// OrgNameEnvVar is the name of the environment variable that can be used to set the
	// Chronosphere organization name.
	OrgNameEnvVar = "CHRONOSPHERE_ORG_NAME"
)

Functions

func New

func New(config RuntimeConfig) (*httptransport.Runtime, error)

New creates a new HTTP transport that can communicate with the Chronosphere API.

Types

type Component

type Component string

Component is a value that indicates the part of the CLI that is invoking an API. This is used to set the User-Agent header when making requests to the Chronosphere API.

var (
	// ComponentChronoctl is the value for the stable chronoctl component
	ComponentChronoctl Component = "chrono-ctl"
	// ComponentChronoctlUnstable is the value for the unstable chronoctl component
	ComponentChronoctlUnstable Component = "unstable-chrono-ctl"
)

type CustomHeaderTransport

type CustomHeaderTransport struct {
	Rt http.RoundTripper
	// contains filtered or unexported fields
}

CustomHeaderTransport is a RoundTripper that adds a custom headres to all requests for example: User-Agent, and Chrono-Entity-Namespace

func (CustomHeaderTransport) RoundTrip

func (c CustomHeaderTransport) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip implements the RoundTripper interface.

type RuntimeConfig

type RuntimeConfig struct {
	Component          Component
	OrgName            string
	APIToken           string
	APIUrl             string
	InsecureSkipVerify bool
	AllowHTTP          bool
	DefaultBasePath    string
	EntityNamespace    string
}

RuntimeConfig is a struct that contains the configuration for creating a new HTTP transport