Skip to content

Update documentation for App Sec SCA #1710

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

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2024-07-26 18:27:50.250491",
"spec_repo_commit": "7e92b530"
"regenerated": "2024-07-26 19:06:12.505492",
"spec_repo_commit": "44cf4afe"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-07-26 18:27:50.268852",
"spec_repo_commit": "7e92b530"
"regenerated": "2024-07-26 19:06:12.524483",
"spec_repo_commit": "44cf4afe"
}
}
}
48 changes: 48 additions & 0 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4216,6 +4216,7 @@ components:
- profiled_host_usage
- rum_browser_mobile_sessions_usage
- rum_replay_sessions_usage
- sca_fargate_usage
- sds_scanned_bytes_usage
- serverless_apps_usage
- siem_analyzed_logs_add_on_usage
Expand Down Expand Up @@ -4288,6 +4289,7 @@ components:
- PROFILED_HOST_USAGE
- RUM_BROWSER_MOBILE_SESSIONS_USAGE
- RUM_REPLAY_SESSIONS_USAGE
- SCA_FARGATE_USAGE
- SDS_SCANNED_BYTES_USAGE
- SERVERLESS_APPS_USAGE
- SIEM_ANALYZED_LOGS_ADD_ON_USAGE
Expand Down Expand Up @@ -7991,6 +7993,8 @@ components:
- siem_ingested_bytes_percentage
- workflow_executions_usage
- workflow_executions_percentage
- sca_fargate_usage
- sca_fargate_percentage
- '*'
type: string
x-enum-varnames:
Expand Down Expand Up @@ -8130,6 +8134,8 @@ components:
- SIEM_INGESTED_BYTES_PERCENTAGE
- WORKFLOW_EXECUTIONS_USAGE
- WORKFLOW_EXECUTIONS_PERCENTAGE
- SCA_FARGATE_USAGE
- SCA_FARGATE_PERCENTAGE
- ALL
MonthlyUsageAttributionValues:
description: Fields in Usage Summary by tag(s).
Expand Down Expand Up @@ -8639,6 +8645,16 @@ components:
description: The total RUM Session Replay usage by tag(s).
format: double
type: number
sca_fargate_percentage:
description: The percentage of Software Composition Analysis Fargate task
usage by tag(s).
format: double
type: number
sca_fargate_usage:
description: The total Software Composition Analysis Fargate task usage
by tag(s).
format: double
type: number
sds_scanned_bytes_percentage:
description: The percentage of Sensitive Data Scanner usage by tag(s).
format: double
Expand Down Expand Up @@ -19256,6 +19272,17 @@ components:
1st, 2024).
format: int64
type: integer
sca_fargate_count_avg:
description: Shows the average of all Software Composition Analysis Fargate
tasks over all hours in the current date for the given org.
format: int64
type: integer
sca_fargate_count_hwm:
description: Shows the sum of the high-water marks of all Software Composition
Analysis Fargate tasks over all hours in the current date for the given
org.
format: int64
type: integer
sds_apm_scanned_bytes_sum:
description: Sum of all APM bytes scanned with sensitive data scanner over
all hours in the current date for all organizations.
Expand Down Expand Up @@ -19964,6 +19991,17 @@ components:
1st, 2024).
format: int64
type: integer
sca_fargate_count_avg:
description: Shows the average of all Software Composition Analysis Fargate
tasks over all hours in the current date for the given org.
format: int64
type: integer
sca_fargate_count_hwm:
description: Shows the sum of the high-water marks of all Software Composition
Analysis Fargate tasks over all hours in the current date for the given
org.
format: int64
type: integer
sds_apm_scanned_bytes_sum:
description: Sum of all APM bytes scanned with sensitive data scanner over
all hours in the current date for the given org.
Expand Down Expand Up @@ -20707,6 +20745,16 @@ components:
October 1st, 2024).
format: int64
type: integer
sca_fargate_count_avg_sum:
description: Shows the average of all Software Composition Analysis Fargate
tasks over all hours in the current months for all organizations.
format: int64
type: integer
sca_fargate_count_hwm_sum:
description: Shows the sum of the high-water marks of all Software Composition
Analysis Fargate tasks over all hours in the current months for all organizations.
format: int64
type: integer
sds_apm_scanned_bytes_sum:
description: Sum of all APM bytes scanned with sensitive data scanner in
the current month for all organizations.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ export type HourlyUsageAttributionUsageType =
| typeof PROFILED_HOST_USAGE
| typeof RUM_BROWSER_MOBILE_SESSIONS_USAGE
| typeof RUM_REPLAY_SESSIONS_USAGE
| typeof SCA_FARGATE_USAGE
| typeof SDS_SCANNED_BYTES_USAGE
| typeof SERVERLESS_APPS_USAGE
| typeof SIEM_ANALYZED_LOGS_ADD_ON_USAGE
Expand Down Expand Up @@ -152,6 +153,7 @@ export const PROFILED_HOST_USAGE = "profiled_host_usage";
export const RUM_BROWSER_MOBILE_SESSIONS_USAGE =
"rum_browser_mobile_sessions_usage";
export const RUM_REPLAY_SESSIONS_USAGE = "rum_replay_sessions_usage";
export const SCA_FARGATE_USAGE = "sca_fargate_usage";
export const SDS_SCANNED_BYTES_USAGE = "sds_scanned_bytes_usage";
export const SERVERLESS_APPS_USAGE = "serverless_apps_usage";
export const SIEM_ANALYZED_LOGS_ADD_ON_USAGE =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,8 @@ export type MonthlyUsageAttributionSupportedMetrics =
| typeof SIEM_INGESTED_BYTES_PERCENTAGE
| typeof WORKFLOW_EXECUTIONS_USAGE
| typeof WORKFLOW_EXECUTIONS_PERCENTAGE
| typeof SCA_FARGATE_USAGE
| typeof SCA_FARGATE_PERCENTAGE
| typeof ALL
| UnparsedObject;
export const API_USAGE = "api_usage";
Expand Down Expand Up @@ -312,4 +314,6 @@ export const SIEM_INGESTED_BYTES_USAGE = "siem_ingested_bytes_usage";
export const SIEM_INGESTED_BYTES_PERCENTAGE = "siem_ingested_bytes_percentage";
export const WORKFLOW_EXECUTIONS_USAGE = "workflow_executions_usage";
export const WORKFLOW_EXECUTIONS_PERCENTAGE = "workflow_executions_percentage";
export const SCA_FARGATE_USAGE = "sca_fargate_usage";
export const SCA_FARGATE_PERCENTAGE = "sca_fargate_percentage";
export const ALL = "*";
Original file line number Diff line number Diff line change
Expand Up @@ -490,6 +490,14 @@ export class MonthlyUsageAttributionValues {
* The total RUM Session Replay usage by tag(s).
*/
"rumReplaySessionsUsage"?: number;
/**
* The percentage of Software Composition Analysis Fargate task usage by tag(s).
*/
"scaFargatePercentage"?: number;
/**
* The total Software Composition Analysis Fargate task usage by tag(s).
*/
"scaFargateUsage"?: number;
/**
* The percentage of Sensitive Data Scanner usage by tag(s).
*/
Expand Down Expand Up @@ -1171,6 +1179,16 @@ export class MonthlyUsageAttributionValues {
type: "number",
format: "double",
},
scaFargatePercentage: {
baseName: "sca_fargate_percentage",
type: "number",
format: "double",
},
scaFargateUsage: {
baseName: "sca_fargate_usage",
type: "number",
format: "double",
},
sdsScannedBytesPercentage: {
baseName: "sds_scanned_bytes_percentage",
type: "number",
Expand Down
3 changes: 3 additions & 0 deletions packages/datadog-api-client-v1/models/ObjectSerializer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -831,6 +831,7 @@ const enumsMap: { [key: string]: any[] } = {
"profiled_host_usage",
"rum_browser_mobile_sessions_usage",
"rum_replay_sessions_usage",
"sca_fargate_usage",
"sds_scanned_bytes_usage",
"serverless_apps_usage",
"siem_analyzed_logs_add_on_usage",
Expand Down Expand Up @@ -1104,6 +1105,8 @@ const enumsMap: { [key: string]: any[] } = {
"siem_ingested_bytes_percentage",
"workflow_executions_usage",
"workflow_executions_percentage",
"sca_fargate_usage",
"sca_fargate_percentage",
"*",
],
NoteWidgetDefinitionType: ["note"],
Expand Down
18 changes: 18 additions & 0 deletions packages/datadog-api-client-v1/models/UsageSummaryDate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -443,6 +443,14 @@ export class UsageSummaryDate {
* Shows the sum of all browser and mobile RUM units over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).
*/
"rumUnitsSum"?: number;
/**
* Shows the average of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org.
*/
"scaFargateCountAvg"?: number;
/**
* Shows the sum of the high-water marks of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org.
*/
"scaFargateCountHwm"?: number;
/**
* Sum of all APM bytes scanned with sensitive data scanner over all hours in the current date for all organizations.
*/
Expand Down Expand Up @@ -1075,6 +1083,16 @@ export class UsageSummaryDate {
type: "number",
format: "int64",
},
scaFargateCountAvg: {
baseName: "sca_fargate_count_avg",
type: "number",
format: "int64",
},
scaFargateCountHwm: {
baseName: "sca_fargate_count_hwm",
type: "number",
format: "int64",
},
sdsApmScannedBytesSum: {
baseName: "sds_apm_scanned_bytes_sum",
type: "number",
Expand Down
18 changes: 18 additions & 0 deletions packages/datadog-api-client-v1/models/UsageSummaryDateOrg.ts
Original file line number Diff line number Diff line change
Expand Up @@ -466,6 +466,14 @@ export class UsageSummaryDateOrg {
* Shows the sum of all browser and mobile RUM units over all hours in the current date for the given org (To be deprecated on October 1st, 2024).
*/
"rumUnitsSum"?: number;
/**
* Shows the average of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org.
*/
"scaFargateCountAvg"?: number;
/**
* Shows the sum of the high-water marks of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org.
*/
"scaFargateCountHwm"?: number;
/**
* Sum of all APM bytes scanned with sensitive data scanner over all hours in the current date for the given org.
*/
Expand Down Expand Up @@ -1123,6 +1131,16 @@ export class UsageSummaryDateOrg {
type: "number",
format: "int64",
},
scaFargateCountAvg: {
baseName: "sca_fargate_count_avg",
type: "number",
format: "int64",
},
scaFargateCountHwm: {
baseName: "sca_fargate_count_hwm",
type: "number",
format: "int64",
},
sdsApmScannedBytesSum: {
baseName: "sds_apm_scanned_bytes_sum",
type: "number",
Expand Down
18 changes: 18 additions & 0 deletions packages/datadog-api-client-v1/models/UsageSummaryResponse.ts
Original file line number Diff line number Diff line change
Expand Up @@ -480,6 +480,14 @@ export class UsageSummaryResponse {
* Shows the sum of all browser and mobile RUM units over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).
*/
"rumUnitsAggSum"?: number;
/**
* Shows the average of all Software Composition Analysis Fargate tasks over all hours in the current months for all organizations.
*/
"scaFargateCountAvgSum"?: number;
/**
* Shows the sum of the high-water marks of all Software Composition Analysis Fargate tasks over all hours in the current months for all organizations.
*/
"scaFargateCountHwmSum"?: number;
/**
* Sum of all APM bytes scanned with sensitive data scanner in the current month for all organizations.
*/
Expand Down Expand Up @@ -1165,6 +1173,16 @@ export class UsageSummaryResponse {
type: "number",
format: "int64",
},
scaFargateCountAvgSum: {
baseName: "sca_fargate_count_avg_sum",
type: "number",
format: "int64",
},
scaFargateCountHwmSum: {
baseName: "sca_fargate_count_hwm_sum",
type: "number",
format: "int64",
},
sdsApmScannedBytesSum: {
baseName: "sds_apm_scanned_bytes_sum",
type: "number",
Expand Down
Loading