Skip to content

Update documentation for observability pipeline bytes usage attribution #1472

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.4",
"regenerated": "2023-05-24 12:48:53.735604",
"spec_repo_commit": "ba7efe40"
"regenerated": "2023-05-24 13:16:05.936665",
"spec_repo_commit": "61d57b72"
},
"v2": {
"apigentools_version": "1.6.4",
"regenerated": "2023-05-24 12:48:53.752207",
"spec_repo_commit": "ba7efe40"
"regenerated": "2023-05-24 13:16:06.032642",
"spec_repo_commit": "61d57b72"
}
}
}
14 changes: 14 additions & 0 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3834,6 +3834,7 @@ components:
- infra_host_usage
- invocations_usage
- npm_host_usage
- obs_pipeline_bytes_usage
- profiled_container_usage
- profiled_fargate_usage
- profiled_host_usage
Expand Down Expand Up @@ -3868,6 +3869,7 @@ components:
- INFRA_HOST_USAGE
- INVOCATIONS_USAGE
- NPM_HOST_USAGE
- OBS_PIPELINE_BYTES_USAGE
- PROFILED_CONTAINER_USAGE
- PROFILED_FARGATE_USAGE
- PROFILED_HOST_USAGE
Expand Down Expand Up @@ -7368,6 +7370,8 @@ components:
- invocations_percentage
- npm_host_usage
- npm_host_percentage
- obs_pipeline_bytes_usage
- obs_pipeline_bytes_percentage
- profiled_container_usage
- profiled_container_percentage
- profiled_fargate_usage
Expand Down Expand Up @@ -7435,6 +7439,8 @@ components:
- INVOCATIONS_PERCENTAGE
- NPM_HOST_USAGE
- NPM_HOST_PERCENTAGE
- OBS_PIPELINE_BYTES_USAGE
- OBS_PIPELINE_BYTES_PERCENTAGE
- PROFILED_CONTAINER_USAGE
- PROFILED_CONTAINER_PERCENTAGE
- PROFILED_FARGATE_USAGE
Expand Down Expand Up @@ -7666,6 +7672,14 @@ components:
description: The network host usage by tag(s).
format: double
type: number
obs_pipeline_bytes_percentage:
description: The percentage of observability pipeline bytes usage by tag(s).
format: double
type: number
obs_pipeline_bytes_usage:
description: The observability pipeline bytes usage by tag(s).
format: double
type: number
profiled_container_percentage:
description: The percentage of profiled container usage by tag(s).
format: double
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", "appsec_fargate_usage", "appsec_usage", "browser_usage", "container_excl_agent_usage", "container_usage", "cspm_containers_usage", "cspm_hosts_usage", "custom_ingested_timeseries_usage", "custom_timeseries_usage", "cws_containers_usage", "cws_hosts_usage", "dbm_hosts_usage", "dbm_queries_usage", "estimated_indexed_logs_usage", "estimated_ingested_logs_usage", "estimated_indexed_spans_usage", "estimated_ingested_spans_usage", "fargate_usage", "functions_usage", "infra_host_usage", "invocations_usage", "npm_host_usage", "profiled_container_usage", "profiled_fargate_usage", "profiled_host_usage", "snmp_usage", "estimated_rum_sessions_usage", "universal_service_monitoring_usage", "vuln_management_hosts_usage"].
:param value: Must be one of ["api_usage", "apm_fargate_usage", "apm_host_usage", "appsec_fargate_usage", "appsec_usage", "browser_usage", "container_excl_agent_usage", "container_usage", "cspm_containers_usage", "cspm_hosts_usage", "custom_ingested_timeseries_usage", "custom_timeseries_usage", "cws_containers_usage", "cws_hosts_usage", "dbm_hosts_usage", "dbm_queries_usage", "estimated_indexed_logs_usage", "estimated_ingested_logs_usage", "estimated_indexed_spans_usage", "estimated_ingested_spans_usage", "fargate_usage", "functions_usage", "infra_host_usage", "invocations_usage", "npm_host_usage", "obs_pipeline_bytes_usage", "profiled_container_usage", "profiled_fargate_usage", "profiled_host_usage", "snmp_usage", "estimated_rum_sessions_usage", "universal_service_monitoring_usage", "vuln_management_hosts_usage"].
:type value: str
"""

Expand Down Expand Up @@ -46,6 +46,7 @@ class HourlyUsageAttributionUsageType(ModelSimple):
"infra_host_usage",
"invocations_usage",
"npm_host_usage",
"obs_pipeline_bytes_usage",
"profiled_container_usage",
"profiled_fargate_usage",
"profiled_host_usage",
Expand Down Expand Up @@ -79,6 +80,7 @@ class HourlyUsageAttributionUsageType(ModelSimple):
INFRA_HOST_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
INVOCATIONS_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
NPM_HOST_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
OBS_PIPELINE_BYTES_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
PROFILED_CONTAINER_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
PROFILED_FARGATE_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
PROFILED_HOST_USAGE: ClassVar["HourlyUsageAttributionUsageType"]
Expand Down Expand Up @@ -131,6 +133,7 @@ def openapi_types(_):
HourlyUsageAttributionUsageType.INFRA_HOST_USAGE = HourlyUsageAttributionUsageType("infra_host_usage")
HourlyUsageAttributionUsageType.INVOCATIONS_USAGE = HourlyUsageAttributionUsageType("invocations_usage")
HourlyUsageAttributionUsageType.NPM_HOST_USAGE = HourlyUsageAttributionUsageType("npm_host_usage")
HourlyUsageAttributionUsageType.OBS_PIPELINE_BYTES_USAGE = HourlyUsageAttributionUsageType("obs_pipeline_bytes_usage")
HourlyUsageAttributionUsageType.PROFILED_CONTAINER_USAGE = HourlyUsageAttributionUsageType("profiled_container_usage")
HourlyUsageAttributionUsageType.PROFILED_FARGATE_USAGE = HourlyUsageAttributionUsageType("profiled_fargate_usage")
HourlyUsageAttributionUsageType.PROFILED_HOST_USAGE = HourlyUsageAttributionUsageType("profiled_host_usage")
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", "appsec_usage", "appsec_percentage", "browser_usage", "browser_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", "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", "infra_host_usage", "infra_host_percentage", "invocations_usage", "invocations_percentage", "npm_host_usage", "npm_host_percentage", "profiled_container_usage", "profiled_container_percentage", "profiled_fargate_usage", "profiled_fargate_percentage", "profiled_host_usage", "profiled_host_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", "*"].
: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", "appsec_usage", "appsec_percentage", "browser_usage", "browser_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", "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", "infra_host_usage", "infra_host_percentage", "invocations_usage", "invocations_percentage", "npm_host_usage", "npm_host_percentage", "obs_pipeline_bytes_usage", "obs_pipeline_bytes_percentage", "profiled_container_usage", "profiled_container_percentage", "profiled_fargate_usage", "profiled_fargate_percentage", "profiled_host_usage", "profiled_host_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", "*"].
:type value: str
"""

