Development site, not the published docs. This build is 0.8.0-dev.

Server

Monitoring.

Farwing publishes counts and totals for a monitoring system. It does not publish file names, email addresses or paths.

The server feed

GET /metrics returns Prometheus text. Call it with an API key in the Authorization header. Any scope is enough, so the key you give the scraper does not need to be able to change files. A portal session is refused: a scrape comes from a machine, not from a signed-in browser.

Make the key under Profile → API keys. The API reference shows how to send it. Point the scraper at:

https://files.example.com/metrics

Useful series include:

  • farwing_data_service_up is 1 when the transfer port is open. When it is 0, session counts are left out rather than reported as zero.
  • farwing_data_sessions counts transfers in flight and tickets issued but not yet used.
  • farwing_transfers counts transfer records by state.
  • farwing_job_runner_up is 1 when the automation runner is up.
  • farwing_build_info carries the version that is running.

The same reply includes license state, user and key counts, storage locations, packages, hot folders, sync jobs and audit forwarding. Read the HELP line on each series for what it counts.

Traffic usage

Admin → Transfers → Usage is the charts, the CSV export and scheduled email reports. That page can also mint a read-only token for a second Prometheus feed, GET /api/v1/usage/metrics, which is the traffic series. It is separate from /metrics and is not included in Free mode. Per-minute usage is kept 30 days. Per-hour rows are kept, and Free mode shows the last 30 days of them.

Farwing docs · farwing.io