gusgh13900/api-discovery-agent repository overview

⁠API Discovery for NGINX — Agent

The log collector for API Discovery for NGINX. It runs on your NGINX host, tails the access log (and optionally the NGINX Plus REST API), and ships records to the dashboard.

• Source: open source under Apache-2.0 — github.com/VEEP09/api-discovery-for-nginx⁠
• Architecture: linux/amd64 (no ARM build)
• Configuration: entirely through environment variables. Secrets are never baked into the image.
• Footprint: distroless, no shell, single Python dependency. It reads your logs read-only and sends them onward — nothing else.

⁠Quick start

Start the dashboard⁠ first, then run this on your NGINX host:

docker run -d --name api-discovery-agent \
  --network host \
  -e DASHBOARD_URL=http://<dashboard-host>:8080 \
  -e INGEST_TOKEN=<same token as the dashboard> \
  -e LOG_PATH=/var/log/nginx/api_access.log \
  -e CURSOR_FILE=/agent/state/agent_cursor.json \
  -e NGINX_PLUS_API=http://127.0.0.1:411/api/9 \
  -v /var/log/nginx:/var/log/nginx:ro \
  -v $PWD/state:/agent/state \
  gusgh13900/api-discovery-agent:1.2.1

Drop --network host if the dashboard is remote and you are not collecting NGINX Plus metrics.

⁠Environment variables

• Volumes: /var/log/nginx (read-only), /agent/state (cursor persistence)
• Log format: JSON, one object per line. The log_format block to copy is on the dashboard image page⁠.

⁠docker-compose

curl -O https://raw.githubusercontent.com/VEEP09/api-discovery-for-nginx/main/docker-compose.agent.yml
DASHBOARD_URL=http://<dashboard-host>:8080 INGEST_TOKEN=<token> \
  docker compose -f docker-compose.agent.yml up -d

Run this on your NGINX host, not on the dashboard host.

⁠Versions

Pin a version tag in production rather than using latest, and keep the dashboard and agent on the same tag. Sizes above are compressed download sizes.

⁠Links

• 📖 Project page and documentation⁠
• 📝 Release notes⁠
• 📮 Bug reports, feature requests, enquiries: [email protected]⁠

⁠한국어

⁠API Discovery for NGINX — 에이전트

API Discovery for NGINX 의 로그 수집 에이전트입니다. NGINX 서버에서 실행되며 액세스 로그(및 선택적으로 NGINX Plus REST API 지표)를 읽어 대시보드로 전송합니다.

• 소스: Apache-2.0 오픈소스 — github.com/VEEP09/api-discovery-for-nginx⁠
• 아키텍처: linux/amd64 (ARM 미지원)
• 설정: 전부 환경변수로 주입합니다. 비밀값은 이미지에 포함되지 않습니다.
• 구성: distroless 이미지로 셸이 없고 Python 의존성은 하나뿐입니다. 로그를 읽기 전용으로 읽어 전송하는 것 외에는 아무것도 하지 않습니다.

⁠빠른 시작

먼저 대시보드⁠를 띄운 뒤, NGINX 서버에서 실행합니다.

docker run -d --name api-discovery-agent \
  --network host \
  -e DASHBOARD_URL=http://<대시보드-서버>:8080 \
  -e INGEST_TOKEN=<대시보드와 동일한 토큰> \
  -e LOG_PATH=/var/log/nginx/api_access.log \
  -e CURSOR_FILE=/agent/state/agent_cursor.json \
  -e NGINX_PLUS_API=http://127.0.0.1:411/api/9 \
  -v /var/log/nginx:/var/log/nginx:ro \
  -v $PWD/state:/agent/state \
  gusgh13900/api-discovery-agent:1.2.1

대시보드가 원격이고 NGINX Plus 메트릭을 수집하지 않는다면 --network host 는 빼도 됩니다.

⁠환경변수

• 볼륨: /var/log/nginx(읽기 전용), /agent/state(커서 영속화)
• 로그 포맷: JSON, 한 줄에 객체 하나. 복사할 log_format 블록은 대시보드 이미지 페이지⁠에 있습니다.

⁠docker-compose

curl -O https://raw.githubusercontent.com/VEEP09/api-discovery-for-nginx/main/docker-compose.agent.yml
DASHBOARD_URL=http://<대시보드-서버>:8080 INGEST_TOKEN=<토큰> \
  docker compose -f docker-compose.agent.yml up -d

대시보드 서버가 아니라 NGINX 서버에서 실행하세요.

⁠버전

프로덕션에서는 latest 대신 고정 버전 태그를 쓰고, 대시보드와 에이전트를 같은 태그로 맞추세요. 위 크기는 압축된 다운로드 기준입니다.

⁠링크

• 📖 프로젝트 페이지 · 문서⁠
• 📝 릴리스 노트⁠
• 📮 버그 제보 · 기능 제안 · 도입 문의: [email protected]⁠

_{NGINX® is a registered trademark of F5, Inc. This project is an independent tool and is not affiliated with, endorsed by, or sponsored by F5 or NGINX. "NGINX" is used here only to describe compatibility.}