Skip to content

Commit 683f964

Browse files
fpagnynerda-codes
andauthored
feat(genapi): add faq about token consumption monitoring (#4674)
* feat(genapi): add faq about token consumption monitoring * feat(genapi): update faq * Apply suggestions from code review --------- Co-authored-by: Néda <[email protected]>
1 parent 8bc1afd commit 683f964

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

pages/generative-apis/faq.mdx

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,29 @@ Note that:
2929
- Cockpits are isolated by Projects, hence you first need to select the right project in the Scaleway console before accessing Cockpit to see your token consumption for this Project (you can see the `project_id` in the Cockpit URL: `https://{project_id}.dashboard.obs.fr-par.scw.cloud/`.
3030
- Cockpit graphs can take up to 1 hour to update token consumption, see [Troubleshooting](https://www.scaleway.com/en/docs/generative-apis/troubleshooting/fixing-common-issues/#tokens-consumption-is-not-displayed-in-cockpit-metrics) for further details.
3131

32+
## How can I give access to token consumption to my users outside of Scaleway?
33+
If your users do not have a Scaleway account, you can still give them access to their Generative API usage consumption by either:
34+
- Providing them an access to Grafana inside [Cockpit](https://console.scaleway.com/cockpit/overview). You can create dedicated [Grafana users](https://console.scaleway.com/cockpit/users) with read-only access (**Viewer** Role). Note that these users will still have access to all other Cockpit dashboards for this project.
35+
- Collecting consumption data from the [Billing API](https://www.scaleway.com/en/developers/api/billing/#path-consumption-get-monthly-consumption) and exposing it to your users. Consumption can be detailed by Projects.
36+
- Collecting consumption data from [Cockpit data sources](https://console.scaleway.com/cockpit/dataSource) and exposing it to your users. As an example, you can query consumption using the following query:
37+
```curl
38+
curl -G 'https://{data-source-id}.metrics.cockpit.fr-par.scw.cloud/prometheus/api/v1/query_range' \
39+
--data-urlencode 'query=generative_apis_tokens_total{resource_name=~".*",type=~"(input_tokens|output_tokens)"}' \
40+
--data-urlencode 'start=2025-03-15T20:10:51.781Z' \
41+
--data-urlencode 'end=2025-03-20T20:10:51.781Z' \
42+
--data-urlencode 'step=1h' \
43+
-H "Authorization: Bearer $COCKPIT_TOKEN" | jq
44+
```
45+
Make sure that you replace the following values:
46+
- `data-source-id`: ID of your [Scaleway metrics data source](https://console.scaleway.com/cockpit/dataSource)
47+
- `$COCKPIT_TOKEN`: your [Cockpit token](https://console.scaleway.com/cockpit/tokens)
48+
- `start` and `end` time properties: your specific time range
49+
50+
You can see your token consumption in [Scaleway Cockpit](https://console.scaleway.com/cockpit/). You can access it from the Scaleway console under the [Metrics tab](https://console.scaleway.com/generative-api/metrics).
51+
Note that:
52+
- Cockpits are isolated by Projects. You first need to select the right Project in the Scaleway console before accessing Cockpit to see your token consumption for the desired Project (you can see the `project_id` in the Cockpit URL: `https://{project_id}.dashboard.obs.fr-par.scw.cloud/`.
53+
- Cockpit graphs can take up to 1 hour to update token consumption, see [Troubleshooting](/generative-apis/troubleshooting/fixing-common-issues/#tokens-consumption-is-not-displayed-in-cockpit-metrics) for further details.
54+
3255
## Can I configure a maximum billing threshold?
3356
Currently, you cannot configure a specific threshold after which your usage will blocked. However:
3457
- You can [configure billing alerts](/billing/how-to/use-billing-alerts/) to ensure you are warned when you hit specific budget thresholds.

0 commit comments

Comments
 (0)