Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: minipipeline to analyze measurements #1393

Merged
merged 62 commits into from
Nov 28, 2023
Merged

feat: minipipeline to analyze measurements #1393

merged 62 commits into from
Nov 28, 2023

Conversation

bassosimone
Copy link
Contributor

@bassosimone bassosimone commented Nov 28, 2023

This diff introduces the minipipeline package and command. The general idea here is to analyze experiments results using an architecture that matches https://github.com/ooni/data as closely as possible.

The advantage of using this architecture is that we can neatly divide the data analysis process into three phases:

  1. ingestion converts an OONI measurement into observations, which are flat data structures
  2. analysis converts observations into an analysis structure, which is significantly simpler than observations
  3. scoring is the process (implemented by each experiment) to turn the analysis into top-level keys

That is:

stateDiagram-v2
  state "{ingestion}" as ingestion
  MEASUREMENT --> ingestion
  ingestion --> OBSERVATIONS
  state "{analysis}" as analysis
  OBSERVATIONS --> analysis
  analysis --> ANALYSIS
  state "{scoring}" as scoring
  ANALYSIS --> scoring
  scoring --> TOP_LEVEL_KEYS
Loading

This diff in particular tackles points 1 and 2. We'll implement 3 for Web Connectivity LTE in a separate diff.

The diff itself commits several observations and analysis files along with the measurements from which they originate, which we all collectively use to write regression tests for the minipipeline package.

The motivation for implementing these changes is that I need a more clearly defined model to address the differences between Web Connectivity LTE and v0.4 (see also #1392). Because there is already an architectural model for implementing these changes in ooni/data, it seems logical to borrow liberally from ooni/data.

Incidentally, this change has the benefit of making it easier, in the future, to align ooni/probe-cli and ooni/data.

The reference issue is ooni/probe#2634. Implementing this change seems now a precondition for implementing extra changes that would address such an issue for good, by changing LTE's scoring.

Unlike the ooni/data pipeline, this pipeline is minimal (hence the name): it only aims to process measurements collected by a recent version of ooniprobe, rather than all measurements from the beginning of time.

While there, disable signal integration tests because of ooni/probe#2636.

We're introducing failure modes that do not exist hence it seems
this is not the correct way of moving forward.
I'm doing this mainly to explore whether we could have more
robust webconnectivity v0.5 analysis code
Because I am dropping the requests again, we break again the tests
with the redirects. I could possibly fix it by putting requests back
again but I am not super happy about doing this because that would
cause the DSL to do some strange work and I'd honestly rather not do this.
what remains to be done now is to make sure we make green all the
tests that are currently skipped

we also need to account for differences between the two
then next step is to sort out this mess :-)
(I am thankful there's a ~comprehensive test suite.)
this happens because LTE sucessfully handshakes with the wrong address
@bassosimone bassosimone changed the title feat: write minipipeline to analyze measurements feat: minipipeline to analyze measurements Nov 28, 2023
@bassosimone bassosimone merged commit bb7dd9c into master Nov 28, 2023
10 checks passed
@bassosimone bassosimone deleted the minipipeline branch November 28, 2023 08:47
Murphy-OrangeMud pushed a commit to Murphy-OrangeMud/probe-cli that referenced this pull request Feb 13, 2024
This diff introduces the `minipipeline` package and command. The general
idea here is to analyze experiments results using an architecture that
matches https://github.com/ooni/data as closely as possible.

The advantage of using this architecture is that we can neatly divide
the data analysis process into three phases:

1. ingestion converts an OONI measurement into observations, which are
flat data structures;

2. analysis converts observations into an analysis structure, which is
significantly simpler than observations;

3. scoring is the process (implemented by each experiment) to turn the
analysis into top-level keys.

That is:

```mermaid
stateDiagram-v2
  state "{ingestion}" as ingestion
  MEASUREMENT --> ingestion
  ingestion --> OBSERVATIONS
  state "{analysis}" as analysis
  OBSERVATIONS --> analysis
  analysis --> ANALYSIS
  state "{scoring}" as scoring
  ANALYSIS --> scoring
  scoring --> TOP_LEVEL_KEYS
```

This diff in particular tackles points 1 and 2. We'll implement 3 for
Web Connectivity LTE in a separate diff.

The diff itself commits several observations and analysis files along
with the measurements from which they originate, which we all
collectively use to write regression tests for the `minipipeline`
package.

The motivation for implementing these changes is that I need a more
clearly defined model to address the differences between Web
Connectivity LTE and v0.4 (see also
ooni#1392). Because there is already
an architectural model for implementing these changes in ooni/data, it
seems logical to borrow liberally from ooni/data.

Incidentally, this change has the benefit of making it easier, in the
future, to align ooni/probe-cli and ooni/data.

The reference issue is ooni/probe#2634.
Implementing this change seems now a precondition for implementing extra
changes that would address such an issue for good, by changing LTE's
scoring.

Unlike the ooni/data pipeline, this pipeline is minimal (hence the
name): it only aims to process measurements collected by a recent
version of ooniprobe, rather than all measurements from the beginning of
time.

While there, disable signal integration tests because of
ooni/probe#2636.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant