StackState Process Agent

Requirements

• go >= 1.10.1
• rake

Build the process agent

If you want to use a custom version of datadog-agent-upstream-for-process-agent use the following script before invoking the build command.

./update-datadog-dependency.sh -l <path-to-local-datadog-repo>
./update-datadog-dependency.sh -b <branch-name>

# to have a clean build
sudo rm -rf ./prebuild_artifacts
sudo rm -rf ./ebpf-object-files
rake local_build
# The dockerfile and the config `conf-dev.yaml` expect the .o files under a specific folder. This command just moves these files.
./prebuild-datadog-agent.sh --install-ebpf
# DataDog checks that ebpf .o files are owned by root,
sudo chown root:root -R ./ebpf-object-files/x86_64

Run linters locally

rake lint

Run the agent locally

You can now run the Agent on the command-line:

sudo ./process-agent -config ./conf-dev.yaml

To run without errors the process-agent needs the test-server. Start the test-server before the process-agent.

Run process-agent unit tests

rake test
# or if you want to use the go command directly
go test -tags 'docker kubelet kubeapiserver linux cri containerd linux_bpf' $(go list ./...)
# To run a specific test in verbose mode
go test -v -run TestPostgresAggregation -tags 'docker kubelet kubeapiserver linux cri containerd linux_bpf' $(go list ./...)

Build the docker image

You first need to build the process agent locally as described above. Once you have the binary and the ebpf artifacts locally, you can simply use the dockerfile

docker build --tag <tag> -f Dockerfile .

Regenerating proto files

If you modify any of the .proto files you must rebuild the *.pb.go files.

Make sure protobuf 3.6.1.3 is installed, typically has to be built from source: https://github.com/protocolbuffers/protobuf/tree/v3.6.1.3

Make sure you install the gogo-proto binaries from the go mod directory:

cd $GO_PATH/pkg/github.com/gogo/[email protected]
make install

Make sure $GO_PATH/bin is in the PATH.

and then:

rake protobuf

[NO MORE MANTAINED] Development or Running with Vagrant

There is a Vagrantfile in the root directory, that can be used to create a vagrant vm where the StackState process agent can be run.

$ vagrant up process-agent-test
#...
$ vagrant ssh process-agent-test
$ cd $GOPATH/src/github.com/StackVista/stackstate-process-agent

You can up the memory and pre-install some processes at boot of the Vagrant vm with:

MEM="2048" PROCESSES="java mysql postgresql tomcat" vagrant up process-agent-test