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

Update documentation for Cloud SIEM Analyzed Logs #2070

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 17:47:54.428966",
"spec_repo_commit": "187cfa14"
"regenerated": "2024-07-26 18:27:50.289131",
"spec_repo_commit": "7e92b530"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-07-26 17:47:54.446487",
"spec_repo_commit": "187cfa14"
"regenerated": "2024-07-26 18:27:50.306427",
"spec_repo_commit": "7e92b530"
}
}
}
30 changes: 30 additions & 0 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4218,6 +4218,7 @@ components:
- rum_replay_sessions_usage
- sds_scanned_bytes_usage
- serverless_apps_usage
- siem_analyzed_logs_add_on_usage
- siem_ingested_bytes_usage
- snmp_usage
- universal_service_monitoring_usage
Expand Down Expand Up @@ -4289,6 +4290,7 @@ components:
- RUM_REPLAY_SESSIONS_USAGE
- SDS_SCANNED_BYTES_USAGE
- SERVERLESS_APPS_USAGE
- SIEM_ANALYZED_LOGS_ADD_ON_USAGE
- SIEM_INGESTED_BYTES_USAGE
- SNMP_USAGE
- UNIVERSAL_SERVICE_MONITORING_USAGE
Expand Down Expand Up @@ -7983,6 +7985,8 @@ components:
- rum_browser_mobile_sessions_percentage
- ingested_spans_bytes_usage
- ingested_spans_bytes_percentage
- siem_analyzed_logs_add_on_usage
- siem_analyzed_logs_add_on_percentage
- siem_ingested_bytes_usage
- siem_ingested_bytes_percentage
- workflow_executions_usage
Expand Down Expand Up @@ -8120,6 +8124,8 @@ components:
- RUM_BROWSER_MOBILE_SESSIONS_PERCENTAGE
- INGESTED_SPANS_BYTES_USAGE
- INGESTED_SPANS_BYTES_PERCENTAGE
- SIEM_ANALYZED_LOGS_ADD_ON_USAGE
- SIEM_ANALYZED_LOGS_ADD_ON_PERCENTAGE
- SIEM_INGESTED_BYTES_USAGE
- SIEM_INGESTED_BYTES_PERCENTAGE
- WORKFLOW_EXECUTIONS_USAGE
Expand Down Expand Up @@ -8649,6 +8655,15 @@ components:
description: The total Serverless Apps usage by tag(s).
format: double
type: number
siem_analyzed_logs_add_on_percentage:
description: The percentage of log events analyzed by Cloud SIEM usage by
tag(s).
format: double
type: number
siem_analyzed_logs_add_on_usage:
description: The log events analyzed by Cloud SIEM usage by tag(s).
format: double
type: number
siem_ingested_bytes_percentage:
description: The percentage of SIEM usage by tag(s).
format: double
Expand Down Expand Up @@ -19282,6 +19297,11 @@ components:
and Google Cloud for the given date and given org.
format: int64
type: integer
siem_analyzed_logs_add_on_count_sum:
description: Shows the sum of all log events analyzed by Cloud SIEM over
all hours in the current date for the given org.
format: int64
type: integer
synthetics_browser_check_calls_count_sum:
description: Shows the sum of all Synthetic browser tests over all hours
in the current date for all organizations.
Expand Down Expand Up @@ -19985,6 +20005,11 @@ components:
and Google Cloud for the given date and given org.
format: int64
type: integer
siem_analyzed_logs_add_on_count_sum:
description: Shows the sum of all log events analyzed by Cloud SIEM over
all hours in the current date for the given org.
format: int64
type: integer
synthetics_browser_check_calls_count_sum:
description: Shows the sum of all Synthetic browser tests over all hours
in the current date for the given org.
Expand Down Expand Up @@ -20723,6 +20748,11 @@ components:
Google Cloud in the current month for all organizations.
format: int64
type: integer
siem_analyzed_logs_add_on_count_agg_sum:
description: Shows the sum of all log events analyzed by Cloud SIEM over
all hours in the current month for all organizations.
format: int64
type: integer
start_date:
description: Shows the first date of usage in the current month for all
organizations.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class HourlyUsageAttributionUsageType(ModelSimple):
"""
Supported products for hourly usage attribution requests.

:param value: Must be one of ["api_usage", "apm_fargate_usage", "apm_host_usage", "apm_usm_usage", "appsec_fargate_usage", "appsec_usage", "asm_serverless_traced_invocations_usage", "asm_serverless_traced_invocations_percentage", "browser_usage", "ci_pipeline_indexed_spans_usage", "ci_test_indexed_spans_usage", "ci_visibility_itr_usage", "cloud_siem_usage", "container_excl_agent_usage", "container_usage", "cspm_containers_usage", "cspm_hosts_usage", "custom_event_usage", "custom_ingested_timeseries_usage", "custom_timeseries_usage", "cws_containers_usage", "cws_hosts_usage", "dbm_hosts_usage", "dbm_queries_usage", "error_tracking_usage", "error_tracking_percentage", "estimated_indexed_logs_usage", "estimated_indexed_spans_usage", "estimated_ingested_logs_usage", "estimated_ingested_spans_usage", "estimated_rum_sessions_usage", "fargate_usage", "functions_usage", "incident_management_monthly_active_users_usage", "indexed_spans_usage", "infra_host_usage", "ingested_logs_bytes_usage", "ingested_spans_bytes_usage", "invocations_usage", "lambda_traced_invocations_usage", "logs_indexed_15day_usage", "logs_indexed_180day_usage", "logs_indexed_1day_usage", "logs_indexed_30day_usage", "logs_indexed_360day_usage", "logs_indexed_3day_usage", "logs_indexed_45day_usage", "logs_indexed_60day_usage", "logs_indexed_7day_usage", "logs_indexed_90day_usage", "logs_indexed_custom_retention_usage", "mobile_app_testing_usage", "ndm_netflow_usage", "npm_host_usage", "obs_pipeline_bytes_usage", "obs_pipelines_vcpu_usage", "online_archive_usage", "profiled_container_usage", "profiled_fargate_usage", "profiled_host_usage", "rum_browser_mobile_sessions_usage", "rum_replay_sessions_usage", "sds_scanned_bytes_usage", "serverless_apps_usage", "siem_ingested_bytes_usage", "snmp_usage", "universal_service_monitoring_usage", "vuln_management_hosts_usage", "workflow_executions_usage"].
:param value: Must be one of ["api_usage", "apm_fargate_usage", "apm_host_usage", "apm_usm_usage", "appsec_fargate_usage", "appsec_usage", "asm_serverless_traced_invocations_usage", "asm_serverless_traced_invocations_percentage", "browser_usage", "ci_pipeline_indexed_spans_usage", "ci_test_indexed_spans_usage", "ci_visibility_itr_usage", "cloud_siem_usage", "container_excl_agent_usage", "container_usage", "cspm_containers_usage", "cspm_hosts_usage", "custom_event_usage", "custom_ingested_timeseries_usage", "custom_timeseries_usage", "cws_containers_usage", "cws_hosts_usage", "dbm_hosts_usage", "dbm_queries_usage", "error_tracking_usage", "error_tracking_percentage", "estimated_indexed_logs_usage", "estimated_indexed_spans_usage", "estimated_ingested_logs_usage", "estimated_ingested_spans_usage", "estimated_rum_sessions_usage", "fargate_usage", "functions_usage", "incident_management_monthly_active_users_usage", "indexed_spans_usage", "infra_host_usage", "ingested_logs_bytes_usage", "ingested_spans_bytes_usage", "invocations_usage", "lambda_traced_invocations_usage", "logs_indexed_15day_usage", "logs_indexed_180day_usage", "logs_indexed_1day_usage", "logs_indexed_30day_usage", "logs_indexed_360day_usage", "logs_indexed_3day_usage", "logs_indexed_45day_usage", "logs_indexed_60day_usage", "logs_indexed_7day_usage", "logs_indexed_90day_usage", "logs_indexed_custom_retention_usage", "mobile_app_testing_usage", "ndm_netflow_usage", "npm_host_usage", "obs_pipeline_bytes_usage", "obs_pipelines_vcpu_usage", "online_archive_usage", "profiled_container_usage", "profiled_fargate_usage", "profiled_host_usage", "rum_browser_mobile_sessions_usage", "rum_replay_sessions_usage", "sds_scanned_bytes_usage", "serverless_apps_usage", "siem_analyzed_logs_add_on_usage", "siem_ingested_bytes_usage", "snmp_usage", "universal_service_monitoring_usage", "vuln_management_hosts_usage", "workflow_executions_usage"].
:type value: str
"""

