Skip to content

Commit 12eeb0d

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Deprecate audit logs usage (#1411)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
1 parent 0125916 commit 12eeb0d

File tree

8 files changed

+21
-17
lines changed

8 files changed

+21
-17
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.4",
7-
"regenerated": "2023-04-11 13:58:25.676584",
8-
"spec_repo_commit": "27919220"
7+
"regenerated": "2023-04-11 20:40:39.976360",
8+
"spec_repo_commit": "9b02c84d"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.4",
12-
"regenerated": "2023-04-11 13:58:25.694170",
13-
"spec_repo_commit": "27919220"
12+
"regenerated": "2023-04-11 20:40:39.989307",
13+
"spec_repo_commit": "9b02c84d"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16763,6 +16763,7 @@ components:
1676316763
format: int64
1676416764
type: integer
1676516765
audit_logs_lines_indexed_sum:
16766+
deprecated: true
1676616767
description: Shows the sum of audit logs lines indexed over all hours in
1676716768
the current date for all organizations.
1676816769
format: int64
@@ -17164,6 +17165,7 @@ components:
1716417165
format: int64
1716517166
type: integer
1716617167
audit_logs_lines_indexed_sum:
17168+
deprecated: true
1716717169
description: Shows the sum of all audit logs lines indexed over all hours
1716817170
in the current date for the given org.
1716917171
format: int64
@@ -17568,6 +17570,7 @@ components:
1756817570
format: int64
1756917571
type: integer
1757017572
audit_logs_lines_indexed_agg_sum:
17573+
deprecated: true
1757117574
description: Shows the sum of all audit logs lines indexed over all hours
1757217575
in the current months for all organizations.
1757317576
format: int64
@@ -28073,12 +28076,10 @@ paths:
2807328076
- Usage Metering
2807428077
/api/v1/usage/audit_logs:
2807528078
get:
28079+
deprecated: true
2807628080
description: 'Get hourly usage for audit logs.
2807728081

28078-
**Note:** hourly usage data for all products is now available in the [Get
28079-
hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
28080-
Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/)
28081-
for the associated migration guide.'
28082+
**Note:** This endpoint has been deprecated.'
2808228083
operationId: GetUsageAuditLogs
2808328084
parameters:
2808428085
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`

.generator/schemas/v2/openapi.yaml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23154,8 +23154,7 @@ paths:
2315423154
- description: 'Comma separated list of product families to retrieve. Available
2315523155
families are `all`, `analyzed_logs`,
2315623156

23157-
`application_security`, `audit_logs`, `audit_trail`, `serverless`, `ci_app`,
23158-
`cloud_cost_management`,
23157+
`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`,
2315923158

2316023159
`cspm`, `custom_events`, `cws`, `dbm`, `fargate`,
2316123160

@@ -23168,7 +23167,9 @@ paths:
2316823167
`sds`, `snmp`,
2316923168

2317023169
`synthetics_api`, `synthetics_browser`, `synthetics_parallel_testing`, and
23171-
`timeseries`.'
23170+
`timeseries`.
23171+
23172+
The following product family has been **deprecated**: `audit_logs`.'
2317223173
in: query
2317323174
name: filter[product_families]
2317423175
required: true

src/datadog_api_client/v1/api/usage_metering_api.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1747,10 +1747,10 @@ def get_usage_audit_logs(
17471747
*,
17481748
end_hr: Union[datetime, UnsetType] = unset,
17491749
) -> UsageAuditLogsResponse:
1750-
"""Get hourly usage for audit logs.
1750+
"""Get hourly usage for audit logs. **Deprecated**.
17511751
17521752
Get hourly usage for audit logs.
1753-
**Note:** hourly usage data for all products is now available in the `Get hourly usage by product family API <https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family>`_. Refer to `Migrating from the V1 Hourly Usage APIs to V2 <https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/>`_ for the associated migration guide.
1753+
**Note:** This endpoint has been deprecated.
17541754
17551755
:param start_hr: Datetime in ISO-8601 format, UTC, precise to hour: ``[YYYY-MM-DDThh]`` for usage beginning at this hour.
17561756
:type start_hr: datetime
@@ -1765,6 +1765,7 @@ def get_usage_audit_logs(
17651765
if end_hr is not unset:
17661766
kwargs["end_hr"] = end_hr
17671767

1768+
warnings.warn("get_usage_audit_logs is deprecated", DeprecationWarning, stacklevel=2)
17681769
return self._get_usage_audit_logs_endpoint.call_with_http_info(**kwargs)
17691770

17701771
def get_usage_billable_summary(

src/datadog_api_client/v1/model/usage_summary_date.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ def __init__(
288288
:param appsec_fargate_count_avg: Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current date for all organizations.
289289
:type appsec_fargate_count_avg: int, optional
290290
291-
:param audit_logs_lines_indexed_sum: Shows the sum of audit logs lines indexed over all hours in the current date for all organizations.
291+
:param audit_logs_lines_indexed_sum: Shows the sum of audit logs lines indexed over all hours in the current date for all organizations. **Deprecated**.
292292
:type audit_logs_lines_indexed_sum: int, optional
293293
294294
:param audit_trail_enabled_hwm: Shows the number of organizations that had Audit Trail enabled in the current date.

src/datadog_api_client/v1/model/usage_summary_date_org.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ def __init__(
287287
:param appsec_fargate_count_avg: Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current months for the given org.
288288
:type appsec_fargate_count_avg: int, optional
289289
290-
:param audit_logs_lines_indexed_sum: Shows the sum of all audit logs lines indexed over all hours in the current date for the given org.
290+
:param audit_logs_lines_indexed_sum: Shows the sum of all audit logs lines indexed over all hours in the current date for the given org. **Deprecated**.
291291
:type audit_logs_lines_indexed_sum: int, optional
292292
293293
:param audit_trail_enabled_hwm: Shows whether Audit Trail is enabled for the current date for the given org.

src/datadog_api_client/v1/model/usage_summary_response.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ def __init__(
317317
:param appsec_fargate_count_avg_sum: Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current months for all organizations.
318318
:type appsec_fargate_count_avg_sum: int, optional
319319
320-
:param audit_logs_lines_indexed_agg_sum: Shows the sum of all audit logs lines indexed over all hours in the current months for all organizations.
320+
:param audit_logs_lines_indexed_agg_sum: Shows the sum of all audit logs lines indexed over all hours in the current months for all organizations. **Deprecated**.
321321
:type audit_logs_lines_indexed_agg_sum: int, optional
322322
323323
:param audit_trail_enabled_hwm_sum: Shows the total number of organizations that had Audit Trail enabled over a specific number of months.

src/datadog_api_client/v2/api/usage_metering_api.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -424,12 +424,13 @@ def get_hourly_usage(
424424
:param filter_timestamp_start: Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour.
425425
:type filter_timestamp_start: datetime
426426
:param filter_product_families: Comma separated list of product families to retrieve. Available families are ``all`` , ``analyzed_logs`` ,
427-
``application_security`` , ``audit_logs`` , ``audit_trail`` , ``serverless`` , ``ci_app`` , ``cloud_cost_management`` ,
427+
``application_security`` , ``audit_trail`` , ``serverless`` , ``ci_app`` , ``cloud_cost_management`` ,
428428
``cspm`` , ``custom_events`` , ``cws`` , ``dbm`` , ``fargate`` ,
429429
``infra_hosts`` , ``incident_management`` , ``indexed_logs`` , ``indexed_spans`` , ``ingested_spans`` , ``iot`` ,
430430
``lambda_traced_invocations`` , ``logs`` , ``network_flows`` , ``network_hosts`` , ``observability_pipelines`` ,
431431
``online_archive`` , ``profiling`` , ``rum`` , ``rum_browser_sessions`` , ``rum_mobile_sessions`` , ``sds`` , ``snmp`` ,
432432
``synthetics_api`` , ``synthetics_browser`` , ``synthetics_parallel_testing`` , and ``timeseries``.
433+
The following product family has been **deprecated** : ``audit_logs``.
433434
:type filter_product_families: str
434435
:param filter_timestamp_end: Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour.
435436
:type filter_timestamp_end: datetime, optional

0 commit comments

Comments
 (0)