apache/skywalking-banyandb-fodc-proxy repository overview

⁠Apache SkyWalking BanyanDB FODC Proxy 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 Proxy is the central control plane and data aggregator for FODC (First Occurrence Data Collection). It accepts gRPC connections from FODC agents, aggregates their observability data, and exposes HTTP APIs and Prometheus-friendly endpoints for diagnostics and integration.

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

You can find the source code and Dockerfile (here)[https://github.com/apache/skywalking-banyandb/tree/main/fodc/proxy/Dockerfile⁠]

⁠How to use this image

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

⁠Run the proxy with default ports

By default, the proxy listens on gRPC port 17912 for agent connections and HTTP port 17913 for APIs and metrics.

docker run --rm -p 17912:17912 -p 17913:17913 \
  apache/skywalking-banyandb-fodc-proxy:latest

⁠Run the proxy with explicit listen addresses

docker run --rm -p 17912:17912 -p 17913:17913 \
  apache/skywalking-banyandb-fodc-proxy:latest \
  --grpc-listen-addr=:17912 \
  --http-listen-addr=:17913

Agents should connect to the proxy gRPC address on port 17912.

⁠Common flags

• --grpc-listen-addr: gRPC listen address for agent connections. Default: :17912.
• --http-listen-addr: HTTP listen address for REST and Prometheus endpoints. Default: :17913.
• --agent-heartbeat-timeout: Mark agents offline after this duration without heartbeats. Default: 30s.
• --agent-cleanup-timeout: Unregister agents after they remain offline beyond this duration. Default: 5m.
• --max-agents: Maximum number of registered agents. Default: 1000.
• --grpc-max-msg-size: Maximum gRPC message size in bytes. Default: 4194304.
• --http-read-timeout: HTTP server read timeout. Default: 10s.
• --http-write-timeout: HTTP server write timeout. Default: 10s.
• --heartbeat-interval: Default heartbeat interval communicated to agents. Default: 10s.

⁠Ports

• 17912: gRPC endpoint for FODC agent registration and streaming.
• 17913: HTTP endpoints for aggregated metrics and cluster APIs.

⁠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/⁠