Home

Welcome to the Watchdog wiki. Watchdog monitors OneBusAway servers and their GTFS feeds and exports the results as Prometheus metrics. These pages cover how we work on it and the design decisions behind it.

Contributing

• Watchdog Issue Assignment Guidelines: how to ask for an issue, and how many you can take at a time.
• Watchdog Investigation History: What We're Building and How to Contribute: the investigation history work, how its issues are organised, and where to start.
• Implementing Investigation API Endpoints: Understanding and Using the Shared Foundation: the shared code every Investigation API endpoint is built on, why it exists, and how to use it.

Design records

• ADR 0001: Durable Historical Investigation Storage: why Watchdog keeps investigation history in PostgreSQL instead of Prometheus, what it stores, and the decisions behind it. (Linked from the PR branch until #192 is merged.)

Elsewhere

• README: setup and running Watchdog.
• Metrics guide: every metric Watchdog exports and how to read it.