Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[EDU-5581] [EDU-5582] [EDU-5590] feature: add documentation related to the httpBreakdownMetrics dataset #1348

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

MarianaAguilera
Copy link
Contributor

@MarianaAguilera MarianaAguilera commented Oct 25, 2024

Related issue:

EDU-5581 EDU-5582 EDU-5590

Changes

Add documentation related to the httpBreakdownMetrics dataset:

  • Add query guide EN/PT.
  • Add the link to the Guides page and GQL menu.
  • Add fields to the Metrics Fields file.
  • Add the link to the GraphQL reference.

Additional links

n/a.

| `sum: blockedRequests` | Returns the total number of requests blocked within the specified time range, after applying any filters |
| `groupBy` | Specifies the fields by which the query results should be grouped. Example: `[remoteAddress]` |
| `orderBy` | Specifies the order in which the results should be returned. Examples: `[sum_DESC]`, for descending order, and `[sum_ASC]`, for ascending order |
| `limit` | Specifies the maximum number of results to return. Example: `20` for retrieving the top 20. System maximum: |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you confirm if we have a system max for this field, @brunomrpx ?

@MarianaAguilera MarianaAguilera self-assigned this Oct 25, 2024
@MarianaAguilera MarianaAguilera added the do not merge Waiting for decision or deploy label Oct 25, 2024
@MarianaAguilera MarianaAguilera changed the title [EDU-5581] [EDU-5582] feature: add documentation related to the httpBreakdownMetrics dataset [EDU-5581] [EDU-5582] [EDU-5590] feature: add documentation related to the httpBreakdownMetrics dataset Oct 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do not merge Waiting for decision or deploy
Development

Successfully merging this pull request may close these issues.

4 participants