README
¶
Datadog Agent
The present repository contains the source code of the Datadog Agent version 6. Please refer to the changes document for information about differences between Agent 5 and Agent 6. Additionally, we provide a list of prepackaged binaries for an easy install process here
Note: the source code of Datadog Agent 5 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.9.4 or later.
- Python 2.7 along with development libraries.
- Invoke, you can install it via
pip install invokeor via Homebrew on OSX/macOS withbrew install pyinvoke.
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 master branch:
- checkout the repo:
git clone https://github.com/DataDog/datadog-agent.git $GOPATH/src/github.com/DataDog/datadog-agent. - cd into the project folder:
cd $GOPATH/src/github.com/DataDog/datadog-agent. - install project's dependencies:
invoke deps. Make sure that$GOPATH/binis in your$PATHotherwise this step might fail. - build the whole project with
invoke agent.build --build-exclude=snmp
Please refer to the Agent Developer Guide for more details.
Run
To start the agent type agent start from the bin/agent folder, it will take
care of adjusting paths and run the binary in foreground.
You need to provide a valid API key. You can either use the config file or overwrite it with the environment variable like:
DD_API_KEY=12345678990 ./bin/agent/agent -c bin/agent/dist/datadog.yaml
Contributing code
You must sign a CLA before we can accept your contributions. The first time you submit a PR, a bot will walk you through the automated process. On subsequent contributions you will not be prompted unless the content of the agreement has changed. We sincerely appreciate your contribution and have worked hard to ensure the CLA wording is simple, clear, and concise. It does not require you to give up ownership of your contributions, or prevent you from using your contributions for other purposes. We've put the agreement in place to explicitly clarify your intellectual property license grant, for your protection as well as ours.
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/api/agent
Package agent implements the api endpoints for the `/agent` prefix.
|
Package agent implements the api endpoints for the `/agent` prefix. |
|
agent/api/check
Package check implements the api endpoints for the `/check` prefix.
|
Package check implements the api endpoints for the `/check` prefix. |
|
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/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. |
|
pkg
|
|
|
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/network
Package network provides core checks for networking
|
Package network provides core checks for networking |
|
collector/metadata
Package metadata implements specific Metadata Collectors for the Agent.
|
Package metadata implements specific Metadata Collectors for the Agent. |
|
logs/pb
Package pb is a generated protocol buffer package.
|
Package pb is a generated protocol buffer package. |
|
metadata/ecs
Package ecs provides functionalities to collect ECS metadata
|
Package ecs provides functionalities to collect ECS metadata |
|
metadata/externalhost
Package externalhost implements the External Host Tags metadata provider.
|
Package externalhost implements the External Host Tags metadata provider. |
|
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/executable
Package executable provides information on the executable that started the process
|
Package executable provides information on the executable that started the process |
|
test
|
|