README
¶
Datadog Agent
The Datadog Agent faithfully collects events and metrics and brings them to Datadog on your behalf so that you can do something useful with your monitoring and performance data.
The present repository contains the source code of the Datadog Agent version 6, currently in Beta. The source code of the stable Datadog Agent 5 is located in the dd-agent repository.
Getting started
To build the Agent you need:
- Go 1.8.1 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 invoke.
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, either through the config file or passing the environment variable like:
DD_API_KEY=12345678990 ./bin/agent/agent
Documentation
The general documentation of the project (including instructions on the Beta builds, Agent installation, development, etc) is located under the docs directory of the present repo.
Contributing code
You must sign a CLA before we can accept your contributions. If you submit a PR without having signed it, our bot will prompt you to do so. Once signed you will be set for all contributions going forward.
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. |
|
pkg
|
|
|
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. |
|
test
|
|