Expand Down Expand Up @@ -85,6 +85,7 @@ class HourlyUsageAttributionUsageType(ModelSimple):
"rum_replay_sessions_usage",
"sds_scanned_bytes_usage",
"serverless_apps_usage",
"siem_analyzed_logs_add_on_usage",
"siem_ingested_bytes_usage",
"snmp_usage",
"universal_service_monitoring_usage",
Expand Down Expand Up @@ -155,6 +156,7 @@ class HourlyUsageAttributionUsageType(ModelSimple):
RUM_REPLAY_SESSIONS_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
SDS_SCANNED_BYTES_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
SERVERLESS_APPS_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
SIEM_ANALYZED_LOGS_ADD_ON_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
SIEM_INGESTED_BYTES_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
SNMP_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
UNIVERSAL_SERVICE_MONITORING_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
Expand Down Expand Up @@ -264,6 +266,9 @@ def openapi_types(_):
HourlyUsageAttributionUsageType.RUM_REPLAY_SESSIONS_USAGE = HourlyUsageAttributionUsageType("rum_replay_sessions_usage")
HourlyUsageAttributionUsageType.SDS_SCANNED_BYTES_USAGE = HourlyUsageAttributionUsageType("sds_scanned_bytes_usage")
HourlyUsageAttributionUsageType.SERVERLESS_APPS_USAGE = HourlyUsageAttributionUsageType("serverless_apps_usage")
HourlyUsageAttributionUsageType.SIEM_ANALYZED_LOGS_ADD_ON_USAGE = HourlyUsageAttributionUsageType(
"siem_analyzed_logs_add_on_usage"
)
HourlyUsageAttributionUsageType.SIEM_INGESTED_BYTES_USAGE = HourlyUsageAttributionUsageType("siem_ingested_bytes_usage")
HourlyUsageAttributionUsageType.SNMP_USAGE = HourlyUsageAttributionUsageType("snmp_usage")
HourlyUsageAttributionUsageType.UNIVERSAL_SERVICE_MONITORING_USAGE = HourlyUsageAttributionUsageType(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class MonthlyUsageAttributionSupportedMetrics(ModelSimple):
"""
Supported metrics for monthly usage attribution requests.

:param value: Must be one of ["api_usage", "api_percentage", "apm_fargate_usage", "apm_fargate_percentage", "appsec_fargate_usage", "appsec_fargate_percentage", "apm_host_usage", "apm_host_percentage", "apm_usm_usage", "apm_usm_percentage", "appsec_usage", "appsec_percentage", "asm_serverless_traced_invocations_usage", "asm_serverless_traced_invocations_percentage", "browser_usage", "browser_percentage", "ci_visibility_itr_usage", "ci_visibility_itr_percentage", "cloud_siem_usage", "cloud_siem_percentage", "container_excl_agent_usage", "container_excl_agent_percentage", "container_usage", "container_percentage", "cspm_containers_percentage", "cspm_containers_usage", "cspm_hosts_percentage", "cspm_hosts_usage", "custom_timeseries_usage", "custom_timeseries_percentage", "custom_ingested_timeseries_usage", "custom_ingested_timeseries_percentage", "cws_containers_percentage", "cws_containers_usage", "cws_hosts_percentage", "cws_hosts_usage", "dbm_hosts_percentage", "dbm_hosts_usage", "dbm_queries_percentage", "dbm_queries_usage", "error_tracking_usage", "error_tracking_percentage", "estimated_indexed_logs_usage", "estimated_indexed_logs_percentage", "estimated_ingested_logs_usage", "estimated_ingested_logs_percentage", "estimated_indexed_spans_usage", "estimated_indexed_spans_percentage", "estimated_ingested_spans_usage", "estimated_ingested_spans_percentage", "fargate_usage", "fargate_percentage", "functions_usage", "functions_percentage", "incident_management_monthly_active_users_usage", "incident_management_monthly_active_users_percentage", "infra_host_usage", "infra_host_percentage", "invocations_usage", "invocations_percentage", "lambda_traced_invocations_usage", "lambda_traced_invocations_percentage", "mobile_app_testing_percentage", "mobile_app_testing_usage", "ndm_netflow_usage", "ndm_netflow_percentage", "npm_host_usage", "npm_host_percentage", "obs_pipeline_bytes_usage", "obs_pipeline_bytes_percentage", "obs_pipelines_vcpu_usage", "obs_pipelines_vcpu_percentage", "online_archive_usage", "online_archive_percentage", "profiled_container_usage", "profiled_container_percentage", "profiled_fargate_usage", "profiled_fargate_percentage", "profiled_host_usage", "profiled_host_percentage", "serverless_apps_usage", "serverless_apps_percentage", "snmp_usage", "snmp_percentage", "estimated_rum_sessions_usage", "estimated_rum_sessions_percentage", "universal_service_monitoring_usage", "universal_service_monitoring_percentage", "vuln_management_hosts_usage", "vuln_management_hosts_percentage", "sds_scanned_bytes_usage", "sds_scanned_bytes_percentage", "ci_test_indexed_spans_usage", "ci_test_indexed_spans_percentage", "ingested_logs_bytes_usage", "ingested_logs_bytes_percentage", "ci_pipeline_indexed_spans_usage", "ci_pipeline_indexed_spans_percentage", "indexed_spans_usage", "indexed_spans_percentage", "custom_event_usage", "custom_event_percentage", "logs_indexed_custom_retention_usage", "logs_indexed_custom_retention_percentage", "logs_indexed_360day_usage", "logs_indexed_360day_percentage", "logs_indexed_180day_usage", "logs_indexed_180day_percentage", "logs_indexed_90day_usage", "logs_indexed_90day_percentage", "logs_indexed_60day_usage", "logs_indexed_60day_percentage", "logs_indexed_45day_usage", "logs_indexed_45day_percentage", "logs_indexed_30day_usage", "logs_indexed_30day_percentage", "logs_indexed_15day_usage", "logs_indexed_15day_percentage", "logs_indexed_7day_usage", "logs_indexed_7day_percentage", "logs_indexed_3day_usage", "logs_indexed_3day_percentage", "logs_indexed_1day_usage", "logs_indexed_1day_percentage", "rum_replay_sessions_usage", "rum_replay_sessions_percentage", "rum_browser_mobile_sessions_usage", "rum_browser_mobile_sessions_percentage", "ingested_spans_bytes_usage", "ingested_spans_bytes_percentage", "siem_ingested_bytes_usage", "siem_ingested_bytes_percentage", "workflow_executions_usage", "workflow_executions_percentage", "*"].
:param value: Must be one of ["api_usage", "api_percentage", "apm_fargate_usage", "apm_fargate_percentage", "appsec_fargate_usage", "appsec_fargate_percentage", "apm_host_usage", "apm_host_percentage", "apm_usm_usage", "apm_usm_percentage", "appsec_usage", "appsec_percentage", "asm_serverless_traced_invocations_usage", "asm_serverless_traced_invocations_percentage", "browser_usage", "browser_percentage", "ci_visibility_itr_usage", "ci_visibility_itr_percentage", "cloud_siem_usage", "cloud_siem_percentage", "container_excl_agent_usage", "container_excl_agent_percentage", "container_usage", "container_percentage", "cspm_containers_percentage", "cspm_containers_usage", "cspm_hosts_percentage", "cspm_hosts_usage", "custom_timeseries_usage", "custom_timeseries_percentage", "custom_ingested_timeseries_usage", "custom_ingested_timeseries_percentage", "cws_containers_percentage", "cws_containers_usage", "cws_hosts_percentage", "cws_hosts_usage", "dbm_hosts_percentage", "dbm_hosts_usage", "dbm_queries_percentage", "dbm_queries_usage", "error_tracking_usage", "error_tracking_percentage", "estimated_indexed_logs_usage", "estimated_indexed_logs_percentage", "estimated_ingested_logs_usage", "estimated_ingested_logs_percentage", "estimated_indexed_spans_usage", "estimated_indexed_spans_percentage", "estimated_ingested_spans_usage", "estimated_ingested_spans_percentage", "fargate_usage", "fargate_percentage", "functions_usage", "functions_percentage", "incident_management_monthly_active_users_usage", "incident_management_monthly_active_users_percentage", "infra_host_usage", "infra_host_percentage", "invocations_usage", "invocations_percentage", "lambda_traced_invocations_usage", "lambda_traced_invocations_percentage", "mobile_app_testing_percentage", "mobile_app_testing_usage", "ndm_netflow_usage", "ndm_netflow_percentage", "npm_host_usage", "npm_host_percentage", "obs_pipeline_bytes_usage", "obs_pipeline_bytes_percentage", "obs_pipelines_vcpu_usage", "obs_pipelines_vcpu_percentage", "online_archive_usage", "online_archive_percentage", "profiled_container_usage", "profiled_container_percentage", "profiled_fargate_usage", "profiled_fargate_percentage", "profiled_host_usage", "profiled_host_percentage", "serverless_apps_usage", "serverless_apps_percentage", "snmp_usage", "snmp_percentage", "estimated_rum_sessions_usage", "estimated_rum_sessions_percentage", "universal_service_monitoring_usage", "universal_service_monitoring_percentage", "vuln_management_hosts_usage", "vuln_management_hosts_percentage", "sds_scanned_bytes_usage", "sds_scanned_bytes_percentage", "ci_test_indexed_spans_usage", "ci_test_indexed_spans_percentage", "ingested_logs_bytes_usage", "ingested_logs_bytes_percentage", "ci_pipeline_indexed_spans_usage", "ci_pipeline_indexed_spans_percentage", "indexed_spans_usage", "indexed_spans_percentage", "custom_event_usage", "custom_event_percentage", "logs_indexed_custom_retention_usage", "logs_indexed_custom_retention_percentage", "logs_indexed_360day_usage", "logs_indexed_360day_percentage", "logs_indexed_180day_usage", "logs_indexed_180day_percentage", "logs_indexed_90day_usage", "logs_indexed_90day_percentage", "logs_indexed_60day_usage", "logs_indexed_60day_percentage", "logs_indexed_45day_usage", "logs_indexed_45day_percentage", "logs_indexed_30day_usage", "logs_indexed_30day_percentage", "logs_indexed_15day_usage", "logs_indexed_15day_percentage", "logs_indexed_7day_usage", "logs_indexed_7day_percentage", "logs_indexed_3day_usage", "logs_indexed_3day_percentage", "logs_indexed_1day_usage", "logs_indexed_1day_percentage", "rum_replay_sessions_usage", "rum_replay_sessions_percentage", "rum_browser_mobile_sessions_usage", "rum_browser_mobile_sessions_percentage", "ingested_spans_bytes_usage", "ingested_spans_bytes_percentage", "siem_analyzed_logs_add_on_usage", "siem_analyzed_logs_add_on_percentage", "siem_ingested_bytes_usage", "siem_ingested_bytes_percentage", "workflow_executions_usage", "workflow_executions_percentage", "*"].
:type value: str
"""

Expand Down Expand Up @@ -151,6 +151,8 @@ class MonthlyUsageAttributionSupportedMetrics(ModelSimple):
"rum_browser_mobile_sessions_percentage",
"ingested_spans_bytes_usage",
"ingested_spans_bytes_percentage",
"siem_analyzed_logs_add_on_usage",
"siem_analyzed_logs_add_on_percentage",
"siem_ingested_bytes_usage",
"siem_ingested_bytes_percentage",
"workflow_executions_usage",
Expand Down Expand Up @@ -287,6 +289,8 @@ class MonthlyUsageAttributionSupportedMetrics(ModelSimple):
RUM_BROWSER_MOBILE_SESSIONS_PERCENTAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
INGESTED_SPANS_BYTES_USAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
INGESTED_SPANS_BYTES_PERCENTAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
SIEM_ANALYZED_LOGS_ADD_ON_USAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
SIEM_ANALYZED_LOGS_ADD_ON_PERCENTAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
SIEM_INGESTED_BYTES_USAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
SIEM_INGESTED_BYTES_PERCENTAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
WORKFLOW_EXECUTIONS_USAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
Expand Down Expand Up @@ -646,6 +650,12 @@ def openapi_types(_):
MonthlyUsageAttributionSupportedMetrics.INGESTED_SPANS_BYTES_PERCENTAGE = MonthlyUsageAttributionSupportedMetrics(
"ingested_spans_bytes_percentage"
)
MonthlyUsageAttributionSupportedMetrics.SIEM_ANALYZED_LOGS_ADD_ON_USAGE = MonthlyUsageAttributionSupportedMetrics(
"siem_analyzed_logs_add_on_usage"
)
MonthlyUsageAttributionSupportedMetrics.SIEM_ANALYZED_LOGS_ADD_ON_PERCENTAGE = MonthlyUsageAttributionSupportedMetrics(
"siem_analyzed_logs_add_on_percentage"
)
MonthlyUsageAttributionSupportedMetrics.SIEM_INGESTED_BYTES_USAGE = MonthlyUsageAttributionSupportedMetrics(
"siem_ingested_bytes_usage"
)
Expand Down
Loading
Loading