Examples: query, "exact match", wildcard*, wild?ard, wild*rd
Fuzzy search: cake~ (finds cakes, bake)
Term boost: "red velvet"^4, chocolate^2
Field grouping: tags:(+work -"fun-stuff")
Escaping: Escape characters +-&|!(){}[]^"~*?:\ with \, e.g. \+
Range search: properties.timestamp:[1587729413488 TO *] (inclusive), properties.title:{A TO Z}(excluding A and Z)
Combinations: chocolate AND vanilla, chocolate OR vanilla, (chocolate OR vanilla) NOT "vanilla pudding"
Field search: properties.title:"The Title" AND text
Answered
Hello. Is There Any Doc Where I Could Find What Contributes As Api Usage? And Is It Possible To View The Usage Breakdown By Source/Type? I Want To Estimate Api Usage Costs Before Signing Up For Pro Plan On The Saas.

Hello. Is there any doc where I could find what contributes as API usage? And is it possible to view the usage breakdown by source/type? I want to estimate API usage costs before signing up for Pro plan on the SaaS.

  
  
Posted one year ago
Votes Newest

Answers 7


To give some background - We signed up for SaaS (free tier) about 2 weeks ago. Snice then we have have been running agents on 3 on-premise systems. We have tried about 5 practice projects to familiarize ourselves with the platform, and that exhausted the 1M api usage limit. So, before I sign up for the pro version and add all of my team members, I wanted to figure out how to monitor and control API usage. What do you think could be the biggest contributor to API usage with such little use of the SaaS?

  
  
Posted one year ago

Hi TroubledHedgehog16 , I don't think there is any specific documentation regarding this. Basically anything that communicates with the server (UI/SDK/Agent) will cause an increase in these calls.

You could do a test on a free account using your resource to see how many calls you would reach in a peak day.

  
  
Posted one year ago

TroubledHedgehog16 generally speaking you can expect about 10 api calls per minute if you have many reports, and about 3 per minute on low report. We just optimized the sdk so in cases there are lots of consequential reports they are better batched, I would recommend the latest RC

  
  
Posted one year ago

Thanks AgitatedDove14 Does the sdk.development.worker.report_period_sec configuration determine the reporting period?

  
  
Posted one year ago

Got it. Thanks CostlyOstrich36 !

  
  
Posted one year ago

Thanks TroubledHedgehog16 for the context.

sdk.development.worker.report_period_sec

Yes please update to the latest version 1.8.0 for full support (to be released today, I think)
https://github.com/allegroai/clearml/blob/f6238b8a0fb662540bca9095cc0c22bd7af483c1/docs/clearml.conf#L196
https://github.com/allegroai/clearml/blob/f6238b8a0fb662540bca9095cc0c22bd7af483c1/docs/clearml.conf#L199

we have have been running agents on 3 on-premise systems.

Do notice that by default an agent will ping the backend every 5 seconds to check if there is something for it to do.

What do you think could be the biggest contributor to API usage with such little use of the SaaS?

Mostly reporting, that said 3 Idle workers would be 3x12 API calls per minute -> ~1.6M API calls a month -> which I think would 16$ of API calls, I'm assuming negligible 🙂

  
  
Posted one year ago

Thank you so much! AgitatedDove14 It's pretty clear now.

  
  
Posted one year ago
625 Views
7 Answers
one year ago
one year ago
Tags