datadog-agent

module
Version: v0.0.0-...-bcc1cc2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 19, 2022 License: Apache-2.0

README

Datadog Agent

CircleCI Windows unit tests Coverage status GoDoc Go Report Card

The present repository contains the source code of the Datadog Agent version 7 and version 6. Please refer to the Agent user documentation for information about differences between Agent v5, Agent v6 and Agent v7. Additionally, we provide a list of prepackaged binaries for an easy install process here

Note: the source code of Datadog Agent v5 is located in the dd-agent repository.

Documentation

The general documentation of the project, including instructions for installation and development, is located under the docs directory of the present repo.

Getting started

To build the Agent you need:

  • Go 1.17 or later. You'll also need to set your $GOPATH and have $GOPATH/bin in your path.
  • Python 3.7+ along with development libraries for tooling. You will also need Python 2.7 if you are building the Agent with Python 2 support.
  • Python dependencies. You may install these with pip install -r requirements.txt This will also pull in Invoke if not yet installed.
  • CMake version 3.12 or later and a C++ compiler

Note: you may want to use a python virtual environment to avoid polluting your system-wide python environment with the agent build/dev dependencies. You can create a virtual environment using virtualenv and then use the invoke agent.build parameters --python-home-2=<venv_path> and/or --python-home-3=<venv_path> (depending on the python versions you are using) to use the virtual environment's interpreter and libraries. By default, this environment is only used for dev dependencies listed in requirements.txt.

Note: You may have previously installed invoke via brew on MacOS, or pip in any other platform. We recommend you use the version pinned in the requirements file for a smooth development/build experience.

Builds and tests are orchestrated with invoke, type invoke --list on a shell to see the available tasks.

To start working on the Agent, you can build the main branch:

  1. Checkout the repo: git clone https://github.com/DataDog/datadog-agent.git $GOPATH/src/github.com/DataDog/datadog-agent.

  2. cd into the project folder: cd $GOPATH/src/github.com/DataDog/datadog-agent.

  3. Install go tools: invoke install-tools.

  4. Create a development datadog.yaml configuration file in dev/dist/datadog.yaml, containing a valid API key: api_key: <API_KEY>

  5. Build the agent with invoke agent.build --build-exclude=systemd.

    By default, the Agent will be built to use Python 3 but you can select which Python version you want to use:

    • invoke agent.build --python-runtimes 2 for Python2 only
    • invoke agent.build --python-runtimes 3 for Python3 only
    • invoke agent.build --python-runtimes 2,3 for both Python2 and Python3

    You can specify a custom Python location for the agent (useful when using virtualenvs):

    invoke agent.build \
      --python-runtimes 2,3 \
      --python-home-2=$GOPATH/src/github.com/DataDog/datadog-agent/venv2 \
      --python-home-3=$GOPATH/src/github.com/DataDog/datadog-agent/venv3 .
    

    Running invoke agent.build:

    • Discards any changes done in bin/agent/dist.
    • Builds the Agent and writes the binary to bin/agent/agent.
    • Copies files from dev/dist to bin/agent/dist. See https://github.com/DataDog/datadog-agent/blob/main/dev/dist/README.md for more information.

    If you built an older version of the agent, you may have the error make: *** No targets specified and no makefile found. Stop.. To solve the issue, you should remove CMakeCache.txt from rtloader folder with rm rtloader/CMakeCache.txt.

Please refer to the Agent Developer Guide for more details. For instructions on setting up a windows dev environment, refer to Windows Dev Env.

Testing

Run tests using invoke test. During development, add the --skip-linters option to skip straight to the tests.

invoke test --targets=./pkg/aggregator/... --skip-linters

When testing code that depends on rtloader, build and install it first.

invoke rtloader.make && invoke rtloader.install
invoke test --targets=./pkg/collector/python --skip-linters

Run

You can run the agent with:

./bin/agent/agent run -c bin/agent/dist/datadog.yaml

The file bin/agent/dist/datadog.yaml is copied from dev/dist/datadog.yaml by invoke agent.build and must contain a valid api key.

Contributing code

You'll find information and help on how to contribute code to this project under the docs/dev directory of the present repo.

License

The Datadog agent user space components are licensed under the Apache License, Version 2.0. The BPF code is licensed under the General Public License, Version 2.0.

Directories

