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

Add CI App usage endpoint and usage summary columns #1361

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.2",
"regenerated": "2022-03-02 16:37:36.211008",
"spec_repo_commit": "c45f182"
"regenerated": "2022-03-02 17:37:30.178691",
"spec_repo_commit": "cd0cc83"
},
"v2": {
"apigentools_version": "1.6.2",
"regenerated": "2022-03-02 16:37:36.223162",
"spec_repo_commit": "c45f182"
"regenerated": "2022-03-02 17:37:30.190455",
"spec_repo_commit": "cd0cc83"
}
}
}
155 changes: 155 additions & 0 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13352,6 +13352,41 @@ components:
$ref: '#/components/schemas/UsageBillableSummaryHour'
type: array
type: object
UsageCIVisibilityHour:
description: CI visibility usage in a given hour.
properties:
ci_pipeline_indexed_spans:
description: The number of spans for pipelines in the queried hour.
type: integer
ci_test_indexed_spans:
description: The number of spans for tests in the queried hour.
type: integer
ci_visibility_pipeline_committers:
description: Shows the total count of all active Git committers for Pipelines
in the current month. A committer is active if they commit at least 3
times in a given month.
type: integer
ci_visibility_test_committers:
description: The total count of all active Git committers for tests in the
current month. A committer is active if they commit at least 3 times in
a given month.
type: integer
org_name:
description: The organization name.
type: string
public_id:
description: The organization public ID.
type: string
type: object
UsageCIVisibilityResponse:
description: CI visibility usage response
properties:
usage:
description: Response containing CI visibility usage.
items:
$ref: '#/components/schemas/UsageCIVisibilityHour'
type: array
type: object
UsageCWSHour:
description: Cloud Workload Security usage for a given organization for a given
hour.
Expand Down Expand Up @@ -14361,6 +14396,26 @@ components:
current date for all organizations.
format: int64
type: integer
ci_pipeline_indexed_spans_sum:
description: Shows the sum of all CI pipeline indexed spans over all hours
in the current month for all organizations.
format: int64
type: integer
ci_test_indexed_spans_sum:
description: Shows the sum of all CI test indexed spans over all hours in
the current month for all organizations.
format: int64
type: integer
ci_visibility_pipeline_committers_hwm:
description: Shows the high-water mark of all CI visibility pipeline committers
over all hours in the current month for all organizations.
format: int64
type: integer
ci_visibility_test_committers_hwm:
description: Shows the high-water mark of all CI visibility test committers
over all hours in the current month for all organizations.
format: int64
type: integer
container_avg:
description: Shows the average of all distinct containers over all hours
in the current date for all organizations.
Expand Down Expand Up @@ -14651,6 +14706,26 @@ components:
current date for the given org.
format: int64
type: integer
ci_pipeline_indexed_spans_sum:
description: Shows the sum of all CI pipeline indexed spans over all hours
in the current date for the given org.
format: int64
type: integer
ci_test_indexed_spans_sum:
description: Shows the sum of all CI test indexed spans over all hours in
the current date for the given org.
format: int64
type: integer
ci_visibility_pipeline_committers_hwm:
description: Shows the high-water mark of all CI visibility pipeline committers
over all hours in the current date for the given org.
format: int64
type: integer
ci_visibility_test_committers_hwm:
description: Shows the high-water mark of all CI visibility test committers
over all hours in the current date for the given org.
format: int64
type: integer
container_avg:
description: Shows the average of all distinct containers over all hours
in the current date for the given org.
Expand Down Expand Up @@ -14947,6 +15022,26 @@ components:
current months for all organizations.
format: int64
type: integer
ci_pipeline_indexed_spans_agg_sum:
description: Shows the sum of all CI pipeline indexed spans over all hours
in the current months for all organizations.
format: int64
type: integer
ci_test_indexed_spans_agg_sum:
description: Shows the sum of all CI test indexed spans over all hours in
the current months for all organizations.
format: int64
type: integer
ci_visibility_pipeline_committers_hwm_sum:
description: Shows the high-water mark of all CI visibility pipeline committers
over all hours in the current months for all organizations.
format: int64
type: integer
ci_visibility_test_committers_hwm_sum:
description: Shows the high-water mark of all CI visibility test committers
over all hours in the current months for all organizations.
format: int64
type: integer
container_avg_sum:
description: Shows the average of all distinct containers over all hours
in the current months for all organizations.
Expand Down Expand Up @@ -25647,6 +25742,66 @@ paths:
x-menu-order: 19
x-undo:
type: safe
/api/v1/usage/ci-app:
get:
description: Get hourly usage for CI Visibility (Tests, Pipeline, Combo, and
Spans).
operationId: GetUsageCIApp
parameters:
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
for usage beginning at this hour.'
in: query
name: start_hr
required: true
schema:
format: date-time
type: string
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
for usage ending

