Skip to content

Documenting Logs Aggregate API limits (group-by + paging) #1283

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Aug 17, 2023
Merged

Documenting Logs Aggregate API limits (group-by + paging) #1283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.5",
"regenerated": "2023-08-17 17:20:40.199652",
"spec_repo_commit": "357af604"
"regenerated": "2023-08-17 19:37:29.403596",
"spec_repo_commit": "bb17cef0"
},
"v2": {
"apigentools_version": "1.6.5",
"regenerated": "2023-08-17 17:20:40.214370",
"spec_repo_commit": "357af604"
"regenerated": "2023-08-17 19:37:29.416739",
"spec_repo_commit": "bb17cef0"
}
}
}
15 changes: 10 additions & 5 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7844,7 +7844,8 @@ components:
description: Paging settings
properties:
cursor:
description: The returned paging point to use to get the next results
description: 'The returned paging point to use to get the next results.
Note: at most 1000 results can be paged.'
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
type: string
type: object
Expand Down Expand Up @@ -8329,7 +8330,11 @@ components:
$ref: '#/components/schemas/LogsGroupByHistogram'
limit:
default: 10
description: The maximum buckets to return for this group by
description: 'The maximum buckets to return for this group by. Note: at
most 10000 buckets are allowed.

If grouping by multiple facets, the product of limits must not exceed
10000.'
format: int64
type: integer
missing:
Expand All @@ -8344,7 +8349,7 @@ components:
LogsGroupByHistogram:
description: 'Used to perform a histogram computation (only for measure facets).

Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.'
Note: at most 100 buckets are allowed, the number of buckets is (max - min)/interval.'
properties:
interval:
description: The bin size of the histogram buckets
Expand Down Expand Up @@ -8722,7 +8727,7 @@ components:
LogsQueryOptions:
description: 'Global query options that are used during the query.

Note: You should only supply timezone or time offset but not both otherwise
Note: you should supply either timezone or time offset, but not both. Otherwise,
the query will fail.'
properties:
timeOffset:
Expand Down Expand Up @@ -8766,7 +8771,7 @@ components:
properties:
after:
description: 'The cursor to use to get the next results, if any. To make
the next request, use the same.
the next request, use the same

parameters with the addition of the `page[cursor]`.'
example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
Expand Down
2 changes: 1 addition & 1 deletion packages/datadog-api-client-v2/models/LogsAggregateRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export class LogsAggregateRequest {
"groupBy"?: Array<LogsGroupBy>;
/**
* Global query options that are used during the query.
* Note: You should only supply timezone or time offset but not both otherwise the query will fail.
* Note: you should supply either timezone or time offset, but not both. Otherwise, the query will fail.
*/
"options"?: LogsQueryOptions;
/**
Expand Down
2 changes: 1 addition & 1 deletion packages/datadog-api-client-v2/models/LogsAggregateRequestPage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";
*/
export class LogsAggregateRequestPage {
/**
* The returned paging point to use to get the next results
* The returned paging point to use to get the next results. Note: at most 1000 results can be paged.
*/
"cursor"?: string;

Expand Down
5 changes: 3 additions & 2 deletions packages/datadog-api-client-v2/models/LogsGroupBy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,12 @@ export class LogsGroupBy {
"facet": string;
/**
* Used to perform a histogram computation (only for measure facets).
* Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.
* Note: at most 100 buckets are allowed, the number of buckets is (max - min)/interval.
*/
"histogram"?: LogsGroupByHistogram;
/**
* The maximum buckets to return for this group by
* The maximum buckets to return for this group by. Note: at most 10000 buckets are allowed.
* If grouping by multiple facets, the product of limits must not exceed 10000.
*/
"limit"?: number;
/**
Expand Down
2 changes: 1 addition & 1 deletion packages/datadog-api-client-v2/models/LogsGroupByHistogram.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";

/**
* Used to perform a histogram computation (only for measure facets).
* Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.
* Note: at most 100 buckets are allowed, the number of buckets is (max - min)/interval.
*/
export class LogsGroupByHistogram {
/**
Expand Down
2 changes: 1 addition & 1 deletion packages/datadog-api-client-v2/models/LogsListRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export class LogsListRequest {
"filter"?: LogsQueryFilter;
/**
* Global query options that are used during the query.
* Note: You should only supply timezone or time offset but not both otherwise the query will fail.
* Note: you should supply either timezone or time offset, but not both. Otherwise, the query will fail.
*/
"options"?: LogsQueryOptions;
/**
Expand Down
2 changes: 1 addition & 1 deletion packages/datadog-api-client-v2/models/LogsQueryOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";

/**
* Global query options that are used during the query.
* Note: You should only supply timezone or time offset but not both otherwise the query will fail.
* Note: you should supply either timezone or time offset, but not both. Otherwise, the query will fail.
*/
export class LogsQueryOptions {
/**
Expand Down
2 changes: 1 addition & 1 deletion packages/datadog-api-client-v2/models/LogsResponseMetadataPage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";
*/
export class LogsResponseMetadataPage {
/**
* The cursor to use to get the next results, if any. To make the next request, use the same.
* The cursor to use to get the next results, if any. To make the next request, use the same
* parameters with the addition of the `page[cursor]`.
*/
"after"?: string;
Expand Down