Re: [PATCH proxmox-backup v5 04/20] api: s3: add endpoint to reset s3 request counters

[Christian Ebner <c.ebner@proxmox.com>]

On 3/12/26 3:07 PM, Hannes Laimer wrote:
> On 2026-03-11 14:08, Christian Ebner wrote:
>> Allows to reset the current counter states. This can be done
>> manually or possibly by a scheduled task in the future.
>>
>> The intent is to start fresh in case of e.g. monthly limit warnings.
>>
>> Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
>> ---
>>   src/api2/admin/s3.rs | 71 ++++++++++++++++++++++++++++++++++++++++++--
>>   1 file changed, 68 insertions(+), 3 deletions(-)
>>
>> diff --git a/src/api2/admin/s3.rs b/src/api2/admin/s3.rs
>> index d08ab3246..fb3488eb8 100644
>> --- a/src/api2/admin/s3.rs
>> +++ b/src/api2/admin/s3.rs
>> @@ -1,13 +1,16 @@
>>   //! S3 bucket operations
>>   
>> -use anyhow::{Context, Error};
>> +use std::path::Path;
>> +use std::sync::atomic::Ordering;
>> +
>> +use anyhow::{bail, Context, Error};
>>   use serde_json::Value;
>>   
>>   use proxmox_http::Body;
>>   use proxmox_router::{list_subdirs_api_method, Permission, Router, RpcEnvironment, SubdirMap};
>>   use proxmox_s3_client::{
>>       S3Client, S3ClientConf, S3ClientOptions, S3ObjectKey, S3RequestCounterOptions,
>> -    S3_BUCKET_NAME_SCHEMA, S3_CLIENT_ID_SCHEMA, S3_HTTP_REQUEST_TIMEOUT,
>> +    SharedRequestCounters, S3_BUCKET_NAME_SCHEMA, S3_CLIENT_ID_SCHEMA, S3_HTTP_REQUEST_TIMEOUT,
>>   };
>>   use proxmox_schema::*;
>>   use proxmox_sortable_macro::sortable;
>> @@ -97,8 +100,70 @@ pub async fn check(
>>       Ok(Value::Null)
>>   }
>>   
>> +#[api(
>> +    input: {
>> +        properties: {
>> +            "s3-endpoint-id": {
> ^ we do `match_all` for `s3-client-id` in the router, so this should be
> `s3-client-id`

Will be fixed as well with an upcoming v6, thanks!

> 
>> +                schema: S3_CLIENT_ID_SCHEMA,
>> +            },
>> +            bucket: {
>> +                schema: S3_BUCKET_NAME_SCHEMA,
>> +            },
>> +            "store-prefix": {
>> +                type: String,
>> +                description: "Store prefix within bucket for S3 object keys (commonly datastore name)",
>> +                optional: true,
>> +            },
>> +        },
>> +    },
>> +    access: {
>> +        permission: &Permission::Privilege(&[], PRIV_SYS_MODIFY, false),
>> +    },
>> +)]
>> +/// Reset the S3 request counters for matching endpoint, bucket or datastore (if prefix is given).
>> +pub async fn reset_counters(
>> +    s3_endpoint_id: String,
>> +    bucket: String,
>> +    store_prefix: Option<String>,
>> +    _rpcenv: &mut dyn RpcEnvironment,
>> +) -> Result<(), Error> {
>> +    let (config, _digest) = pbs_config::s3::config()?;
>> +    // only check if the provided endpoint id exists
>> +    let _config: S3ClientConf = config
>> +        .lookup(S3_CFG_TYPE_ID, &s3_endpoint_id)
>> +        .context("config lookup failed")?;
>> +
>> +    let request_counter_id = if let Some(store) = &store_prefix {
>> +        format!("{s3_endpoint_id}-{bucket}-{store}")
>> +    } else {
>> +        format!("{s3_endpoint_id}-{bucket}")
>> +    };
>> +
>> +    let path = format!("{S3_CLIENT_REQUEST_COUNTER_BASE_PATH}/{request_counter_id}.shmem");
>> +    let path = Path::new(&path);
>> +    // Fail early to not create the file when opening shared memory map below. Accept that
>> +    // this can race, with a new counter file being created in the mean time, but that is
>> +    // not an issue.
>> +    if !path.is_file() {
>> +        bail!("Cannot find s3 counters file '{path:?}'");
>> +    }
>> +
>> +    let user = pbs_config::backup_user()?;
>> +    let request_counters = SharedRequestCounters::open_shared_memory_mapped(path, user)
>> +        .context("failed to open shared request counters")?;
>> +    request_counters.reset(Ordering::Release);
>> +
>> +    Ok(())
>> +}
>> +
>>   #[sortable]
>> -const S3_OPERATION_SUBDIRS: SubdirMap = &[("check", &Router::new().put(&API_METHOD_CHECK))];
>> +const S3_OPERATION_SUBDIRS: SubdirMap = &[
>> +    ("check", &Router::new().put(&API_METHOD_CHECK)),
>> +    (
>> +        "reset-counters",
>> +        &Router::new().put(&API_METHOD_RESET_COUNTERS),
>> +    ),
>> +];
>>   
>>   const S3_OPERATION_ROUTER: Router = Router::new()
>>       .get(&list_subdirs_api_method!(S3_OPERATION_SUBDIRS))
>