Instructions how to debug edgelessdb?

[beejones]

Hi,

Thanks your for your great project. I am trying to debug edgelessdb. Are there any instructions how to do this?

I tried the following: EDG_EDB_DEBUG=1 OE_SIMULATION=1 sudo docker run -t --name edb -p3306:3306 -p8080:8080 --privileged -e EDG_MARBLE_TYPE=edb -v /dev/sgx:/dev/sgx edb -marble

This gives the following error:

[erthost] loading enclave ... [erthost] entering enclave ... [PreMain] 2021/08/30 11:00:07 starting PreMain [PreMain] 2021/08/30 11:00:07 fetching env variables [PreMain] 2021/08/30 11:00:07 loading TLS Credentials [PreMain] 2021/08/30 11:00:07 loading UUID [PreMain] 2021/08/30 11:00:07 UUID not found. Generating and storing a new UUID [PreMain] 2021/08/30 11:00:07 generating CSR [PreMain] 2021/08/30 11:00:07 generating quote [PreMain] 2021/08/30 11:00:08 activating marble of type edb panic: rpc error: code = Unavailable desc = connection error: desc = "transport: Error while dialing dial tcp 127.0.0.1:2001: connect: connection refused"

It would be great to have a debugging page in edgelessdb. Thanks

[Nirusu]

Hey @beejones,

you are trying to run EdgelessDB in Marble mode, which assumes that you want to run EdgelessDB in a MarbleRun cluster. The issue you are having is that EdgelessDB cannot find a running MarbleRun coordinator upon launch (which it expects under the 127.0.0.1:2001 address).

I am not sure if running EdgelessDB as a Marble is actually your intention.

If you do not have MarbleRun running, just remove -marble from your command line, and EdgelessDB will run standalone.

If you have MarbleRun running, make sure the Coordinator networking port is exposed to the Docker environment. You might also need to provide additional configuration depending on your setup via Docker -e parameters, similar to EDG_MARBLE_TYPE.

This should already fix the issue, I guess.

Some notes regarding your question about debugging EdgelessDB:

• The environment variables you are prepending to the docker run commands are not forwarded to EdgelessDB running inside the container. You need to specify all of them via Docker's -e parameter, as you do with EDG_MARBLE_TYPE. Right now, EdgelessDB is not aware of EDG_EDB_DEBUG=1 and OE_SIMULATION=1 (which you seemingly don't need if you already get this far, this is mostly useful on non-SGX hardware or if you want to bypass quote-related features (such as remote attestation or PackageProperties enforcement when running in a MarbleRun cluster which also runs in simulation mode).
• The additional debug logs you get from enabling EDG_EDB_DEBUG=1 mostly refers to the MariaDB database engine running inside EdgelessDB, which usually logs to stdout but is disabled (or more specifically: redirected to stay inside the enclave) by default. EDG_EDB_DEBUG=1 in combination with a manifest which allows debugging allows you to re-enable MariaDB's error logging to stdout.

The reason the debug option exists is that we do not want to expose potentially any information about the database structure to the host system, unless the deployment allows it. However, everything affected by the EDG_EDB_DEBUG happens after a manifest has been deployed. Before this, you mostly have to work with the error messages given to you (which honestly are pretty verbose except for a lack of a traceback, we do not sugarcoat them in a great fashion currently), or actually start debugging the code.

But yeah, in any case we are here to help! :)

[beejones]

Got it. Thanks.