tyler/proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

cleanup worker task logging

Browse Source 
In order to avoid name conflicts with WorkerTaskContext

- renamed WorkerTask::log to WorkerTask::log_message

Note: Methods have different fuction signatures

Also renamed WorkerTask::warn to WorkerTask::log_warning for
consistency reasons.

Use the task_log!() and task_warn!() macros more often.
This commit is contained in:
Dietmar Maurer
2021-09-24 09:30:00 +02:00
parent c8449217dc
commit 1ec0d70d09
21 changed files with 210 additions and 183 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/api2/node/apt.rs
View File

@ -89,7 +89,7 @@ fn read_and_update_proxy_config() -> Result<Option<ProxyConfig>, Error> {
}
fn do_apt_update(worker: &WorkerTask, quiet: bool) -> Result<(), Error> {
if !quiet { worker.log("starting apt-get update") }
if !quiet { worker.log_message("starting apt-get update") }
read_and_update_proxy_config()?;
@ -101,7 +101,7 @@ fn do_apt_update(worker: &WorkerTask, quiet: bool) -> Result<(), Error> {
.map_err(|err| format_err!("failed to execute {:?} - {}", command, err))?;
if !quiet {
worker.log(String::from_utf8(output.stdout)?);
worker.log_message(String::from_utf8(output.stdout)?);
}
// TODO: improve run_command to allow outputting both, stderr and stdout
@ -110,7 +110,7 @@ fn do_apt_update(worker: &WorkerTask, quiet: bool) -> Result<(), Error> {
let msg = String::from_utf8(output.stderr)
.map(|m| if m.is_empty() { String::from("no error message") } else { m })
.unwrap_or_else(|_| String::from("non utf8 error message (suppressed)"));
worker.warn(msg);
worker.log_warning(msg);
} else {
bail!("terminated by signal");
}

47
src/api2/node/certificates.rs
View File

@ -13,7 +13,7 @@ use proxmox::list_subdirs_api_method;
use pbs_api_types::{NODE_SCHEMA, PRIV_SYS_MODIFY};
use pbs_buildcfg::configdir;
use pbs_tools::cert;
use pbs_tools::{task_log, task_warn, cert};
use crate::acme::AcmeClient;
use crate::api2::types::AcmeDomain;
@ -303,7 +303,7 @@ async fn order_certificate(
};
if domains.is_empty() {
worker.log("No domains configured to be ordered from an ACME server.");
task_log!(worker, "No domains configured to be ordered from an ACME server.");
return Ok(None);
}
@ -311,11 +311,11 @@ async fn order_certificate(
let mut acme = node_config.acme_client().await?;
worker.log("Placing ACME order");
task_log!(worker, "Placing ACME order");
let order = acme
.new_order(domains.iter().map(|d| d.domain.to_ascii_lowercase()))
.await?;
worker.log(format!("Order URL: {}", order.location));
task_log!(worker, "Order URL: {}", order.location);
let identifiers: Vec<String> = order
.data
@ -327,7 +327,7 @@ async fn order_certificate(
.collect();
for auth_url in &order.data.authorizations {
worker.log(format!("Getting authorization details from '{}'", auth_url));
task_log!(worker, "Getting authorization details from '{}'", auth_url);
let mut auth = acme.get_authorization(&auth_url).await?;
let domain = match &mut auth.identifier {
@ -335,11 +335,11 @@ async fn order_certificate(
};
if auth.status == Status::Valid {
worker.log(format!("{} is already validated!", domain));
task_log!(worker, "{} is already validated!", domain);
continue;
}
worker.log(format!("The validation for {} is pending", domain));
task_log!(worker, "The validation for {} is pending", domain);
let domain_config: &AcmeDomain = get_domain_config(&domain)?;
let plugin_id = domain_config.plugin.as_deref().unwrap_or("standalone");
let mut plugin_cfg =
@ -347,7 +347,7 @@ async fn order_certificate(
format_err!("plugin '{}' for domain '{}' not found!", plugin_id, domain)
})?;
worker.log("Setting up validation plugin");
task_log!(worker, "Setting up validation plugin");
let validation_url = plugin_cfg
.setup(&mut acme, &auth, domain_config, Arc::clone(&worker))
.await?;
@ -358,17 +358,18 @@ async fn order_certificate(
.teardown(&mut acme, &auth, domain_config, Arc::clone(&worker))
.await
{
worker.warn(format!(
task_warn!(
worker,
"Failed to teardown plugin '{}' for domain '{}' - {}",
plugin_id, domain, err
));
);
}
let _: () = result?;
}
worker.log("All domains validated");
worker.log("Creating CSR");
task_log!(worker, "All domains validated");
task_log!(worker, "Creating CSR");
let csr = proxmox_acme_rs::util::Csr::generate(&identifiers, &Default::default())?;
let mut finalize_error_cnt = 0u8;
@ -381,7 +382,7 @@ async fn order_certificate(
match order.status {
Status::Pending => {
worker.log("still pending, trying to finalize anyway");
task_log!(worker, "still pending, trying to finalize anyway");
let finalize = order
.finalize
.as_deref()
@ -396,7 +397,7 @@ async fn order_certificate(
tokio::time::sleep(Duration::from_secs(5)).await;
}
Status::Ready => {
worker.log("order is ready, finalizing");
task_log!(worker, "order is ready, finalizing");
let finalize = order
.finalize
.as_deref()
@ -405,18 +406,18 @@ async fn order_certificate(
tokio::time::sleep(Duration::from_secs(5)).await;
}
Status::Processing => {
worker.log("still processing, trying again in 30 seconds");
task_log!(worker, "still processing, trying again in 30 seconds");
tokio::time::sleep(Duration::from_secs(30)).await;
}
Status::Valid => {
worker.log("valid");
task_log!(worker, "valid");
break;
}
other => bail!("order status: {:?}", other),
}
}
worker.log("Downloading certificate");
task_log!(worker, "Downloading certificate");
let certificate = acme
.get_certificate(
order
@ -438,10 +439,10 @@ async fn request_validation(
auth_url: &str,
validation_url: &str,
) -> Result<(), Error> {
worker.log("Triggering validation");
task_log!(worker, "Triggering validation");
acme.request_challenge_validation(&validation_url).await?;
worker.log("Sleeping for 5 seconds");
task_log!(worker, "Sleeping for 5 seconds");
tokio::time::sleep(Duration::from_secs(5)).await;
loop {
@ -450,7 +451,7 @@ async fn request_validation(
let auth = acme.get_authorization(&auth_url).await?;
match auth.status {
Status::Pending => {
worker.log("Status is still 'pending', trying again in 10 seconds");
task_log!(worker, "Status is still 'pending', trying again in 10 seconds");
tokio::time::sleep(Duration::from_secs(10)).await;
}
Status::Valid => return Ok(()),
@ -567,11 +568,11 @@ pub fn revoke_acme_cert(rpcenv: &mut dyn RpcEnvironment) -> Result<String, Error
auth_id,
true,
move |worker| async move {
worker.log("Loading ACME account");
task_log!(worker, "Loading ACME account");
let mut acme = node_config.acme_client().await?;
worker.log("Revoking old certificate");
task_log!(worker, "Revoking old certificate");
acme.revoke_certificate(cert_pem.as_bytes(), None).await?;
worker.log("Deleting certificate and regenerating a self-signed one");
task_log!(worker, "Deleting certificate and regenerating a self-signed one");
delete_custom_certificate().await?;
Ok(())
},

3
src/api2/node/disks/directory.rs
View File

@ -10,6 +10,7 @@ use pbs_api_types::{
DataStoreConfig, NODE_SCHEMA, BLOCKDEVICE_NAME_SCHEMA,
DATASTORE_SCHEMA, UPID_SCHEMA, PRIV_SYS_AUDIT, PRIV_SYS_MODIFY,
};
use pbs_tools::task_log;
use crate::tools::disks::{
DiskManage, FileSystemType, DiskUsageType,
@ -169,7 +170,7 @@ pub fn create_datastore_disk(
let upid_str = WorkerTask::new_thread(
"dircreate", Some(name.clone()), auth_id, to_stdout, move |worker|
{
worker.log(format!("create datastore '{}' on disk {}", name, disk));
task_log!(worker, "create datastore '{}' on disk {}", name, disk);
let add_datastore = add_datastore.unwrap_or(false);
let filesystem = filesystem.unwrap_or(FileSystemType::Ext4);

3
src/api2/node/disks/mod.rs
View File

@ -16,6 +16,7 @@ use crate::tools::disks::{
get_disks, get_smart_data, get_disk_usage_info, inititialize_gpt_disk,
};
use proxmox_rest_server::WorkerTask;
use pbs_tools::task_log;
pub mod directory;
pub mod zfs;
@ -155,7 +156,7 @@ pub fn initialize_disk(
let upid_str = WorkerTask::new_thread(
"diskinit", Some(disk.clone()), auth_id, to_stdout, move |worker|
{
worker.log(format!("initialize disk {}", disk));
task_log!(worker, "initialize disk {}", disk);
let disk_manager = DiskManage::new();
let disk_info = disk_manager.disk_by_name(&disk)?;

11
src/api2/node/disks/zfs.rs
View File

@ -13,6 +13,7 @@ use pbs_api_types::{
DISK_LIST_SCHEMA, ZFS_ASHIFT_SCHEMA, UPID_SCHEMA,
PRIV_SYS_AUDIT, PRIV_SYS_MODIFY,
};
use pbs_tools::task_log;
use crate::tools::disks::{
zpool_list, zpool_status, parse_zpool_status_config_tree, vdev_list_to_tree,
@ -231,7 +232,7 @@ pub fn create_zpool(
let upid_str = WorkerTask::new_thread(
"zfscreate", Some(name.clone()), auth_id, to_stdout, move |worker|
{
worker.log(format!("create {:?} zpool '{}' on devices '{}'", raidlevel, name, devices_text));
task_log!(worker, "create {:?} zpool '{}' on devices '{}'", raidlevel, name, devices_text);
let mut command = std::process::Command::new("zpool");
@ -265,10 +266,10 @@ pub fn create_zpool(
}
}
worker.log(format!("# {:?}", command));
task_log!(worker, "# {:?}", command);
let output = pbs_tools::run_command(command, None)?;
worker.log(output);
task_log!(worker, "{}", output);
if std::path::Path::new("/lib/systemd/system/zfs-import@.service").exists() {
let import_unit = format!("zfs-import@{}.service", proxmox::tools::systemd::escape_unit(&name, false));
@ -278,9 +279,9 @@ pub fn create_zpool(
if let Some(compression) = compression {
let mut command = std::process::Command::new("zfs");
command.args(&["set", &format!("compression={}", compression), &name]);
worker.log(format!("# {:?}", command));
task_log!(worker, "# {:?}", command);
let output = pbs_tools::run_command(command, None)?;
worker.log(output);
task_log!(worker, "{}", output);
}
if add_datastore {

8
src/api2/node/mod.rs
View File

@ -183,7 +183,7 @@ async fn termproxy(cmd: Option<String>, rpcenv: &mut dyn RpcEnvironment) -> Resu
let stdout_fut = async move {
let mut reader = BufReader::new(stdout).lines();
while let Some(line) = reader.next_line().await? {
worker_stdout.log(line);
worker_stdout.log_message(line);
}
Ok::<(), Error>(())
};
@ -192,7 +192,7 @@ async fn termproxy(cmd: Option<String>, rpcenv: &mut dyn RpcEnvironment) -> Resu
let stderr_fut = async move {
let mut reader = BufReader::new(stderr).lines();
while let Some(line) = reader.next_line().await? {
worker_stderr.warn(line);
worker_stderr.log_warning(line);
}
Ok::<(), Error>(())
};
@ -224,9 +224,9 @@ async fn termproxy(cmd: Option<String>, rpcenv: &mut dyn RpcEnvironment) -> Resu
}
if let Err(err) = child.kill().await {
worker.warn(format!("error killing termproxy: {}", err));
worker.log_warning(format!("error killing termproxy: {}", err));
} else if let Err(err) = child.wait().await {
worker.warn(format!("error awaiting termproxy: {}", err));
worker.log_warning(format!("error awaiting termproxy: {}", err));
}
}