feat: record API usage for any type of query #26259
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mariusandra
approved these changes
Nov 19, 2024
posthog/tasks/usage_report.py
Outdated
| @@ -580,7 +580,7 @@ def get_teams_with_hogql_metric( | |||
| FROM clusterAllReplicas({CLICKHOUSE_CLUSTER}, system.query_log) | |||
| WHERE (type = 'QueryFinish' OR type = 'ExceptionWhileProcessing') | |||
| AND is_initial_query = 1 | |||
| AND query_type IN (%(query_types)s) | |||
| AND (%(query_types)s IS NULL OR query_type IN (%(query_types)s)) | |||
There was a problem hiding this comment.
Nit: This generates some strange code like:
AND (NULL IS NULL
OR query_type IN (NULL))and
AND (['EventsQuery'] IS NULL
OR query_type IN (['EventsQuery']))Since query_types is a python variable, wouldn't it be better to rewrite the entire clause based on its contents?
There was a problem hiding this comment.
yeah let me rewrite that, thanks
raquelmsmith
commented
Nov 22, 2024
| query_app_bytes_read=all_data["teams_with_query_app_bytes_read"].get(team.id, 0), | ||
| query_app_rows_read=all_data["teams_with_query_app_rows_read"].get(team.id, 0), | ||
| query_app_duration_ms=all_data["teams_with_query_app_duration_ms"].get(team.id, 0), | ||
| query_api_bytes_read=all_data["teams_with_query_api_bytes_read"].get(team.id, 0), |
There was a problem hiding this comment.
@patricio-posthog this will likely be your usage key for the API product - query_api_bytes_read
zlwaterfield
approved these changes
Nov 22, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
We want to start billing for API usage against the /query endpoint so we can lift the rate limits on it. First step: measure the usage we are already seeing to this endpoint. But, currently usage reports only capture hogql queries, but we want to charge for any type of query.
Changes
Records usage for any type of query hitting the API.
Renames the usage record key because it's not for hogql specifically any more, but for any type of query hitting /query.
👉 Stay up-to-date with PostHog coding conventions for a smoother review.
Does this work well for both Cloud and self-hosted?
How did you test this code?
Updated the tests and added a new one for api-specific queries.