diagnose

README

package diagnose

This package is used to register and run agent diagnostics which validates various aspects of agent installation, configuration and run-time environment.

Running agent diagnose all

Details and command line options are specified in agent diagnose command You can run all registered diagnosis with the diagnose command on the agent

The flare command will also run registered diagnosis and output them in a diagnose.log file.

Registering a new diagnose suite

All function and structures details can be found in loader.go file.

To register a diagnose suite one need to register a function which returns []diagnosis.Diagnosis.

Example from loader.go file:

package connectivity

import (
    ...
	"github.com/DataDog/datadog-agent/pkg/diagnose/diagnosis"
    ...
)
...
func init() {
	diagnosis.Register("connectivity-datadog-core-endpoints", diagnose)
}
...
func diagnose(diagCfg diagnosis.Config) []diagnosis.Diagnosis {
    ...
    var diagnoses []diagnosis.Diagnosis
    ...
	for _, domainResolver := range domainResolvers {
        ...
		for _, apiKey := range domainResolver.GetAPIKeys() {
			for _, endpointInfo := range endpointsInfo {
                ...
				name := "Connectivity to " + logURL
				if reportErr == nil {
					diagnoses = append(diagnoses, diagnosis.Diagnosis{
						Result:    diagnosis.DiagnosisSuccess,
						Name:      name,
						Diagnosis: fmt.Sprintf("Connectivity to `%s` is Ok\n%s", logURL, report),
					})
				} else {
					diagnoses = append(diagnoses, diagnosis.Diagnosis{
						Result:      diagnosis.DiagnosisFail,
						Name:        name,
						Diagnosis:   fmt.Sprintf("Connection to `%s` failed\n%s", logURL, report),
						Remediation: "Please validate Agent configuration and firewall to access " + logURL,
						RawError:    err,
					})
				}
			}
		}
	}

	return diagnoses
}

Context of a diagnose function execution

Normally, registered diagnose suite functions will be executed in context of the running agent service (or other services) but if Config.ForceLocal configuration is specified the registered diagnose function will be executed in the context of agent diagnose CLI command (if possible).

Documentation

Index

• func ListStdOut(w io.Writer, diagCfg diagnosis.Config, deps SuitesDeps)
• func Run(diagCfg diagnosis.Config, deps SuitesDeps) ([]diagnosis.Diagnoses, error)
• func RunStdOut(w io.Writer, diagCfg diagnosis.Config, deps SuitesDeps) error
• type SuitesDeps
  • func NewSuitesDeps(senderManager sender.DiagnoseSenderManager, ...) SuitesDeps
  • func (s *SuitesDeps) GetWMeta() optional.Option[workloadmeta.Component]

Functions

func ListStdOut

func ListStdOut(w io.Writer, diagCfg diagnosis.Config, deps SuitesDeps)

Enumerate registered Diagnose suites and get their diagnoses for human consumption

func Run

func Run(diagCfg diagnosis.Config, deps SuitesDeps) ([]diagnosis.Diagnoses, error)

Run runs diagnoses.

func RunStdOut

func RunStdOut(w io.Writer, diagCfg diagnosis.Config, deps SuitesDeps) error

Enumerate registered Diagnose suites and get their diagnoses for human consumption

Types

type SuitesDeps

type SuitesDeps struct {
	AC optional.Option[autodiscovery.Component]
	// contains filtered or unexported fields
}

SuitesDeps stores the dependencies for the diagnose suites.

func NewSuitesDeps

func NewSuitesDeps(
	senderManager sender.DiagnoseSenderManager,
	collector optional.Option[collector.Component],
	secretResolver secrets.Component,
	wmeta optional.Option[workloadmeta.Component], ac optional.Option[autodiscovery.Component]) SuitesDeps

NewSuitesDeps returns a new SuitesDeps.

func (*SuitesDeps) GetWMeta

func (s *SuitesDeps) GetWMeta() optional.Option[workloadmeta.Component]

GetWMeta returns the workload metadata instance