ooni / ooni/backend

Proposal for a simple canary test

Open
#261 2 comments 1 reaction 1 assignee View on GitHub

@FedericoCeratto is already working on this.

Since May 25, 2020.

devops
Dominant language
Python
Stars
61
Forks
33
Avg merge
3d 2h
Merged PRs (30d)
3

Description

Implement a simple end-to-end tester that runs continuously:

  1. Start probe-cli against fastpath.ooni.nu/_secret_canary
  2. Serve a lorem ipsum text on /_secret_canary. If the client ipaddress is the same as the probe AND the current hour is even, serve a 1-line text to simulate blocking.
  3. Wait for the process probe-cli -> collectors -> fastpath -> event detector -> RSS/Explorer to finish
  4. Scrape the result and check if the canary is flagged as blocked or unblocked
  5. Report the processing time and correctness to Prometheus. Alert on failure.
  6. Repeat every 10 mins.

This should be really simple to implement and yet give us early warnings in case of failures in the "critical path" of most of OONI.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.