conduwuit/docs/development.md

# Development

Information about developing the project. If you are only interested in using
it, you can safely ignore this section.

## Debugging with `tokio-console`

[`tokio-console`][1] can be a useful tool for debugging and profiling. To make
a `tokio-console`-enabled build of Conduwuit, enable the `tokio_console` feature,
disable the default `release_max_log_level` feature, and set the
`--cfg tokio_unstable` flag to enable experimental tokio APIs. A build might
look like this:

```bash
RUSTFLAGS="--cfg tokio_unstable" cargo build \
    --release \
    --no-default-features \
    --features
    backend_rocksdb,systemd,element_hacks,sentry_telemetry,gzip_compression,brotli_compression,zstd_compression,tokio_console
```

[1]: https://docs.rs/tokio-console/latest/tokio_console/
use `lib.makeScope` and files to organize packages Some of the improvements here include: * rocksdb can actually use jemalloc now instead of just pulling in a second rocksdb for no reason * "complement-runtime" factored back out into shell file * complement image no longer uses `mkDerivation` for `copyToRoot` because that's what `buildEnv` is for * complement image no longer sets `SERVER_NAME`, complement already does that * all packages were factored out into `callPackage`-able files for use with a custom `lib.makeScope pkgs.newScope` * new version of `mkPackage` has options that are easier to use and override such as `features` 2024-04-21 22:28:35 +00:00			`# Development`

			`Information about developing the project. If you are only interested in using`
			`it, you can safely ignore this section.`
add optional support for tokio-console This turned out to be quite hairy, mostly because we need to apply the config's log level filter to the actual logs (stdout and, optionally sentry), but do not want to filter out the tokio tracing events needed by the console_subscriber. I hit several edge cases in tracing getting this to work, and we now depend on a git version of tracing with a backported patch :( 2024-04-25 16:07:59 +00:00
			## Debugging with `tokio-console`

			[`tokio-console`][1] can be a useful tool for debugging and profiling. To make
			a `tokio-console`-enabled build of Conduwuit, enable the `tokio_console` feature,
			disable the default `release_max_log_level` feature, and set the
			`--cfg tokio_unstable` flag to enable experimental tokio APIs. A build might
			`look like this:`

			```bash
			`RUSTFLAGS="--cfg tokio_unstable" cargo build \`
			`--release \`
			`--no-default-features \`
			`--features`
			`backend_rocksdb,systemd,element_hacks,sentry_telemetry,gzip_compression,brotli_compression,zstd_compression,tokio_console`
			```

			`[1]: https://docs.rs/tokio-console/latest/tokio_console/`