extensions

Documentation

Overview

Package extensions holds the type of extensions that consul telemetery supports

Index

• Variables
• func BallastCfg() *ballastextension.Config
• type OauthClientConfig
  • func OauthClientCfg(clientID, clientSecret string) *OauthClientConfig

Variables

var BallastID component.ID = component.NewID(ballastName)

BallastID is the component id of the ballast extension.

var OauthClientID component.ID = component.NewIDWithName(oauth2ClientName, "hcp")

OauthClientID is the component.ID used by the oauth2client extension.

Functions

func BallastCfg

func BallastCfg() *ballastextension.Config

BallastCfg generates the config for a ballast config.

Types

type OauthClientConfig

type OauthClientConfig struct {

	// ClientID is the application's ID.
	ClientID string `mapstructure:"client_id"`

	// ClientSecret is the application's secret.
	ClientSecret string `mapstructure:"client_secret"`

	// EndpointParams specifies additional parameters for requests to the token endpoint.
	EndpointParams url.Values `mapstructure:"endpoint_params"`

	// TokenURL is the resource server's token endpoint
	// URL. This is a constant specific to each server.
	// See https://datatracker.ietf.org/doc/html/rfc6749#section-3.2
	TokenURL string `mapstructure:"token_url"`

	// TLSSetting struct exposes TLS client configuration for the underneath client to authorization server.
	TLSSetting types.TLSClientSetting `mapstructure:"tls,omitempty"`
}

OauthClientConfig is a base wrapper around the oauth2clientauthextension.Config which we cannot use directly since the opaque client secret string gets changed to REDACTED when unmarshalling

https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/oauth2clientauthextension

func OauthClientCfg

func OauthClientCfg(clientID, clientSecret string) *OauthClientConfig

OauthClientCfg returns a component ID and oauth config.