add custom env option

Author: erhant

Makefile

@@ -5,28 +5,11 @@ ifneq (,$(wildcard ./.env))
 endif
 
 ###############################################################################
-.PHONY: launch #       | Run with INFO logs in release mode
-launch:
-		cargo run --release --bin dkn-compute
-
-.PHONY: run #          | Run with INFO logs
-run:
-		cargo run --bin dkn-compute
-
-.PHONY: monitor #      | Run monitor node with INFO logs
-monitor:
-		cargo run --bin dkn-monitor
-
 .PHONY: debug #        | Run with DEBUG logs with INFO log-level workflows
 debug:
 		RUST_LOG=warn,dkn_compute=debug,dkn_workflows=debug,dkn_p2p=debug,ollama_workflows=info \
 		cargo run --bin dkn-compute
 
-.PHONY: trace #        | Run with TRACE logs
-trace:
-		RUST_LOG=warn,dkn_compute=trace,libp2p=debug \
-		cargo run --bin dkn-compute
-
 .PHONY: build #        | Build
 build:
 		cargo build --workspace

README.md

@@ -65,11 +65,13 @@ If you would like to run the node from source (which is really handy during deve
 make help
 ```
 
-You will need OpenSSL installed as well, see shorthand commands [here](https://github.com/sfackler/rust-openssl/issues/855#issuecomment-450057552). While running Ollama elsewhere (if you are using it) or with an OpenAI API key provided, you can run the compute node with:
+You will need OpenSSL installed, see shorthand commands [here](https://github.com/sfackler/rust-openssl/issues/855#issuecomment-450057552).
 
 ```sh
-make run      # info-level logs
-make debug    # debug-level logs
+cargo run
+
+# specify custom .env file
+DKN_COMPUTE_ENV=./path/to/.env cargo run
 ```
 
 If you have a valid `.env` file, you can run the latest Docker image via compose as well:
@@ -112,6 +114,28 @@ make lint   # clippy
 make format # rustfmt
 ```
 
+### Profiling
+
+We have scripts to profile both CPU and Memory usage. A special build is created for profiling, via a custom `profiling` feature, such that the output inherits `release` mode but also has debug symbols.
+
+Furthermore, the profiling build will exit automatically after a certain time, as if CTRL+C has been pressed. This is needed by the memory profiling tool in particular.
+
+**CPU Profiling**: To create a [flamegraph](https://crates.io/crates/flamegraph) of the application, the command below will create a profiling build that inherits `release` mode, except with debug information:
+
+```sh
+make profile-cpu
+```
+
+> [!NOTE]
+>
+> CPU profiling may require super-user access.
+
+**Memory Profiling**: To profile memory usage, we make use of [cargo-instruments](https://crates.io/crates/cargo-instruments):
+
+```sh
+make profile-mem
+```
+
 ## License
 
 This project is licensed under the [Apache License 2.0](https://opensource.org/license/Apache-2.0).

compute/src/main.rs

@@ -7,7 +7,9 @@ use workers::task::TaskWorker;
 
 #[tokio::main]
 async fn main() -> Result<()> {
-    let dotenv_result = dotenvy::dotenv();
+    // load a particular env, or `.env` by default
+    let env_path = env::var("DKN_COMPUTE_ENV").unwrap_or_else(|_| ".env".to_string());
+    let dotenv_result = dotenvy::from_path(&env_path);
 
     env_logger::builder()
         .format_timestamp(Some(env_logger::TimestampPrecision::Millis))
@@ -33,8 +35,8 @@ async fn main() -> Result<()> {
 
     // log about env usage
     match dotenv_result {
-        Ok(path) => log::info!("Loaded .env file at: {}", path.display()),
-        Err(e) => log::warn!("Could not load .env file: {}", e),
+        Ok(_) => log::info!("Loaded environment file from {}", env_path),
+        Err(e) => log::warn!("Could not load environment file from {}: {}", env_path, e),
     }
 
     // task tracker for multiple threads