tomasalias/AstralRinth
1
0
Fork 0
forked from didirus/AstralRinth
Code Pull Requests Activity

Split logging utils into its own crate (#4852)

Browse Source 
* Split logging utils into its own crate

* fix review comments

* remove anyhow from root

* make meilisearch less verbose
This commit is contained in:
aecsocket
2025-12-12 02:09:57 +00:00
committed by GitHub
parent 91accd5578
commit 7aaf99a0c8
8 changed files with 71 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
packages/modrinth-util/src/lib.rs
View File

@@ -1,12 +1,12 @@
#![doc = include_str!("../README.md")]
mod error;
pub mod log;
#[cfg(feature = "decimal")]
pub mod decimal;
pub use error::*;
pub use modrinth_log as log;
use eyre::{Result, eyre};

74
packages/modrinth-util/src/log.rs
View File

@@ -1,74 +0,0 @@
//! Service logging utilities.
use std::str::FromStr;
use eyre::{Result, eyre};
use tracing::level_filters::LevelFilter;
use tracing_ecs::ECSLayerBuilder;
use tracing_subscriber::{
EnvFilter, layer::SubscriberExt, util::SubscriberInitExt,
};
use crate::{Context, env_var};
/// How this service will output logs to the terminal output.
///
/// See [`init`].
#[derive(Debug, Clone, Default, PartialEq, Eq)]
enum OutputFormat {
/// Human-readable format using [`tracing_subscriber::fmt::layer`].
#[default]
Human,
/// Elastic Common Schema JSON output using [`ECSLayerBuilder`].
Json,
}
impl FromStr for OutputFormat {
type Err = ();
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s {
"human" => Ok(Self::Human),
"json" => Ok(Self::Json),
_ => Err(()),
}
}
}
/// Key for the environment variable that determines the output format.
pub const OUTPUT_FORMAT_ENV_VAR: &str = "MODRINTH_OUTPUT_FORMAT";
/// Initializes logging for Modrinth services.
///
/// This uses [`OUTPUT_FORMAT_ENV_VAR`] to determine the [`OutputFormat`] to
/// use - see that type for details of each possible format.
///
/// # Errors
///
/// Errors if logging could not be initialized.
pub fn init() -> Result<()> {
let output_format = match env_var(OUTPUT_FORMAT_ENV_VAR) {
Ok(format) => format
.parse::<OutputFormat>()
.map_err(|_| eyre!("invalid output format '{format}'"))?,
Err(_) => OutputFormat::Human,
};
let env_filter = EnvFilter::builder()
.with_default_directive(LevelFilter::INFO.into())
.from_env_lossy();
let result = match output_format {
OutputFormat::Human => tracing_subscriber::registry()
.with(env_filter)
.with(tracing_subscriber::fmt::layer())
.try_init(),
OutputFormat::Json => tracing_subscriber::registry()
.with(env_filter)
.with(ECSLayerBuilder::default().stdout())
.try_init(),
};
result.wrap_err("failed to initialize tracing registry")?;
Ok(())
}