Expand Down Expand Up @@ -71,6 +71,8 @@ class MonthlyUsageAttributionSupportedMetrics(ModelSimple):
"invocations_percentage",
"npm_host_usage",
"npm_host_percentage",
"obs_pipeline_bytes_usage",
"obs_pipeline_bytes_percentage",
"profiled_container_usage",
"profiled_container_percentage",
"profiled_fargate_usage",
Expand Down Expand Up @@ -137,6 +139,8 @@ class MonthlyUsageAttributionSupportedMetrics(ModelSimple):
INVOCATIONS_PERCENTAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
NPM_HOST_USAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
NPM_HOST_PERCENTAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
OBS_PIPELINE_BYTES_USAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
OBS_PIPELINE_BYTES_PERCENTAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
PROFILED_CONTAINER_USAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
PROFILED_CONTAINER_PERCENTAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
PROFILED_FARGATE_USAGE: ClassVar["MonthlyUsageAttributionSupportedMetrics"]
Expand Down Expand Up @@ -276,6 +280,12 @@ def openapi_types(_):
MonthlyUsageAttributionSupportedMetrics.NPM_HOST_PERCENTAGE = MonthlyUsageAttributionSupportedMetrics(
"npm_host_percentage"
)
MonthlyUsageAttributionSupportedMetrics.OBS_PIPELINE_BYTES_USAGE = MonthlyUsageAttributionSupportedMetrics(
"obs_pipeline_bytes_usage"
)
MonthlyUsageAttributionSupportedMetrics.OBS_PIPELINE_BYTES_PERCENTAGE = MonthlyUsageAttributionSupportedMetrics(
"obs_pipeline_bytes_percentage"
)
MonthlyUsageAttributionSupportedMetrics.PROFILED_CONTAINER_USAGE = MonthlyUsageAttributionSupportedMetrics(
"profiled_container_usage"
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ def openapi_types(_):
"invocations_usage": (float,),
"npm_host_percentage": (float,),
"npm_host_usage": (float,),
"obs_pipeline_bytes_percentage": (float,),
"obs_pipeline_bytes_usage": (float,),
"profiled_container_percentage": (float,),
"profiled_container_usage": (float,),
"profiled_fargate_percentage": (float,),
Expand Down Expand Up @@ -136,6 +138,8 @@ def openapi_types(_):
"invocations_usage": "invocations_usage",
"npm_host_percentage": "npm_host_percentage",
"npm_host_usage": "npm_host_usage",
"obs_pipeline_bytes_percentage": "obs_pipeline_bytes_percentage",
"obs_pipeline_bytes_usage": "obs_pipeline_bytes_usage",
"profiled_container_percentage": "profiled_container_percentage",
"profiled_container_usage": "profiled_container_usage",
"profiled_fargate_percentage": "profiled_fargate_percentage",
Expand Down Expand Up @@ -204,6 +208,8 @@ def __init__(
invocations_usage: Union[float, UnsetType] = unset,
npm_host_percentage: Union[float, UnsetType] = unset,
npm_host_usage: Union[float, UnsetType] = unset,
obs_pipeline_bytes_percentage: Union[float, UnsetType] = unset,
obs_pipeline_bytes_usage: Union[float, UnsetType] = unset,
profiled_container_percentage: Union[float, UnsetType] = unset,
profiled_container_usage: Union[float, UnsetType] = unset,
profiled_fargate_percentage: Union[float, UnsetType] = unset,
Expand Down Expand Up @@ -377,6 +383,12 @@ def __init__(
:param npm_host_usage: The network host usage by tag(s).
:type npm_host_usage: float, optional

:param obs_pipeline_bytes_percentage: The percentage of observability pipeline bytes usage by tag(s).
:type obs_pipeline_bytes_percentage: float, optional

:param obs_pipeline_bytes_usage: The observability pipeline bytes usage by tag(s).
:type obs_pipeline_bytes_usage: float, optional

:param profiled_container_percentage: The percentage of profiled container usage by tag(s).
:type profiled_container_percentage: float, optional

Expand Down Expand Up @@ -517,6 +529,10 @@ def __init__(
kwargs["npm_host_percentage"] = npm_host_percentage
if npm_host_usage is not unset:
kwargs["npm_host_usage"] = npm_host_usage
if obs_pipeline_bytes_percentage is not unset:
kwargs["obs_pipeline_bytes_percentage"] = obs_pipeline_bytes_percentage
if obs_pipeline_bytes_usage is not unset:
kwargs["obs_pipeline_bytes_usage"] = obs_pipeline_bytes_usage
if profiled_container_percentage is not unset:
kwargs["profiled_container_percentage"] = profiled_container_percentage
if profiled_container_usage is not unset:
Expand Down