Merge pull request #542 from theseus-rs/optimize-logging-startup

feat: optimize logging startup

Author: brianheineman

Cargo.lock

@@ -68,7 +68,7 @@ test-log = "0.2.18"
 thiserror = "2.0.12"
 thread-priority = "2.1.0"
 tokio = { version = "1.47.1", default-features = false, features = ["macros", "rt", "sync"] }
-tracing = "0.1.41"
+tracing = { version = "0.1.41", default-features = false, features = ["release_max_level_info", "std"] }
 tracing-subscriber = "0.3.19"
 walkdir = "2.5.0"
 whoami = "1.6.0"

Cargo.toml

@@ -3,7 +3,7 @@ use crate::Result;
 use crate::class_path_entry::ClassPathEntry;
 use ristretto_classfile::ClassFile;
 use std::fmt::Display;
-use tracing::{info, instrument};
+use tracing::info;
 
 /// Represents a class path.
 ///
@@ -50,7 +50,6 @@ impl ClassPath {
     /// # Errors
     ///
     /// if the class file is not found or cannot be read.
-    #[instrument(level = "trace", fields(name = ?name.as_ref()), skip(self))]
     pub async fn read_class<S: AsRef<str>>(&self, name: S) -> Result<ClassFile> {
         let name = name.as_ref();
 

ristretto_classloader/src/class_path.rs

@@ -4,7 +4,6 @@ use ristretto_classfile::ClassFile;
 use std::fmt::Debug;
 use std::path::PathBuf;
 use std::{fs, io};
-use tracing::instrument;
 use walkdir::WalkDir;
 
 /// A directory in the class path.
@@ -35,7 +34,6 @@ impl Directory {
     /// # Errors
     ///
     /// if the class file is not found or cannot be read.
-    #[instrument(level = "trace", fields(name = ?name.as_ref()), skip(self))]
     pub fn read_class<S: AsRef<str>>(&self, name: S) -> Result<ClassFile> {
         let name = name.as_ref();
         let parts = name.split('.').collect::<Vec<_>>();

ristretto_classloader/src/class_path_entry/directory.rs

@@ -9,7 +9,6 @@ use std::str::FromStr;
 use std::sync::Arc;
 use std::{fs, io};
 use tokio::sync::RwLock;
-use tracing::instrument;
 use zip::ZipArchive;
 
 /// A jar or zip in the class path.
@@ -80,7 +79,6 @@ impl Jar {
     /// # Errors
     ///
     /// if the file is not found or cannot be read.
-    #[instrument(level = "trace", fields(name = ?name.as_ref()), skip(self))]
     pub async fn read_file<S: AsRef<str>>(&self, name: S) -> Result<Option<Vec<u8>>> {
         let mut archive = self.archive.write().await;
         archive.load_file(name.as_ref()).await
@@ -91,7 +89,6 @@ impl Jar {
     /// # Errors
     ///
     /// if the class file is not found or cannot be read.
-    #[instrument(level = "trace", fields(name = ?name.as_ref()), skip(self))]
     pub async fn read_class<S: AsRef<str>>(&self, name: S) -> Result<ClassFile> {
         let name = name.as_ref();
         let mut archive = self.archive.write().await;
@@ -236,7 +233,6 @@ impl Archive {
     /// # Errors
     ///
     /// if the jar cannot be read or the class file cannot be loaded.
-    #[instrument(level = "trace")]
     async fn load_class_file(&mut self, class_name: &str) -> Result<Option<ClassFile>> {
         let class_file_name = format!("{class_name}.class");
         let file = self.load_file(&class_file_name).await?;
@@ -254,7 +250,6 @@ impl Archive {
     /// # Errors
     ///
     /// if the jar cannot be read or the class file cannot be loaded.
-    #[instrument(level = "trace")]
     async fn load_file(&mut self, file_name: &str) -> Result<Option<Vec<u8>>> {
         let zip_archive = self.zip_archive().await?;
         if let Some(index) = zip_archive.index_for_name(file_name) {

ristretto_classloader/src/class_path_entry/jar.rs

@@ -4,7 +4,6 @@ use crate::class_path_entry::jar::Jar;
 use ristretto_classfile::ClassFile;
 use std::fmt::Debug;
 use std::path::PathBuf;
-use tracing::instrument;
 
 /// Represents a class path entry.
 #[derive(Clone, Debug, PartialEq)]
@@ -44,7 +43,6 @@ impl ClassPathEntry {
     /// # Errors
     ///
     /// if the class file cannot be read.
-    #[instrument(level = "trace", fields(name = ?name.as_ref()), skip(self))]
     pub async fn read_class<S: AsRef<str>>(&self, name: S) -> Result<ClassFile> {
         match self {
             ClassPathEntry::Directory(directory) => directory.read_class(name),

ristretto_classloader/src/class_path_entry/model.rs

@@ -7,7 +7,7 @@ use std::path::{Path, PathBuf};
 use std::sync::Arc;
 use std::{env, io};
 use tar::Archive;
-use tracing::{debug, instrument, warn};
+use tracing::{debug, warn};
 
 pub const DEFAULT_JAVA_VERSION: &str = "21.0.8.9.1";
 
@@ -26,8 +26,7 @@ pub async fn default_class_loader() -> Result<(PathBuf, String, Arc<ClassLoader>
 /// # Errors
 ///
 /// An error will be returned if the class loader cannot be created.
-#[instrument(level = "debug")]
-pub async fn home_class_loader(java_home: &PathBuf) -> Result<(PathBuf, String, Arc<ClassLoader>)> {
+pub async fn home_class_loader(java_home: &Path) -> Result<(PathBuf, String, Arc<ClassLoader>)> {
     let version_file = java_home.join("version.txt");
     // Corretto version 8 does not have a release file, but includes a version.txt file. Since most
     // versions of Corretto include a version.txt file, and it should be faster to process, we can
@@ -65,7 +64,7 @@ pub async fn home_class_loader(java_home: &PathBuf) -> Result<(PathBuf, String,
     let class_path = get_class_path(&java_version, java_home)?;
     let class_loader = ClassLoader::new("bootstrap", class_path);
     register_primitives(&class_loader).await?;
-    Ok((java_home.clone(), java_version, class_loader))
+    Ok((java_home.to_path_buf(), java_version, class_loader))
 }
 
 /// Get a class loader for the given Java runtime version. If the version is not installed, the
@@ -75,7 +74,6 @@ pub async fn home_class_loader(java_home: &PathBuf) -> Result<(PathBuf, String,
 /// # Errors
 ///
 /// An error will be returned if the class loader cannot be created.
-#[instrument(level = "debug")]
 pub async fn version_class_loader(version: &str) -> Result<(PathBuf, String, Arc<ClassLoader>)> {
     let mut version = version.to_string();
     #[cfg(target_family = "wasm")]
@@ -172,7 +170,6 @@ fn get_class_path(version: &str, installation_dir: &Path) -> Result<ClassPath> {
 /// # Errors
 ///
 /// An error will be returned if the archive cannot be extracted.
-#[instrument(level = "debug", skip(archive))]
 async fn extract_archive(
     version: &str,
     file_name: &str,

ristretto_classloader/src/runtime/bootstrap.rs

@@ -5,7 +5,7 @@ use reqwest::header;
 use std::env;
 use std::env::consts;
 use std::sync::LazyLock;
-use tracing::{debug, instrument};
+use tracing::debug;
 
 const DEFAULT_MAJOR_VERSION: u64 = 21;
 const GITHUB_API_VERSION_HEADER: &str = "X-GitHub-Api-Version";
@@ -36,7 +36,6 @@ static USER_AGENT: LazyLock<String> = LazyLock::new(|| {
 /// # Errors
 ///
 /// An error will be returned if the request fails or if the version requirement is not supported.
-#[instrument(level = "debug")]
 pub(crate) async fn get_runtime_archive(version: &str) -> Result<(String, String, Vec<u8>)> {
     let version = if version == "*" {
         DEFAULT_MAJOR_VERSION.to_string()
@@ -73,7 +72,6 @@ pub(crate) async fn get_runtime_archive(version: &str) -> Result<(String, String
 /// # Errors
 ///
 /// An error will be returned if the request fails
-#[instrument(level = "debug")]
 async fn download_archive(version: &str) -> Result<(String, Vec<u8>)> {
     let client = Client::new();
     let mut headers = header::HeaderMap::new();
@@ -132,7 +130,6 @@ async fn download_archive(version: &str) -> Result<(String, Vec<u8>)> {
 /// # Errors
 ///
 /// An error will be returned if the request fails
-#[instrument(level = "debug")]
 async fn get_release_versions(major_version: &str) -> Result<Vec<String>> {
     let url = format!("https://api.github.com/repos/corretto/corretto-{major_version}/releases");
     let client = Client::new();

ristretto_classloader/src/runtime/util.rs

@@ -3,20 +3,24 @@ use ristretto_vm::Result;
 use tracing_subscriber::filter::EnvFilter;
 use tracing_subscriber::fmt;
 
+const LOG_ENV_VAR: &str = "RISTRETTO_LOG";
+
 /// Initializes the logging system.
 pub(crate) fn initialize() -> Result<()> {
+    if std::env::var_os(LOG_ENV_VAR).is_none() {
+        return Ok(());
+    }
+
     let format = tracing_subscriber::fmt::format()
         .with_level(true)
-        .with_target(false)
-        .with_thread_ids(false)
         .with_thread_names(true)
         .with_timer(fmt::time::uptime())
         .compact();
 
     let cranelift_directive = "cranelift=warn"
         .parse()
         .map_err(|error| InternalError(format!("{error}")))?;
-    let filter = EnvFilter::from_env("JAVA_LOG").add_directive(cranelift_directive);
+    let filter = EnvFilter::from_env(LOG_ENV_VAR).add_directive(cranelift_directive);
     tracing_subscriber::fmt()
         .with_env_filter(filter)
         .fmt_fields(fmt::format::DefaultFields::new())

ristretto_cli/src/logging.rs

@@ -37,8 +37,9 @@ async fn main() -> Result<()> {
 async fn main() -> Result<()> {
     startup_trace!("[cli] entry point");
     let cli = Cli::parse();
+    startup_trace!("[cli] argument parse");
     logging::initialize()?;
-    startup_trace!("[cli] initialization");
+    startup_trace!("[cli] logging initialize");
     if common_main(cli).await.is_err() {
         std::process::exit(1);
     }