search

edgebitio / enclaver

Open source toolkit created to enable easy adoption of software enclaves
https://edgebit.io/enclaver
Apache License 2.0
124 stars 12 forks source link

Enable tracing behind feature flag #159

Closed crawford closed 1 year ago

crawford commented 1 year ago

This adds the "tracing" feature, which enables tokio's tracing functionality. This allows tokio-console to attach to a running instance and display interesting (and hopefully helpful) information about the async tasks. In addition to the feature, the "tokio_unstable" config option needs to be passed to rustc:

RUSTFLAGS="--cfg tokio_unstable" cargo build ...

In order to allow multiple layers of the enclave to be measured, the console subscriber in each binary does not run on the default port. You'll need to specify which one you want to connect to:

Note that both odyn and enclaver-run are configured by default to listen on all interfaces. This is to make it easier to connect tokio-console to these processes which run in a seperate network context, but be careful if running manually or with --net=host, as anyone on the network will be able to connect.

Also note that when enclaver creates the container image tarball (via tokio_tar), many tasks are spawned; so many that it will likely exhaust the memory of your machine. Consider lowering the retention time substantially using TOKIO_CONSOLE_RETENTION. 1s seemed to work okay for a machine with 4 GiB free.

crawford commented 1 year ago

This turned into a bit of a catch-all. Let me know if you want this split into separate PRs.