**before** this hour.'
in: query
name: end_hr
required: false
schema:
format: date-time
type: string
responses:
'200':
content:
application/json;datetime-format=rfc3339:
schema:
$ref: '#/components/schemas/UsageCIVisibilityResponse'
description: OK
'400':
content:
application/json;datetime-format=rfc3339:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
'403':
content:
application/json;datetime-format=rfc3339:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
'429':
content:
application/json;datetime-format=rfc3339:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- usage_read
summary: Get hourly usage for CI Visibility
tags:
- Usage Metering
x-menu-order: 38
x-undo:
type: safe
/api/v1/usage/cspm:
get:
description: Get hourly usage for Cloud Security Posture Management (CSPM).
Expand Down
4 changes: 4 additions & 0 deletions api/v1/datadog/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -620,6 +620,8 @@ docs/UsageBillableSummaryBody.md
docs/UsageBillableSummaryHour.md
docs/UsageBillableSummaryKeys.md
docs/UsageBillableSummaryResponse.md
docs/UsageCIVisibilityHour.md
docs/UsageCIVisibilityResponse.md
docs/UsageCWSHour.md
docs/UsageCWSResponse.md
docs/UsageCloudSecurityPostureManagementHour.md
Expand Down Expand Up @@ -1307,6 +1309,8 @@ model_usage_billable_summary_body.go
model_usage_billable_summary_hour.go
model_usage_billable_summary_keys.go
model_usage_billable_summary_response.go
model_usage_ci_visibility_hour.go
model_usage_ci_visibility_response.go
model_usage_cloud_security_posture_management_hour.go
model_usage_cloud_security_posture_management_response.go
model_usage_custom_reports_attributes.go
Expand Down
3 changes: 3 additions & 0 deletions api/v1/datadog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,7 @@ All URIs are relative to *https://api.datadoghq.com*
| _UsageMeteringApi_ | [**GetUsageAttribution**](docs/UsageMeteringApi.md#getusageattribution) | **Get** /api/v1/usage/attribution | Get Usage Attribution |
| _UsageMeteringApi_ | [**GetUsageAuditLogs**](docs/UsageMeteringApi.md#getusageauditlogs) | **Get** /api/v1/usage/audit_logs | Get hourly usage for audit logs |
| _UsageMeteringApi_ | [**GetUsageBillableSummary**](docs/UsageMeteringApi.md#getusagebillablesummary) | **Get** /api/v1/usage/billable-summary | Get billable usage across your account |
| _UsageMeteringApi_ | [**GetUsageCIApp**](docs/UsageMeteringApi.md#getusageciapp) | **Get** /api/v1/usage/ci-app | Get hourly usage for CI Visibility |
| _UsageMeteringApi_ | [**GetUsageCWS**](docs/UsageMeteringApi.md#getusagecws) | **Get** /api/v1/usage/cws | Get hourly usage for Cloud Workload Security |
| _UsageMeteringApi_ | [**GetUsageCloudSecurityPostureManagement**](docs/UsageMeteringApi.md#getusagecloudsecurityposturemanagement) | **Get** /api/v1/usage/cspm | Get hourly usage for CSPM |
| _UsageMeteringApi_ | [**GetUsageDBM**](docs/UsageMeteringApi.md#getusagedbm) | **Get** /api/v1/usage/dbm | Get hourly usage for Database Monitoring |
Expand Down Expand Up @@ -850,6 +851,8 @@ All URIs are relative to *https://api.datadoghq.com*
- [UsageBillableSummaryHour](docs/UsageBillableSummaryHour.md)
- [UsageBillableSummaryKeys](docs/UsageBillableSummaryKeys.md)
- [UsageBillableSummaryResponse](docs/UsageBillableSummaryResponse.md)
- [UsageCIVisibilityHour](docs/UsageCIVisibilityHour.md)
- [UsageCIVisibilityResponse](docs/UsageCIVisibilityResponse.md)
- [UsageCWSHour](docs/UsageCWSHour.md)
- [UsageCWSResponse](docs/UsageCWSResponse.md)
- [UsageCloudSecurityPostureManagementHour](docs/UsageCloudSecurityPostureManagementHour.md)
Expand Down
Loading