def

Documentation

Overview

Package def implements the internal Agent API component definitions which exposes endpoints such as config, flare or status

Index

• Variables
• type AgentEndpointProvider
  • func NewAgentEndpointProvider(handlerFunc http.HandlerFunc, route string, methods ...string) AgentEndpointProvider
• type AuthorizedSet
• type Component
• type EndpointProvider

Variables

var AuthorizedConfigPathsCore = buildAuthorizedSet(
	"api_key",
	"app_key",
	"site",
	"dd_url",
	"additional_endpoints",

	"external_metrics_provider.api_key",
	"external_metrics_provider.app_key",

	"logs_config.additional_endpoints",
	"apm_config.additional_endpoints",
	"apm_config.profiling_additional_endpoints",
	"database_monitoring.samples.additional_endpoints",
	"database_monitoring.metrics.additional_endpoints",
	"database_monitoring.activity.additional_endpoints",
	"network_devices.metadata.additional_endpoints",
	"network_devices.snmp_traps.forwarder.additional_endpoints",
	"network_devices.netflow.forwarder.additional_endpoints",
	"network_path.forwarder.additional_endpoints",
	"container_lifecycle.additional_endpoints",
	"container_image.additional_endpoints",
	"sbom.additional_endpoints",
	"service_discovery.forwarder.additional_endpoints",
	"runtime_security_config.endpoints.additional_endpoints",
)

AuthorizedConfigPathsCore is the the set of authorized config keys authorized for the config API.

Types

type AgentEndpointProvider

type AgentEndpointProvider struct {
	fx.Out

	Provider EndpointProvider `group:"agent_endpoint"`
}

AgentEndpointProvider is the provider for registering endpoints to the internal agent api server

func NewAgentEndpointProvider

func NewAgentEndpointProvider(handlerFunc http.HandlerFunc, route string, methods ...string) AgentEndpointProvider

NewAgentEndpointProvider returns a AgentEndpointProvider to register the endpoint provided to the internal agent api server

type AuthorizedSet

type AuthorizedSet map[string]struct{}

AuthorizedSet is a type to store the authorized config options for the config API

type Component

type Component interface {
	CMDServerAddress() *net.TCPAddr
	IPCServerAddress() *net.TCPAddr
}

Component is the component type.

type EndpointProvider

type EndpointProvider interface {
	HandlerFunc() http.HandlerFunc

	Methods() []string
	Route() string
}

EndpointProvider is an interface to register api endpoints