apache/skywalking-banyandb-fodc-agent repository overview

⁠Apache SkyWalking BanyanDB FODC Agent image

Docker images are not official ASF releases but provided for convenience. Recommended usage is always to build the source.

SkyWalking is an APM(application performance monitor) system, especially designed for microservices, cloud native and container-based (Docker, Kubernetes, Mesos) architectures.

FODC Agent is the per-node data collector for FODC (First Occurrence Data Collection). It is designed to run alongside a BanyanDB node, scrape local metrics, expose a Prometheus endpoint, and stream node information to the FODC proxy.

This image runs the FODC agent only. It does not start BanyanDB or the FODC proxy by itself.

You can find the source code and Dockerfile here⁠

⁠How to use this image

The container entrypoint is the fodc-agent binary, so runtime configuration is passed with command-line flags.

Run the agent beside a BanyanDB node

This is the typical sidecar-style usage. By default, the agent scrapes BanyanDB metrics from port 2121 and exposes its own Prometheus endpoint on port 9090.

docker run --rm \
  --network host \
  apache/skywalking-banyandb-fodc-agent:latest \
  --prometheus-listen-addr=:9090 \
  --poll-metrics-ports=2121

⁠Connect the agent to an FODC proxy

To register with a proxy, provide the proxy gRPC address and pod identity. For full node registration, also enable cluster state polling.

docker run --rm \
  --network host \
  apache/skywalking-banyandb-fodc-agent:latest \
  --prometheus-listen-addr=:9090 \
  --poll-metrics-ports=2121 \
  --proxy-addr=127.0.0.1:17912 \
  --pod-name=banyandb-datanode-0 \
  --cluster-state-ports=17912

If you run the agent in a container network instead of host networking, adjust the target addresses and ports so the agent can still reach the local BanyanDB metrics endpoint and the FODC proxy.

⁠Common flags

• --poll-metrics-interval: Interval for scraping local BanyanDB metrics. Default: 10s.
• --poll-metrics-ports: BanyanDB metrics ports to scrape. Default: 2121.
• --max-metrics-memory-usage-percentage: Maximum cgroup memory percentage used by the in-memory metric cache. Default: 10.
• --prometheus-listen-addr: Address for the agent's Prometheus endpoint. Default: :9090.
• --proxy-addr: FODC proxy gRPC address. Default: localhost:17900.
• --pod-name: Pod name used as part of agent identity.
• --container-names: Container names mapped one-to-one with --poll-metrics-ports.
• --heartbeat-interval: Heartbeat interval to the proxy. Default: 10s.
• --reconnect-interval: Reconnect backoff to the proxy. Default: 5s.
• --cluster-state-ports: BanyanDB gRPC ports used for cluster state polling.
• --cluster-state-poll-interval: Interval for polling cluster state. Default: 30s.
• --ktm-enabled: Enable KTM eBPF-based kernel telemetry on Linux.
• --ktm-interval: KTM collection interval. Default: 10s.

⁠Ports

• 9090: Prometheus metrics exposed by the FODC agent.
• 2121: Typical BanyanDB local metrics port scraped by the agent.

⁠Learn more

• FODC overview: https://github.com/apache/skywalking-banyandb/blob/main/docs/operation/fodc/overview.md⁠
• FODC APIs and CLI flags: https://github.com/apache/skywalking-banyandb/blob/main/docs/operation/fodc/apis.md⁠
• Project homepage: https://skywalking.apache.org/⁠