No Description

Nikolay Sivko 58f0336ded Merge pull request #78 from coroot/tracefs 2 years ago
.github 05c838332c GH actions: upload agent binaries to GH releases 2 years ago
cgroup c7c218978b goimports: imports reformatting 2 years ago
common 0175d1c2be fix PVC detection on microk8s 2 years ago
containers 011a57420f retry app type detection during container initialization 2 years ago
ebpftracer 4e9a6fc2f0 require either `debugfs` or `tracefs` to be mounted 2 years ago
flags 1b6a8fd8ff Listen on `localhost` when operating in push mode 2 years ago
logs f2b9d57659 metrics push mode using the Prometheus Remote Write API 2 years ago
manifests 92ef04b486 squashing commits before publishing 4 years ago
node c7c218978b goimports: imports reformatting 2 years ago
pinger c7c218978b goimports: imports reformatting 2 years ago
proc 48e3d5f44e continuous integration 2 years ago
profiling 44f6e37e99 profiling: set `SampleType` name 2 years ago
prom dff2224ce1 metrics: set `info` log level 2 years ago
tracing 341cef08b8 tracing: retrieve `ServiceName` from `ContainerId` 2 years ago
.dockerignore 12d24bf447 capturing Postgres queries at the eBPF level 3 years ago
.gitignore 92ef04b486 squashing commits before publishing 4 years ago
CONTRIBUTING.md 1099fdd351 contributing guide 2 years ago
Dockerfile 48e3d5f44e continuous integration 2 years ago
LICENSE 92ef04b486 squashing commits before publishing 4 years ago
Makefile 1099fdd351 contributing guide 2 years ago
README.md 1099fdd351 contributing guide 2 years ago
go.mod f5b57ed444 logparser v1.1.2 2 years ago
go.sum f5b57ed444 logparser v1.1.2 2 years ago
install.sh f55e13dca3 Add script to install agent as a Systemd service 2 years ago
main.go f2b9d57659 metrics push mode using the Prometheus Remote Write API 2 years ago

README.md

Coroot-node-agent

Go Report Card License

The agent gathers metrics related to a node and the containers running on it, and it exposes them in the Prometheus format.

It uses eBPF to track container related events such as TCP connects, so the minimum supported Linux kernel version is 4.16.

Features

TCP connection tracing

To provide visibility into the relationships between services, the agent traces containers TCP events, such as connect() and listen().

Exported metrics are useful for:

  • Obtaining an actual map of inter-service communications. It doesn't require integration of distributed tracing frameworks into your code.
  • Detecting connections errors from one service to another.
  • Measuring network latency between containers, nodes and availability zones.

Related blog posts:

Log management is usually quite expensive. In most cases, you do not need to analyze each event individually. It is enough to extract recurring patterns and the number of the related events.

This approach drastically reduces the amount of data required for express log analysis.

The agent discovers container logs and parses them right on the node.

At the moment the following sources are supported:

  • Direct logging to files in /var/log/
  • Journald
  • Dockerd (JSON file driver)
  • Containerd (CRI logs)

To learn more about automated log clustering, check out the blog post "Mining metrics from unstructured logs".

Delay accounting

Delay accounting allows engineers to accurately identify situations where a container is experiencing a lack of CPU time or waiting for I/O.

The agent gathers per-process counters through Netlink and aggregates them into per-container metrics:

Related blog posts:

Out-of-memory events tracing

The container_oom_kills_total metric shows that a container has been terminated by the OOM killer.

Instance meta information

If a node is a cloud instance, the agent identifies a cloud provider and collects additional information using the related metadata services.

Supported cloud providers: AWS, GCP, Azure, Hetzner

Collected info:

  • AccountID
  • InstanceID
  • Instance/machine type
  • Region
  • AvailabilityZone
  • AvailabilityZoneId (AWS only)
  • LifeCycle: on-demand/spot (AWS and GCP only)
  • Private & Public IP addresses

Related blog posts:

Installation

The documentation is available at coroot.com/docs/metric-exporters/node-agent.

Metrics

The collected metrics are described here.

Coroot

The best way to turn metrics to answers about app issues is to use Coroot - a zero-instrumentation observability tool for microservice architectures.

A live demo of Coroot is available at community-demo.coroot.com

Contributing

To start contributing, check out our Contributing Guide.

License

Coroot-node-agent is licensed under the Apache License, Version 2.0.

The BPF code is licensed under the General Public License, Version 2.0.