Skip to content

Commit fbe21cd

Browse files
committed
update promql-to-scrape README
Update to more accurately reflect the guidance we give for users of this service.
1 parent 9e11480 commit fbe21cd

File tree

1 file changed

+6
-2
lines changed
  • cloud/observability/promql-to-scrape

1 file changed

+6
-2
lines changed

cloud/observability/promql-to-scrape/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,13 @@ This means you can now hit http://localhost:9001/metrics on your machine and see
2121

2222
### Important Usability Information
2323

24-
**Important:** When you go to scrape this, you should do so with a **60s** scrape interval, unless you are meaningfully modifying this code. The example queries all assume a 1 minute rate and you'll want these to be equal.
24+
**Important:** When you scrape this endpoint, you should do so with a scrape interval **<= the rate interval of the queries in your config file, and at least 1m**.
2525

26-
**Very Important:** The data you will see here is approximately 1 minute delayed (should you conform to the guidance above). Due to the aggregation that happens before metrics are presented to you, it's necessary for us to send the queries from this application to look 60 seconds in the past. Otherwise data aggregation would not be complete, and there would be no results for each query.
26+
In general, you'll want the scrape interval and rate interval to be equal, as downstream systems may assume that timeseries data is exclusive to the interval between points.
27+
28+
But if you're ok with a gauge that is looking back longer than the interval between data points in your timeseries database, a scrape interval < the rate interval is acceptable.
29+
30+
**Important:** The data you will see here is subject to an aggregation delay. You may encounter issues with data appearing missing if you **use a rate interval < 2m**.
2731

2832
## Deployment
2933

0 commit comments

Comments
 (0)