Skip to content
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.4.1.dev2",
"regenerated": "2021-01-25 13:05:54.837397",
"spec_repo_commit": "0c67e7b"
"regenerated": "2021-01-26 17:15:04.320994",
"spec_repo_commit": "db8c9ba"
},
"v2": {
"apigentools_version": "1.4.1.dev2",
"regenerated": "2021-01-25 13:06:08.348450",
"spec_repo_commit": "0c67e7b"
"regenerated": "2021-01-26 17:15:16.348572",
"spec_repo_commit": "db8c9ba"
}
}
}
295 changes: 295 additions & 0 deletions data/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1543,6 +1543,114 @@ components:
type: string
x-enum-varnames:
- EVENT_TIMELINE
FormulaAndFunctionEventAggregation:
description: Aggregation methods for event platform queries.
enum:
- count
- cardinality
- pc75
- pc90
- pc95
- pc98
- pc99
- sum
- min
- max
- avg
example: avg
type: string
x-enum-varnames:
- COUNT
- CARDINALITY
- PC75
- PC90
- PC95
- PC98
- PC99
- SUM
- MIN
- MAX
- AVG
FormulaAndFunctionEventsDataSource:
description: Data source for event platform-based queries.
enum:
- logs
- analyzed_spans
- network
- rum
- security_signals
- profiles
example: logs
type: string
x-enum-varnames:
- LOGS
- ANALYZED_SPANS
- NETWORK
- RUM
- SECURITY_SIGNALS
- PROFILES
FormulaAndFunctionEventsSortType:
description: Method for sorting event platform results.
enum:
- alphabetical
- measure
type: string
x-enum-varnames:
- ALPHABETICAL
- MEASURE
FormulaAndFunctionMetricAggregation:
description: The aggregation methods available for metrics queries.
enum:
- avg
- min
- max
- sum
- last
- area
- l2norm
example: avg
type: string
x-enum-varnames:
- AVG
- MIN
- MAX
- SUM
- LAST
- AREA
- L2NORM
FormulaAndFunctionMetricDataSource:
description: Data source for metrics queries.
enum:
- metrics
example: metrics
type: string
x-enum-varnames:
- METRICS
FormulaAndFunctionProcessQueryDataSource:
description: Data sources that rely on the process backend.
enum:
- process
- container
type: string
x-enum-varnames:
- PROCESS
- CONTAINER
FormulaAndFunctionQueryDefinition:
description: A formula and function query.
oneOf:
- $ref: '#/components/schemas/TimeSeriesFormulaAndFunctionMetricQueryDefinition'
- $ref: '#/components/schemas/TimeSeriesFormulaAndFunctionEventQueryDefinition'
- $ref: '#/components/schemas/TimeSeriesFormulaAndFunctionProcessQueryDefinition'
type: object
FormulaAndFunctionResponseFormat:
description: Timeseries or Scalar response. This feature is currently in beta.
enum:
- timeseries
- scalar
type: string
x-enum-varnames:
- TIMESERIES
- SCALAR
FreeTextWidgetDefinition:
description: Free text is a widget that allows you to add headings to your screenboard.
Commonly used to state the overall purpose of the dashboard. Only available
Expand Down Expand Up @@ -4631,6 +4739,16 @@ components:
required:
- metric
type: object
QuerySortOrder:
default: desc
description: Direction of sort.
enum:
- asc
- desc
type: string
x-enum-varnames:
- ASC
- DESC
QueryValueWidgetDefinition:
description: Query values display the current value of a given metric, APM,
or log query.
Expand Down Expand Up @@ -7456,6 +7574,146 @@ components:
- STRING
- INTEGER
- DOUBLE
TimeSeriesFormulaAndFunctionEventQueryDefinition:
description: A timeseries formula and functions events query.
properties:
compute:
description: Compute options.
properties:
aggregation:
$ref: '#/components/schemas/FormulaAndFunctionEventAggregation'
interval:
description: A time interval in milliseconds.
example: 60000
format: int64
type: integer
metric:
description: Measurable attribute to compute.
example: '@duration'
type: string
required:
- aggregation
type: object
data_source:
$ref: '#/components/schemas/FormulaAndFunctionEventsDataSource'
group_by:
description: Group by options.
properties:
facet:
description: Event facet.
example: status.
type: string
limit:
description: Number of groups to return.
example: 10
format: int64
type: integer
sort:
description: Options for sorting group by results.
properties:
aggregation:
$ref: '#/components/schemas/FormulaAndFunctionEventAggregation'
metric:
description: Metric used for sorting group by results.
type: string
order:
$ref: '#/components/schemas/QuerySortOrder'
type:
$ref: '#/components/schemas/FormulaAndFunctionEventsSortType'
required:
- aggregation
type: object
required:
- facet
type: object
indexes:
description: An array of index names to query in the stream. Omit or use
`[]` to query all indexes at once.
example:
- days-3
- days-7
items:
description: A log index set up for your organization. For additional
indexes, see the [multiple indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
documentation.
type: string
type: array
name:
description: Name of the query for use in formulas.
example: query_errors
type: string
search:
description: Search options.
properties:
query:
description: Events search string.
example: service:query
type: string
required:
- query
type: object
required:
- data_source
- compute
type: object
TimeSeriesFormulaAndFunctionMetricQueryDefinition:
description: A timeseries formula and functions metrics query.
example:
data_source: metrics
query: avg:system.cpu.user{*}
properties:
aggregator:
$ref: '#/components/schemas/FormulaAndFunctionMetricAggregation'
data_source:
$ref: '#/components/schemas/FormulaAndFunctionMetricDataSource'
name:
description: Name of the query for use in formulas.
example: my_query
type: string
query:
description: Metrics query definition.
example: avg:system.cpu.user{*}
type: string
required:
- data_source
- query
type: object
TimeSeriesFormulaAndFunctionProcessQueryDefinition:
description: Process query using formulas and functions.
properties:
aggregator:
$ref: '#/components/schemas/FormulaAndFunctionMetricAggregation'
data_source:
$ref: '#/components/schemas/FormulaAndFunctionProcessQueryDataSource'
is_normalized_cpu:
description: Whether to normalize the CPU percentages.
type: boolean
limit:
description: Number of hits to return.
format: int64
type: integer
metric:
description: Process metric name.
example: avg:system.cpu.user{*}
type: string
name:
description: Name of query for use in formulas.
type: string
sort:
$ref: '#/components/schemas/QuerySortOrder'
tag_filters:
description: An array of tags to filter by.
items:
description: One of the tags to filter by.
type: string
type: array
text_filter:
description: Text to use as filter.
type: string
required:
- data_source
- metric
type: object
TimeseriesWidgetDefinition:
description: The timeseries visualization allows you to display the evolution
of one or more metrics, log events, or Indexed Spans over time.
Expand Down Expand Up @@ -7526,6 +7784,12 @@ components:
$ref: '#/components/schemas/WidgetDisplayType'
event_query:
$ref: '#/components/schemas/LogQueryDefinition'
formulas:
description: List of formulas that operate on queries. This feature is currently
in beta.
items:
$ref: '#/components/schemas/WidgetFormula'
type: array
log_query:
$ref: '#/components/schemas/LogQueryDefinition'
metadata:
Expand Down Expand Up @@ -7554,6 +7818,14 @@ components:
q:
description: Widget query.
type: string
queries:
description: List of queries that can be returned directly or used in formulas.
This feature is currently in beta.
items:
$ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
type: array
response_format:
$ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
rum_query:
$ref: '#/components/schemas/LogQueryDefinition'
security_query:
Expand Down Expand Up @@ -9552,6 +9824,29 @@ components:
- column
- order
type: object
WidgetFormula:
description: Formula to be used in a widget query.
properties:
alias:
description: Expression alias.
type: string
formula:
description: String expression built from queries, formulas, and functions.
example: func(a) + b
type: string
limit:
description: Options for limiting results returned.
properties:
count:
description: Number of results to return.
format: int64
type: integer
order:
$ref: '#/components/schemas/QuerySortOrder'
type: object
required:
- formula
type: object
WidgetGrouping:
description: The kind of grouping to use.
enum:
Expand Down
15 changes: 15 additions & 0 deletions docs/v1/FormulaAndFunctionEventAggregation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# DatadogAPIClient::V1::FormulaAndFunctionEventAggregation

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |

## Example

```ruby
require 'datadog_api_client/v1'

instance = DatadogAPIClient::V1::FormulaAndFunctionEventAggregation.new()
```

15 changes: 15 additions & 0 deletions docs/v1/FormulaAndFunctionEventsDataSource.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# DatadogAPIClient::V1::FormulaAndFunctionEventsDataSource

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |

## Example

```ruby
require 'datadog_api_client/v1'

instance = DatadogAPIClient::V1::FormulaAndFunctionEventsDataSource.new()
```

Loading