Path Synopsis
cmd
agent
The Datadog Agent faithfully collects events and metrics and brings them to Datadog on your behalf.
The Datadog Agent faithfully collects events and metrics and brings them to Datadog on your behalf.
agent/api
Package api implements the agent IPC api.
Package api implements the agent IPC api.
agent/app
Package app implements the Agent main loop, orchestrating all the components and providing the command line interface.
Package app implements the Agent main loop, orchestrating all the components and providing the command line interface.
agent/app/standalone
Package standalone provides utility functions for Agent CLI commands that set up a new in-process Agent runtime (ex: check, jmx commands), as opposed to CLI commands that query a running Agent's IPC API.
Package standalone provides utility functions for Agent CLI commands that set up a new in-process Agent runtime (ex: check, jmx commands), as opposed to CLI commands that query a running Agent's IPC API.
agent/common
Package common provides a set of common symbols needed by different packages, to avoid circular dependencies.
Package common provides a set of common symbols needed by different packages, to avoid circular dependencies.
cluster-agent/api
Package api implements the agent IPC api.
Package api implements the agent IPC api.
cluster-agent/api/agent
Package agent implements the api endpoints for the `/agent` prefix.
Package agent implements the api endpoints for the `/agent` prefix.
security-agent/api
Package api implements the agent IPC api.
Package api implements the agent IPC api.
security-agent/api/agent
Package agent implements the api endpoints for the `/agent` prefix.
Package agent implements the api endpoints for the `/agent` prefix.
trace-agent/test
Package test provides utilities for running integration tests on the trace agent.
Package test provides utilities for running integration tests on the trace agent.
pkg
collector/check/defaults
Package defaults provides common defaults used in agent checks
Package defaults provides common defaults used in agent checks
collector/corechecks/cluster
Package cluster provides core checks for cluster level checks, used by the Datadog Cluster Agent.
Package cluster provides core checks for cluster level checks, used by the Datadog Cluster Agent.
collector/corechecks/containers
Package containers provides core checks for containers and orchestrators
Package containers provides core checks for containers and orchestrators
collector/corechecks/net
Package net provides core checks for networking
Package net provides core checks for networking
collector/corechecks/nvidia/jetson
Package nvidia provides core checks for Nvidia's jetson device family
Package nvidia provides core checks for Nvidia's jetson device family
collector/corechecks/system
Package system provides core checks for OS-level system metrics
Package system provides core checks for OS-level system metrics
collector/corechecks/systemd
Package systemd provides core checks for systemd
Package systemd provides core checks for systemd
collector/metadata
Package metadata implements specific Metadata Collectors for the Agent.
Package metadata implements specific Metadata Collectors for the Agent.
compliance
Package compliance defines common interfaces and types for Compliance Agent
Package compliance defines common interfaces and types for Compliance Agent
compliance/agent
Package agent implements the Compliance Agent entrypoint
Package agent implements the Compliance Agent entrypoint
compliance/checks
Package checks implements Compliance Agent checks
Package checks implements Compliance Agent checks
config/resolver
Package resolver contains logic to perform per `transaction.Endpoint` domain resolution.
Package resolver contains logic to perform per `transaction.Endpoint` domain resolution.
diagnose/connectivity
Package connectivity contains logic for connectivity troubleshooting between the Agent and Datadog endpoints.
Package connectivity contains logic for connectivity troubleshooting between the Agent and Datadog endpoints.
forwarder/endpoints
Package endpoints stores a collection of `transaction.Endpoint` mainly used by the forwarder package to send data to Datadog using the right request path for a given type of data.
Package endpoints stores a collection of `transaction.Endpoint` mainly used by the forwarder package to send data to Datadog using the right request path for a given type of data.
metadata/externalhost
Package externalhost implements the External Host Tags metadata provider.
Package externalhost implements the External Host Tags metadata provider.
proto/pbgo
Package pbgo is a reverse proxy.
Package pbgo is a reverse proxy.
proto/pbgo/mocks
Package mock_pbgo is a generated GoMock package.
Package mock_pbgo is a generated GoMock package.
security/probe
Code generated - DO NOT EDIT.
Code generated - DO NOT EDIT.
tagset
Package tagset supports creation and manipulation of sets of tags.
Package tagset supports creation and manipulation of sets of tags.
util/atomicstats
Package atomicstats provides support for "stats" structs containing atomic values.
Package atomicstats provides support for "stats" structs containing atomic values.
util/cachedfetch
Package cachedfetch provides a read-through cache for fetched values.
Package cachedfetch provides a read-through cache for fetched values.
util/containers/providers/windows
Package windows We need a file in this package as it's referenced by a file built on windows
Package windows We need a file in this package as it's referenced by a file built on windows
util/ecs
Package ecs provides metadata collection when the Agent runs on the ECS platform
Package ecs provides metadata collection when the Agent runs on the ECS platform
util/ecs/metadata
Package metadata provides clients for Metadata APIs exposed by the ECS agent.
Package metadata provides clients for Metadata APIs exposed by the ECS agent.
util/executable
Package executable provides information on the executable that started the process and utils to find other executables on the system
Package executable provides information on the executable that started the process and utils to find other executables on the system
util/hostname/validate
Package validate provides hostname validation helpers
Package validate provides hostname validation helpers
util/intern
Package intern lets you make smaller comparable values by boxing a larger comparable value (such as a 16 byte string header) down into a globally unique 8 byte pointer.
Package intern lets you make smaller comparable values by boxing a larger comparable value (such as a 16 byte string header) down into a globally unique 8 byte pointer.
util/log
Package log implements logging for the datadog agent.
Package log implements logging for the datadog agent.
util/scrubber
Package scrubber implements support for cleaning sensitive information out of strings and files.
Package scrubber implements support for cleaning sensitive information out of strings and files.
util/startstop
Package startstop provides useful functionality for starting and stopping agent components.
Package startstop provides useful functionality for starting and stopping agent components.
workloadmeta/collectors
Package collectors is a wrapper that loads the available workloadmeta collectors.
Package collectors is a wrapper that loads the available workloadmeta collectors.
obfuscate Module
otlp/model Module
quantile Module
security/secl Module
trace Module
trace/export Module
trace/pb Module
rtloader
test
tools
internal

Jump to

Keyboard shortcuts

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