Add emulation test plan

[ackintosh]

How to run

# Import test plans
git clone https://github.com/sigp/gossipsub-testground.git
testground plan import --from ./gossipsub-testground/

# Run `emulation` test plan
cd gossipsub-testground
testground run composition -f emulation/compositions/emulation.toml --wait

Test parameters available

• Please see manifest.toml

READMEs

In this PR, the following READMEs have been updated/added.

• README
• emulation/README

What the emulation does

Note: Attackers connect to a single publisher (victim).

Dashboards

Please run docker-compose up and browse http://localhost:13000/dashboards.

Gossipsub Metrics

The metrics of gossipsub are recorded once the emulation has been completed. All of the metrics on libp2p-gossipsub are available in this dashboard.

Variables for this dashboard:

• run_id: The run_id for the test run you want to see.
• topic: The gossipsub topic, currently it's fixed to emulate.
• instance_name: Some panels in this dashboard need an instance name to be specified. (e.g. score_per_mesh histogram)

Peer Scores

The peer scores are recorded periodically (every second) while the emulation is running.

Variables for this dashboard:

• run_id: The run_id for the test run you want to see.
• instance_name: It's default to All, you can select specific instances.

---

Remaining work

• prometheus-client: Finish Protobuf support prometheus/client_rust#83. -> Done
• libp2p-gossipsub: Make a change to enable the protobuf support.
  • Note: In this PR, the forked ones are used for now. (prometheus-client, libp2p)
  • Please see here for the current progress.
• Create Grafana dashboard -> Done

[ackintosh]

Regarding recording gossipsub metrics: prometheus-client is used in libp2p-gossipsub, but in testground, InfluxDB. So in order to record gossipsub metrics (stored in prometheus-client) to InfluxDB, I need to progress Protobuf support on prometheus-client.

[ackintosh]

Trying to enable the protobuf feature on libp2p

I have updated libp2p on e46643a. The revision of libp2p 7eb216f4c259c8f5b6f23dbdc044b45e8a38c2e5 is in libp2p/rust-libp2p#2911.

The following compile error occurs now:

error[E0308]: mismatched types
   --> emulation/src/honest.rs:287:23
    |
287 |                 Some((registry, Config::default())),
    |                       ^^^^^^^^ expected trait `SendSyncEncodeMetric`, found trait `prometheus_client::encoding::proto::EncodeMetric`
    |
    = note: expected mutable reference `&mut prometheus_client::registry::Registry`
               found mutable reference `&mut prometheus_client::registry::Registry<Box<(dyn prometheus_client::encoding::proto::EncodeMetric + 'static)>>`

For more information about this error, try `rustc --explain E0308`.
error: could not compile `emulation` due to previous error

I think something updates are needed on libp2p side, but I'm stuck. 🤔

---

UPDATE

I have updated libp2p on e46643a.
...
...
The following compile error occurs now:
...
I think something updates are needed on libp2p side, but I'm stuck. 🤔

I have reverted that on a1ac67a in order to progress create Grafana dashboard settings. Now the libp2p package points to my fork ( prometheus-ptotobuf-support branch), whose encoding is fixed to protobuf.

---

UPDATE: 2022-09-30

• Here are some attempts to allow the proto encoding of prometheus-client on rust-libp2p but we're struggling with that due to the complexity.
  • protocols/gossipsub: Enable the protobuf feature of prometheus-client libp2p/rust-libp2p#2911
• To simplify the problem, Max started working to remove the type parameter M on prometheus-client.
  • src/registry: Use dynamic dispatch and remove type parameter M prometheus/client_rust#100

[AgeManning]

This is solid progress. Lets merge down and make adjustments in future PRs