datadog_api_client 1.0.0.beta.3 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.apigentools-info +4 -4
- data/.azure-pipelines/all.yml +0 -1
- data/.rubocop.yml +1 -1
- data/CHANGELOG.md +23 -0
- data/Gemfile +1 -1
- data/LICENSE-3rdparty.csv +0 -1
- data/check-examples.sh +7 -2
- data/data/v1/openapi.yaml +1963 -245
- data/data/v2/openapi.yaml +67 -13
- data/docs/v1/DashboardsAPI.md +10 -5
- data/docs/v1/DistributionWidgetDefinition.md +9 -3
- data/docs/v1/DistributionWidgetXAxis.md +24 -0
- data/docs/v1/DistributionWidgetYAxis.md +26 -0
- data/docs/v1/EventsAPI.md +7 -3
- data/docs/v1/GroupWidgetDefinition.md +8 -0
- data/docs/v1/ImageWidgetDefinition.md +11 -1
- data/docs/v1/LogsByRetention.md +22 -0
- data/docs/v1/LogsByRetentionMonthlyUsage.md +20 -0
- data/docs/v1/LogsByRetentionOrgUsage.md +18 -0
- data/docs/v1/LogsByRetentionOrgs.md +18 -0
- data/docs/v1/LogsRetentionAggSumUsage.md +24 -0
- data/docs/v1/LogsRetentionSumUsage.md +24 -0
- data/docs/v1/MonitorsAPI.md +1 -1
- data/docs/v1/NoteWidgetDefinition.md +5 -1
- data/docs/v1/NotebookAbsoluteTime.md +22 -0
- data/docs/v1/NotebookAuthor.md +34 -0
- data/docs/v1/NotebookCellCreateRequest.md +20 -0
- data/docs/v1/NotebookCellCreateRequestAttributes.md +57 -0
- data/docs/v1/NotebookCellResourceType.md +15 -0
- data/docs/v1/NotebookCellResponse.md +22 -0
- data/docs/v1/NotebookCellResponseAttributes.md +57 -0
- data/docs/v1/NotebookCellTime.md +49 -0
- data/docs/v1/NotebookCellUpdateRequest.md +22 -0
- data/docs/v1/NotebookCellUpdateRequestAttributes.md +57 -0
- data/docs/v1/NotebookCreateData.md +20 -0
- data/docs/v1/NotebookCreateDataAttributes.md +24 -0
- data/docs/v1/NotebookCreateRequest.md +18 -0
- data/docs/v1/NotebookDistributionCellAttributes.md +24 -0
- data/docs/v1/NotebookGlobalTime.md +49 -0
- data/docs/v1/NotebookGraphSize.md +15 -0
- data/docs/v1/NotebookHeatMapCellAttributes.md +24 -0
- data/docs/v1/NotebookLogStreamCellAttributes.md +22 -0
- data/docs/v1/NotebookMarkdownCellAttributes.md +18 -0
- data/docs/v1/NotebookMarkdownCellDefinition.md +21 -0
- data/docs/v1/NotebookMarkdownCellDefinitionType.md +15 -0
- data/docs/v1/NotebookRelativeTime.md +18 -0
- data/docs/v1/NotebookResourceType.md +15 -0
- data/docs/v1/NotebookResponse.md +18 -0
- data/docs/v1/NotebookResponseData.md +22 -0
- data/docs/v1/NotebookResponseDataAttributes.md +30 -0
- data/docs/v1/NotebookSplitBy.md +20 -0
- data/docs/v1/NotebookStatus.md +15 -0
- data/docs/v1/NotebookTimeseriesCellAttributes.md +24 -0
- data/docs/v1/NotebookToplistCellAttributes.md +24 -0
- data/docs/v1/NotebookUpdateCell.md +49 -0
- data/docs/v1/NotebookUpdateData.md +20 -0
- data/docs/v1/NotebookUpdateDataAttributes.md +24 -0
- data/docs/v1/NotebookUpdateRequest.md +18 -0
- data/docs/v1/NotebooksAPI.md +339 -0
- data/docs/v1/NotebooksResponse.md +20 -0
- data/docs/v1/NotebooksResponseMeta.md +18 -0
- data/docs/v1/NotebooksResponsePage.md +20 -0
- data/docs/v1/README.md +66 -9
- data/docs/v1/SLOListResponse.md +3 -1
- data/docs/v1/SLOListResponseMetadata.md +18 -0
- data/docs/v1/SLOListResponseMetadataPage.md +20 -0
- data/docs/v1/SLOResponse.md +1 -1
- data/docs/v1/SLOResponseData.md +44 -0
- data/docs/v1/ServiceLevelObjectivesAPI.md +8 -4
- data/docs/v1/SyntheticsAPI.md +28 -156
- data/docs/v1/SyntheticsAPIStep.md +4 -0
- data/docs/v1/SyntheticsBrowserTestConfig.md +2 -0
- data/docs/v1/SyntheticsTestConfig.md +1 -1
- data/docs/v1/SyntheticsTestOptions.md +1 -1
- data/docs/v1/SyntheticsTestRequest.md +6 -0
- data/docs/v1/UsageAttributionSupportedMetrics.md +15 -0
- data/docs/v1/UsageAttributionValues.md +8 -0
- data/docs/v1/UsageHostHour.md +3 -1
- data/docs/v1/UsageIoTHour.md +1 -1
- data/docs/v1/UsageLogsByRetentionHour.md +24 -0
- data/docs/v1/UsageLogsByRetentionResponse.md +18 -0
- data/docs/v1/UsageMeteringAPI.md +69 -2
- data/docs/v1/UsageSummaryDate.md +11 -9
- data/docs/v1/UsageSummaryDateOrg.md +3 -1
- data/docs/v1/UsageSummaryResponse.md +5 -1
- data/docs/v1/WidgetHorizontalAlign.md +15 -0
- data/docs/v1/WidgetLayout.md +2 -0
- data/docs/v1/WidgetMarker.md +1 -1
- data/docs/v1/WidgetVerticalAlign.md +15 -0
- data/docs/v2/IncidentServiceUpdateData.md +1 -1
- data/docs/v2/IncidentServicesAPI.md +1 -1
- data/docs/v2/IncidentTeamUpdateData.md +1 -1
- data/docs/v2/IncidentTeamsAPI.md +1 -1
- data/docs/v2/MetricsAPI.md +1 -11
- data/extract-code-blocks.sh +6 -2
- data/lib/datadog_api_client/v1.rb +54 -0
- data/lib/datadog_api_client/v1/api/dashboards_api.rb +3 -0
- data/lib/datadog_api_client/v1/api/events_api.rb +14 -4
- data/lib/datadog_api_client/v1/api/monitors_api.rb +2 -2
- data/lib/datadog_api_client/v1/api/notebooks_api.rb +418 -0
- data/lib/datadog_api_client/v1/api/service_level_objectives_api.rb +3 -0
- data/lib/datadog_api_client/v1/api/synthetics_api.rb +14 -170
- data/lib/datadog_api_client/v1/api/usage_metering_api.rb +79 -2
- data/lib/datadog_api_client/v1/models/distribution_widget_definition.rb +36 -6
- data/lib/datadog_api_client/v1/models/distribution_widget_x_axis.rb +259 -0
- data/lib/datadog_api_client/v1/models/distribution_widget_y_axis.rb +269 -0
- data/lib/datadog_api_client/v1/models/group_widget_definition.rb +42 -1
- data/lib/datadog_api_client/v1/models/image_widget_definition.rb +56 -4
- data/lib/datadog_api_client/v1/models/logs_by_retention.rb +243 -0
- data/lib/datadog_api_client/v1/models/logs_by_retention_monthly_usage.rb +235 -0
- data/lib/datadog_api_client/v1/models/logs_by_retention_org_usage.rb +225 -0
- data/lib/datadog_api_client/v1/models/logs_by_retention_orgs.rb +225 -0
- data/lib/datadog_api_client/v1/models/logs_retention_agg_sum_usage.rb +253 -0
- data/lib/datadog_api_client/v1/models/logs_retention_sum_usage.rb +253 -0
- data/lib/datadog_api_client/v1/models/note_widget_definition.rb +25 -4
- data/lib/datadog_api_client/v1/models/notebook_absolute_time.rb +253 -0
- data/lib/datadog_api_client/v1/models/notebook_author.rb +303 -0
- data/lib/datadog_api_client/v1/models/notebook_cell_create_request.rb +243 -0
- data/lib/datadog_api_client/v1/models/notebook_cell_create_request_attributes.rb +113 -0
- data/lib/datadog_api_client/v1/models/notebook_cell_resource_type.rb +39 -0
- data/lib/datadog_api_client/v1/models/notebook_cell_response.rb +258 -0
- data/lib/datadog_api_client/v1/models/notebook_cell_response_attributes.rb +113 -0
- data/lib/datadog_api_client/v1/models/notebook_cell_time.rb +109 -0
- data/lib/datadog_api_client/v1/models/notebook_cell_update_request.rb +258 -0
- data/lib/datadog_api_client/v1/models/notebook_cell_update_request_attributes.rb +113 -0
- data/lib/datadog_api_client/v1/models/notebook_create_data.rb +243 -0
- data/lib/datadog_api_client/v1/models/notebook_create_data_attributes.rb +298 -0
- data/lib/datadog_api_client/v1/models/notebook_create_request.rb +227 -0
- data/lib/datadog_api_client/v1/models/notebook_distribution_cell_attributes.rb +255 -0
- data/lib/datadog_api_client/v1/models/notebook_global_time.rb +109 -0
- data/lib/datadog_api_client/v1/models/notebook_graph_size.rb +43 -0
- data/lib/datadog_api_client/v1/models/notebook_heat_map_cell_attributes.rb +255 -0
- data/lib/datadog_api_client/v1/models/notebook_log_stream_cell_attributes.rb +246 -0
- data/lib/datadog_api_client/v1/models/notebook_markdown_cell_attributes.rb +227 -0
- data/lib/datadog_api_client/v1/models/notebook_markdown_cell_definition.rb +244 -0
- data/lib/datadog_api_client/v1/models/notebook_markdown_cell_definition_type.rb +39 -0
- data/lib/datadog_api_client/v1/models/notebook_relative_time.rb +227 -0
- data/lib/datadog_api_client/v1/models/notebook_resource_type.rb +39 -0
- data/lib/datadog_api_client/v1/models/notebook_response.rb +222 -0
- data/lib/datadog_api_client/v1/models/notebook_response_data.rb +258 -0
- data/lib/datadog_api_client/v1/models/notebook_response_data_attributes.rb +327 -0
- data/lib/datadog_api_client/v1/models/notebook_split_by.rb +247 -0
- data/lib/datadog_api_client/v1/models/notebook_status.rb +39 -0
- data/lib/datadog_api_client/v1/models/notebook_timeseries_cell_attributes.rb +255 -0
- data/lib/datadog_api_client/v1/models/notebook_toplist_cell_attributes.rb +255 -0
- data/lib/datadog_api_client/v1/models/notebook_update_cell.rb +109 -0
- data/lib/datadog_api_client/v1/models/notebook_update_data.rb +243 -0
- data/lib/datadog_api_client/v1/models/notebook_update_data_attributes.rb +298 -0
- data/lib/datadog_api_client/v1/models/notebook_update_request.rb +227 -0
- data/lib/datadog_api_client/v1/models/notebooks_response.rb +234 -0
- data/lib/datadog_api_client/v1/models/notebooks_response_meta.rb +222 -0
- data/lib/datadog_api_client/v1/models/notebooks_response_page.rb +233 -0
- data/lib/datadog_api_client/v1/models/slo_list_response.rb +13 -4
- data/lib/datadog_api_client/v1/models/slo_list_response_metadata.rb +222 -0
- data/lib/datadog_api_client/v1/models/slo_list_response_metadata_page.rb +233 -0
- data/lib/datadog_api_client/v1/models/slo_response.rb +1 -1
- data/lib/datadog_api_client/v1/models/slo_response_data.rb +363 -0
- data/lib/datadog_api_client/v1/models/synthetics_api_step.rb +21 -1
- data/lib/datadog_api_client/v1/models/synthetics_assertion_type.rb +4 -0
- data/lib/datadog_api_client/v1/models/synthetics_browser_test_config.rb +11 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_config.rb +0 -5
- data/lib/datadog_api_client/v1/models/synthetics_test_details_sub_type.rb +1 -0
- data/lib/datadog_api_client/v1/models/synthetics_test_options.rb +1 -1
- data/lib/datadog_api_client/v1/models/synthetics_test_request.rb +79 -1
- data/lib/datadog_api_client/v1/models/synthetics_tick_interval.rb +1 -0
- data/lib/datadog_api_client/v1/models/usage_attribution_supported_metrics.rb +67 -0
- data/lib/datadog_api_client/v1/models/usage_attribution_values.rb +41 -1
- data/lib/datadog_api_client/v1/models/usage_host_hour.rb +14 -4
- data/lib/datadog_api_client/v1/models/usage_io_t_hour.rb +1 -1
- data/lib/datadog_api_client/v1/models/usage_logs_by_retention_hour.rb +253 -0
- data/lib/datadog_api_client/v1/models/usage_logs_by_retention_response.rb +225 -0
- data/lib/datadog_api_client/v1/models/usage_summary_date.rb +38 -28
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +14 -4
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +23 -4
- data/lib/datadog_api_client/v1/models/widget.rb +1 -1
- data/lib/datadog_api_client/v1/models/widget_horizontal_align.rb +41 -0
- data/lib/datadog_api_client/v1/models/widget_image_sizing.rb +5 -0
- data/lib/datadog_api_client/v1/models/widget_layout.rb +12 -2
- data/lib/datadog_api_client/v1/models/widget_margin.rb +3 -0
- data/lib/datadog_api_client/v1/models/widget_marker.rb +1 -1
- data/lib/datadog_api_client/v1/models/widget_vertical_align.rb +41 -0
- data/lib/datadog_api_client/v2/api/metrics_api.rb +2 -2
- data/lib/datadog_api_client/v2/configuration.rb +0 -2
- data/lib/datadog_api_client/v2/models/incident_service_update_data.rb +0 -5
- data/lib/datadog_api_client/v2/models/incident_team_update_data.rb +0 -5
- data/lib/datadog_api_client/v2/models/metric_tag_configuration_metric_types.rb +1 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_detection_method.rb +1 -0
- data/lib/datadog_api_client/version.rb +1 -1
- data/run-tests.sh +0 -6
- data/spec/v1/api/notebooks_api_spec.rb +106 -0
- data/spec/v1/models/distribution_widget_x_axis_spec.rb +55 -0
- data/spec/v1/models/distribution_widget_y_axis_spec.rb +61 -0
- data/spec/v1/models/logs_by_retention_monthly_usage_spec.rb +43 -0
- data/spec/v1/models/logs_by_retention_org_usage_spec.rb +37 -0
- data/spec/v1/models/logs_by_retention_orgs_spec.rb +37 -0
- data/spec/v1/models/logs_by_retention_spec.rb +49 -0
- data/spec/v1/models/logs_retention_agg_sum_usage_spec.rb +55 -0
- data/spec/v1/models/logs_retention_sum_usage_spec.rb +55 -0
- data/spec/v1/models/notebook_absolute_time_spec.rb +49 -0
- data/spec/v1/models/notebook_author_spec.rb +85 -0
- data/spec/v1/models/notebook_cell_create_request_attributes_spec.rb +34 -0
- data/spec/v1/models/notebook_cell_create_request_spec.rb +43 -0
- data/spec/v1/models/notebook_cell_resource_type_spec.rb +31 -0
- data/spec/v1/models/notebook_cell_response_attributes_spec.rb +34 -0
- data/spec/v1/models/notebook_cell_response_spec.rb +49 -0
- data/spec/v1/models/notebook_cell_time_spec.rb +34 -0
- data/spec/v1/models/notebook_cell_update_request_attributes_spec.rb +34 -0
- data/spec/v1/models/notebook_cell_update_request_spec.rb +49 -0
- data/spec/v1/models/notebook_create_data_attributes_spec.rb +55 -0
- data/spec/v1/models/notebook_create_data_spec.rb +43 -0
- data/spec/v1/models/notebook_create_request_spec.rb +37 -0
- data/spec/v1/models/notebook_distribution_cell_attributes_spec.rb +55 -0
- data/spec/v1/models/notebook_global_time_spec.rb +34 -0
- data/spec/v1/models/notebook_graph_size_spec.rb +31 -0
- data/spec/v1/models/notebook_heat_map_cell_attributes_spec.rb +55 -0
- data/spec/v1/models/notebook_log_stream_cell_attributes_spec.rb +49 -0
- data/spec/v1/models/notebook_markdown_cell_attributes_spec.rb +37 -0
- data/spec/v1/models/notebook_markdown_cell_definition_spec.rb +43 -0
- data/spec/v1/models/notebook_markdown_cell_definition_type_spec.rb +31 -0
- data/spec/v1/models/notebook_relative_time_spec.rb +37 -0
- data/spec/v1/models/notebook_resource_type_spec.rb +31 -0
- data/spec/v1/models/notebook_response_data_attributes_spec.rb +73 -0
- data/spec/v1/models/notebook_response_data_spec.rb +49 -0
- data/spec/v1/models/notebook_response_spec.rb +37 -0
- data/spec/v1/models/notebook_split_by_spec.rb +43 -0
- data/spec/v1/models/notebook_status_spec.rb +31 -0
- data/spec/v1/models/notebook_timeseries_cell_attributes_spec.rb +55 -0
- data/spec/v1/models/notebook_toplist_cell_attributes_spec.rb +55 -0
- data/spec/v1/models/notebook_update_cell_spec.rb +34 -0
- data/spec/v1/models/notebook_update_data_attributes_spec.rb +55 -0
- data/spec/v1/models/notebook_update_data_spec.rb +43 -0
- data/spec/v1/models/notebook_update_request_spec.rb +37 -0
- data/spec/v1/models/notebooks_response_meta_spec.rb +37 -0
- data/spec/v1/models/notebooks_response_page_spec.rb +43 -0
- data/spec/v1/models/notebooks_response_spec.rb +43 -0
- data/spec/v1/models/slo_list_response_metadata_page_spec.rb +43 -0
- data/spec/v1/models/slo_list_response_metadata_spec.rb +37 -0
- data/spec/v1/models/slo_response_data_spec.rb +115 -0
- data/spec/v1/models/usage_attribution_supported_metrics_spec.rb +31 -0
- data/spec/v1/models/usage_logs_by_retention_hour_spec.rb +55 -0
- data/spec/v1/models/usage_logs_by_retention_response_spec.rb +37 -0
- data/spec/v1/models/widget_horizontal_align_spec.rb +31 -0
- data/spec/v1/models/widget_vertical_align_spec.rb +31 -0
- metadata +220 -4
data/docs/v1/DashboardsAPI.md
CHANGED
@@ -199,7 +199,7 @@ end
|
|
199
199
|
|
200
200
|
## list_dashboards
|
201
201
|
|
202
|
-
> <DashboardSummary> list_dashboards
|
202
|
+
> <DashboardSummary> list_dashboards(opts)
|
203
203
|
|
204
204
|
Get all dashboards
|
205
205
|
|
@@ -210,10 +210,13 @@ Get all dashboards. **Note**: This query will only return custom created or clo
|
|
210
210
|
```ruby
|
211
211
|
require 'datadog_api_client'
|
212
212
|
api_instance = DatadogAPIClient::V1::DashboardsAPI.new
|
213
|
+
opts = {
|
214
|
+
filter_shared: true # Boolean | When `true`, this query only returns shared custom created or cloned dashboards.
|
215
|
+
}
|
213
216
|
|
214
217
|
begin
|
215
218
|
# Get all dashboards
|
216
|
-
result = api_instance.list_dashboards
|
219
|
+
result = api_instance.list_dashboards(opts)
|
217
220
|
p result
|
218
221
|
rescue DatadogAPIClient::V1::APIError => e
|
219
222
|
puts "Error when calling DashboardsAPI->list_dashboards: #{e}"
|
@@ -224,12 +227,12 @@ end
|
|
224
227
|
|
225
228
|
This returns an Array which contains the response data, status code and headers.
|
226
229
|
|
227
|
-
> <Array(<DashboardSummary>, Integer, Hash)> list_dashboards_with_http_info
|
230
|
+
> <Array(<DashboardSummary>, Integer, Hash)> list_dashboards_with_http_info(opts)
|
228
231
|
|
229
232
|
```ruby
|
230
233
|
begin
|
231
234
|
# Get all dashboards
|
232
|
-
data, status_code, headers = api_instance.list_dashboards_with_http_info
|
235
|
+
data, status_code, headers = api_instance.list_dashboards_with_http_info(opts)
|
233
236
|
p status_code # => 2xx
|
234
237
|
p headers # => { ... }
|
235
238
|
p data # => <DashboardSummary>
|
@@ -240,7 +243,9 @@ end
|
|
240
243
|
|
241
244
|
### Parameters
|
242
245
|
|
243
|
-
|
246
|
+
| Name | Type | Description | Notes |
|
247
|
+
| ---- | ---- | ----------- | ----- |
|
248
|
+
| **filter_shared** | **Boolean** | When `true`, this query only returns shared custom created or cloned dashboards. | [optional] |
|
244
249
|
|
245
250
|
### Return type
|
246
251
|
|
@@ -4,14 +4,17 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **legend_size** | **String** |
|
7
|
+
| **legend_size** | **String** | (Deprecated) The widget legend was replaced by a tooltip and sidebar. | [optional] |
|
8
|
+
| **markers** | [**Array<WidgetMarker>**](WidgetMarker.md) | List of markers. | [optional] |
|
8
9
|
| **requests** | [**Array<DistributionWidgetRequest>**](DistributionWidgetRequest.md) | Array of one request object to display in the widget. See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`. | |
|
9
|
-
| **show_legend** | **Boolean** |
|
10
|
+
| **show_legend** | **Boolean** | (Deprecated) The widget legend was replaced by a tooltip and sidebar. | [optional] |
|
10
11
|
| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] |
|
11
12
|
| **title** | **String** | Title of the widget. | [optional] |
|
12
13
|
| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] |
|
13
14
|
| **title_size** | **String** | Size of the title. | [optional] |
|
14
15
|
| **type** | [**DistributionWidgetDefinitionType**](DistributionWidgetDefinitionType.md) | | [default to 'distribution'] |
|
16
|
+
| **xaxis** | [**DistributionWidgetXAxis**](DistributionWidgetXAxis.md) | | [optional] |
|
17
|
+
| **yaxis** | [**DistributionWidgetYAxis**](DistributionWidgetYAxis.md) | | [optional] |
|
15
18
|
|
16
19
|
## Example
|
17
20
|
|
@@ -20,13 +23,16 @@ require 'datadog_api_client/v1'
|
|
20
23
|
|
21
24
|
instance = DatadogAPIClient::V1::DistributionWidgetDefinition.new(
|
22
25
|
legend_size: null,
|
26
|
+
markers: null,
|
23
27
|
requests: [{"q":"host:X tags:Y"}],
|
24
28
|
show_legend: null,
|
25
29
|
time: null,
|
26
30
|
title: null,
|
27
31
|
title_align: null,
|
28
32
|
title_size: null,
|
29
|
-
type: null
|
33
|
+
type: null,
|
34
|
+
xaxis: null,
|
35
|
+
yaxis: null
|
30
36
|
)
|
31
37
|
```
|
32
38
|
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# DatadogAPIClient::V1::DistributionWidgetXAxis
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **include_zero** | **Boolean** | True includes zero. | [optional] |
|
8
|
+
| **max** | **String** | Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. | [optional][default to 'auto'] |
|
9
|
+
| **min** | **String** | Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. | [optional][default to 'auto'] |
|
10
|
+
| **scale** | **String** | Specifies the scale type. Possible values are `linear`. | [optional][default to 'linear'] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'datadog_api_client/v1'
|
16
|
+
|
17
|
+
instance = DatadogAPIClient::V1::DistributionWidgetXAxis.new(
|
18
|
+
include_zero: null,
|
19
|
+
max: null,
|
20
|
+
min: null,
|
21
|
+
scale: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# DatadogAPIClient::V1::DistributionWidgetYAxis
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **include_zero** | **Boolean** | True includes zero. | [optional] |
|
8
|
+
| **label** | **String** | The label of the axis to display on the graph. | [optional] |
|
9
|
+
| **max** | **String** | Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. | [optional][default to 'auto'] |
|
10
|
+
| **min** | **String** | Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. | [optional][default to 'auto'] |
|
11
|
+
| **scale** | **String** | Specifies the scale type. Possible values are `linear` or `log`. | [optional][default to 'linear'] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'datadog_api_client/v1'
|
17
|
+
|
18
|
+
instance = DatadogAPIClient::V1::DistributionWidgetYAxis.new(
|
19
|
+
include_zero: null,
|
20
|
+
label: null,
|
21
|
+
max: null,
|
22
|
+
min: null,
|
23
|
+
scale: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/v1/EventsAPI.md
CHANGED
@@ -139,7 +139,7 @@ end
|
|
139
139
|
|
140
140
|
Query the event stream
|
141
141
|
|
142
|
-
The event stream can be queried and filtered by time, priority, sources and tags. **Notes**: - If the event you’re querying contains markdown formatting of any kind, you may see characters such as `%`,`\\`,`n` in your output. - This endpoint returns a maximum of `1000` most recent results. To return additional results, identify the last timestamp of the last result and set that as the `end` query time to paginate the results.
|
142
|
+
The event stream can be queried and filtered by time, priority, sources and tags. **Notes**: - If the event you’re querying contains markdown formatting of any kind, you may see characters such as `%`,`\\`,`n` in your output. - This endpoint returns a maximum of `1000` most recent results. To return additional results, identify the last timestamp of the last result and set that as the `end` query time to paginate the results. You can also use the page parameter to specify which set of `1000` results to return.
|
143
143
|
|
144
144
|
### Examples
|
145
145
|
|
@@ -152,7 +152,9 @@ opts = {
|
|
152
152
|
priority: DatadogAPIClient::V1::EventPriority::NORMAL, # EventPriority | Priority of your events, either `low` or `normal`.
|
153
153
|
sources: 'sources_example', # String | A comma separated string of sources.
|
154
154
|
tags: 'host:host0', # String | A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope.
|
155
|
-
unaggregated: true # Boolean | Set unaggregated to `true` to return all events within the specified [`start`,`end`] timeframe. Otherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe, it won't be available in the output.
|
155
|
+
unaggregated: true, # Boolean | Set unaggregated to `true` to return all events within the specified [`start`,`end`] timeframe. Otherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe, it won't be available in the output. Aggregated events with `is_aggregate=true` in the response will still be returned unless exclude_aggregate is set to `true.`
|
156
|
+
exclude_aggregate: true, # Boolean | Set `exclude_aggregate` to `true` to only return unaggregated events where `is_aggregate=false` in the response. If the `exclude_aggregate` parameter is set to `true`, then the unaggregated parameter is ignored and will be `true` by default.
|
157
|
+
page: 56 # Integer | By default 1000 results are returned per request. Set page to the number of the page to return with `0` being the first page. The page parameter can only be used when either unaggregated or exclude_aggregate is set to `true.`
|
156
158
|
}
|
157
159
|
|
158
160
|
begin
|
@@ -191,7 +193,9 @@ end
|
|
191
193
|
| **priority** | **EventPriority** | Priority of your events, either `low` or `normal`. | [optional] |
|
192
194
|
| **sources** | **String** | A comma separated string of sources. | [optional] |
|
193
195
|
| **tags** | **String** | A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. | [optional] |
|
194
|
-
| **unaggregated** | **Boolean** | Set unaggregated to `true` to return all events within the specified [`start`,`end`] timeframe. Otherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe, it won't be available in the output. | [optional] |
|
196
|
+
| **unaggregated** | **Boolean** | Set unaggregated to `true` to return all events within the specified [`start`,`end`] timeframe. Otherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe, it won't be available in the output. Aggregated events with `is_aggregate=true` in the response will still be returned unless exclude_aggregate is set to `true.` | [optional] |
|
197
|
+
| **exclude_aggregate** | **Boolean** | Set `exclude_aggregate` to `true` to only return unaggregated events where `is_aggregate=false` in the response. If the `exclude_aggregate` parameter is set to `true`, then the unaggregated parameter is ignored and will be `true` by default. | [optional] |
|
198
|
+
| **page** | **Integer** | By default 1000 results are returned per request. Set page to the number of the page to return with `0` being the first page. The page parameter can only be used when either unaggregated or exclude_aggregate is set to `true.` | [optional] |
|
195
199
|
|
196
200
|
### Return type
|
197
201
|
|
@@ -4,8 +4,12 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **background_color** | **String** | Background color of the group title. | [optional] |
|
8
|
+
| **banner_img** | **String** | URL of image to display as a banner for the group. | [optional] |
|
7
9
|
| **layout_type** | [**WidgetLayoutType**](WidgetLayoutType.md) | | |
|
10
|
+
| **show_title** | **Boolean** | Whether to show the title or not. | [optional][default to true] |
|
8
11
|
| **title** | **String** | Title of the widget. | [optional] |
|
12
|
+
| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] |
|
9
13
|
| **type** | [**GroupWidgetDefinitionType**](GroupWidgetDefinitionType.md) | | [default to 'group'] |
|
10
14
|
| **widgets** | [**Array<Widget>**](Widget.md) | List of widget groups. | |
|
11
15
|
|
@@ -15,8 +19,12 @@
|
|
15
19
|
require 'datadog_api_client/v1'
|
16
20
|
|
17
21
|
instance = DatadogAPIClient::V1::GroupWidgetDefinition.new(
|
22
|
+
background_color: null,
|
23
|
+
banner_img: null,
|
18
24
|
layout_type: null,
|
25
|
+
show_title: null,
|
19
26
|
title: null,
|
27
|
+
title_align: null,
|
20
28
|
type: null,
|
21
29
|
widgets: [{"definition":{"requests":{"fill":{"q":"system.cpu.user"}},"type":"hostmap"}}]
|
22
30
|
)
|
@@ -4,10 +4,15 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **has_background** | **Boolean** | Whether to display a background or not. | [optional][default to true] |
|
8
|
+
| **has_border** | **Boolean** | Whether to display a border or not. | [optional][default to true] |
|
9
|
+
| **horizontal_align** | [**WidgetHorizontalAlign**](WidgetHorizontalAlign.md) | | [optional] |
|
7
10
|
| **margin** | [**WidgetMargin**](WidgetMargin.md) | | [optional] |
|
8
11
|
| **sizing** | [**WidgetImageSizing**](WidgetImageSizing.md) | | [optional] |
|
9
12
|
| **type** | [**ImageWidgetDefinitionType**](ImageWidgetDefinitionType.md) | | [default to 'image'] |
|
10
13
|
| **url** | **String** | URL of the image. | |
|
14
|
+
| **url_dark_theme** | **String** | URL of the image in dark mode. | [optional] |
|
15
|
+
| **vertical_align** | [**WidgetVerticalAlign**](WidgetVerticalAlign.md) | | [optional] |
|
11
16
|
|
12
17
|
## Example
|
13
18
|
|
@@ -15,10 +20,15 @@
|
|
15
20
|
require 'datadog_api_client/v1'
|
16
21
|
|
17
22
|
instance = DatadogAPIClient::V1::ImageWidgetDefinition.new(
|
23
|
+
has_background: true,
|
24
|
+
has_border: true,
|
25
|
+
horizontal_align: null,
|
18
26
|
margin: null,
|
19
27
|
sizing: null,
|
20
28
|
type: null,
|
21
|
-
url:
|
29
|
+
url: https://example.com/image.png,
|
30
|
+
url_dark_theme: https://example.com/image-dark-mode.png,
|
31
|
+
vertical_align: null
|
22
32
|
)
|
23
33
|
```
|
24
34
|
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# DatadogAPIClient::V1::LogsByRetention
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **orgs** | [**LogsByRetentionOrgs**](LogsByRetentionOrgs.md) | | [optional] |
|
8
|
+
| **usage** | [**Array<LogsRetentionAggSumUsage>**](LogsRetentionAggSumUsage.md) | Aggregated index logs usage for each retention period with usage. | [optional] |
|
9
|
+
| **usage_by_month** | [**LogsByRetentionMonthlyUsage**](LogsByRetentionMonthlyUsage.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'datadog_api_client/v1'
|
15
|
+
|
16
|
+
instance = DatadogAPIClient::V1::LogsByRetention.new(
|
17
|
+
orgs: null,
|
18
|
+
usage: null,
|
19
|
+
usage_by_month: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# DatadogAPIClient::V1::LogsByRetentionMonthlyUsage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **date** | **String** | The month for the usage. | [optional] |
|
8
|
+
| **usage** | [**Array<LogsRetentionSumUsage>**](LogsRetentionSumUsage.md) | Indexed logs usage for each active retention for the month. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'datadog_api_client/v1'
|
14
|
+
|
15
|
+
instance = DatadogAPIClient::V1::LogsByRetentionMonthlyUsage.new(
|
16
|
+
date: null,
|
17
|
+
usage: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DatadogAPIClient::V1::LogsByRetentionOrgUsage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **usage** | [**Array<LogsRetentionSumUsage>**](LogsRetentionSumUsage.md) | Indexed logs usage for each active retention for the organization. | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'datadog_api_client/v1'
|
13
|
+
|
14
|
+
instance = DatadogAPIClient::V1::LogsByRetentionOrgUsage.new(
|
15
|
+
usage: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DatadogAPIClient::V1::LogsByRetentionOrgs
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **usage** | [**Array<LogsByRetentionOrgUsage>**](LogsByRetentionOrgUsage.md) | Indexed logs usage summary for each organization. | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'datadog_api_client/v1'
|
13
|
+
|
14
|
+
instance = DatadogAPIClient::V1::LogsByRetentionOrgs.new(
|
15
|
+
usage: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# DatadogAPIClient::V1::LogsRetentionAggSumUsage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **logs_indexed_logs_usage_agg_sum** | **Integer** | Total indexed logs for this retention period. | [optional] |
|
8
|
+
| **logs_live_indexed_logs_usage_agg_sum** | **Integer** | Live indexed logs for this retention period. | [optional] |
|
9
|
+
| **logs_rehydrated_indexed_logs_usage_agg_sum** | **Integer** | Rehydrated indexed logs for this retention period. | [optional] |
|
10
|
+
| **retention** | **String** | The retention period in days or \"custom\" for all custom retention periods. | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'datadog_api_client/v1'
|
16
|
+
|
17
|
+
instance = DatadogAPIClient::V1::LogsRetentionAggSumUsage.new(
|
18
|
+
logs_indexed_logs_usage_agg_sum: null,
|
19
|
+
logs_live_indexed_logs_usage_agg_sum: null,
|
20
|
+
logs_rehydrated_indexed_logs_usage_agg_sum: null,
|
21
|
+
retention: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# DatadogAPIClient::V1::LogsRetentionSumUsage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **logs_indexed_logs_usage_sum** | **Integer** | Total indexed logs for this retention period. | [optional] |
|
8
|
+
| **logs_live_indexed_logs_usage_sum** | **Integer** | Live indexed logs for this retention period. | [optional] |
|
9
|
+
| **logs_rehydrated_indexed_logs_usage_sum** | **Integer** | Rehydrated indexed logs for this retention period. | [optional] |
|
10
|
+
| **retention** | **String** | The retention period in days or \"custom\" for all custom retention periods. | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'datadog_api_client/v1'
|
16
|
+
|
17
|
+
instance = DatadogAPIClient::V1::LogsRetentionSumUsage.new(
|
18
|
+
logs_indexed_logs_usage_sum: null,
|
19
|
+
logs_live_indexed_logs_usage_sum: null,
|
20
|
+
logs_rehydrated_indexed_logs_usage_sum: null,
|
21
|
+
retention: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/v1/MonitorsAPI.md
CHANGED
@@ -81,7 +81,7 @@ end
|
|
81
81
|
|
82
82
|
Create a monitor
|
83
83
|
|
84
|
-
Create a monitor using the specified options. #### Monitor Types The type of monitor chosen from: - anomaly: `query alert` - APM: `query alert` or `trace-analytics alert` - composite: `composite` - custom: `service check` - event: `event alert` - forecast: `query alert` - host: `service check` - integration: `query alert` or `service check` - live process: `process alert` - logs: `log alert` - metric: `metric alert` - network: `service check` - outlier: `query alert` - process: `service check` - rum: `rum alert` - watchdog: `event alert` - event-v2: `event-v2 alert` #### Query Types **Metric Alert Query** Example: `time_aggr(time_window):space_aggr:metric{tags} [by {key}] operator #` - `time_aggr`: avg, sum, max, min, change, or pct_change - `time_window`: `last_#m` (with `#` between 1 and 2880 depending on the monitor type) or `last_#h`(with `#` between 1 and 48 depending on the monitor type), or `last_1d` - `space_aggr`: avg, sum, min, or max - `tags`: one or more tags (comma-separated), or * - `key`: a 'key' in key:value tag syntax; defines a separate alert for each tag in the group (multi-alert) - `operator`: <, <=, >, >=, ==, or != - `#`: an integer or decimal number used to set the threshold If you are using the `_change_` or `_pct_change_` time aggregator, instead use `change_aggr(time_aggr(time_window), timeshift):space_aggr:metric{tags} [by {key}] operator #` with: - `change_aggr` change, pct_change - `time_aggr` avg, sum, max, min [Learn more](https://docs.datadoghq.com/monitors/monitor_types/#define-the-conditions) - `time_window` last\\_#m (between 1 and 2880 depending on the monitor type), last\\_#h (between 1 and 48 depending on the monitor type), or last_#d (1 or 2) - `timeshift` #m_ago (5, 10, 15, or 30), #h_ago (1, 2, or 4), or 1d_ago Use this to create an outlier monitor using the following query: `avg(last_30m):outliers(avg:system.cpu.user{role:es-events-data} by {host}, 'dbscan', 7) > 0` **Service Check Query** Example: `\"check\".over(tags).last(count).count_by_status()` - **`check`** name of the check, e.g. `datadog.agent.up` - **`tags`** one or more quoted tags (comma-separated), or \"*\". e.g.: `.over(\"env:prod\", \"role:db\")` - **`count`** must be at greater than or equal to your max threshold (defined in the `options`). It is limited to 100. For example, if you've specified to notify on 1 critical, 3 ok, and 2 warn statuses, `count` should be 3. **Event Alert Query** Example: `events('sources:nagios status:error,warning priority:normal tags: \"string query\"').rollup(\"count\").last(\"1h\")\"` - **`event`**, the event query string: - **`string_query`** free text query to match against event title and text. - **`sources`** event sources (comma-separated). - **`status`** event statuses (comma-separated). Valid options: error, warn, and info. - **`priority`** event priorities (comma-separated). Valid options: low, normal, all. - **`host`** event reporting host (comma-separated). - **`tags`** event tags (comma-separated). - **`excluded_tags`** excluded event tags (comma-separated). - **`rollup`** the stats roll-up method. `count` is the only supported method now. - **`last`** the timeframe to roll up the counts. Examples: 45m, 4h. Supported timeframes: m, h and d. This value should not exceed 48 hours. **NOTE** Only available on US1 and EU. **Event V2 Alert Query** Example: `events(query).rollup(rollup_method[, measure]).last(time_window) operator #` - **`query`** The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - **`rollup_method`** The stats roll-up method - supports `count`, `avg` and `cardinality`. - **`measure`** For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - **`time_window`** #m (5, 10, 15, or 30), #h (1, 2, or 4, 24). - **`operator`** `<`, `<=`, `>`, `>=`, `==`, or `!=`. - **`#`** an integer or decimal number used to set the threshold. **NOTE** Only available on US1-FED, US3, and in closed beta on EU and US1. **Process Alert Query** Example: `processes(search).over(tags).rollup('count').last(timeframe) operator #` - **`search`** free text search string for querying processes. Matching processes match results on the [Live Processes](https://docs.datadoghq.com/infrastructure/process/?tab=linuxwindows) page. - **`tags`** one or more tags (comma-separated) - **`timeframe`** the timeframe to roll up the counts. Examples: 10m, 4h. Supported timeframes: s, m, h and d - **`operator`** <, <=, >, >=, ==, or != - **`#`** an integer or decimal number used to set the threshold **Logs Alert Query** Example: `logs(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator #` - **`query`** The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - **`index_name`** For multi-index organizations, the log index in which the request is performed. - **`rollup_method`** The stats roll-up method - supports `count`, `avg` and `cardinality`. - **`measure`** For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - **`time_window`** #m (between 1 and 2880), #h (between 1 and 48) - **`operator`** `<`, `<=`, `>`, `>=`, `==`, or `!=`. - **`#`** an integer or decimal number used to set the threshold. **Composite Query** Example: `12345 && 67890`, where `12345` and `67890` are the IDs of non-composite monitors * **`name`** [*required*, *default* = **dynamic, based on query**]: The name of the alert. * **`message`** [*required*, *default* = **dynamic, based on query**]: A message to include with notifications for this monitor. Email notifications can be sent to specific users by using the same '@username' notation as events. * **`tags`** [*optional*, *default* = **empty list**]: A list of tags to associate with your monitor. When getting all monitor details via the API, use the `monitor_tags` argument to filter results by these tags. It is only available via the API and isn't visible or editable in the Datadog UI.
|
84
|
+
Create a monitor using the specified options. #### Monitor Types The type of monitor chosen from: - anomaly: `query alert` - APM: `query alert` or `trace-analytics alert` - composite: `composite` - custom: `service check` - event: `event alert` - forecast: `query alert` - host: `service check` - integration: `query alert` or `service check` - live process: `process alert` - logs: `log alert` - metric: `metric alert` - network: `service check` - outlier: `query alert` - process: `service check` - rum: `rum alert` - SLO: `slo alert` - watchdog: `event alert` - event-v2: `event-v2 alert` #### Query Types **Metric Alert Query** Example: `time_aggr(time_window):space_aggr:metric{tags} [by {key}] operator #` - `time_aggr`: avg, sum, max, min, change, or pct_change - `time_window`: `last_#m` (with `#` between 1 and 2880 depending on the monitor type) or `last_#h`(with `#` between 1 and 48 depending on the monitor type), or `last_1d` - `space_aggr`: avg, sum, min, or max - `tags`: one or more tags (comma-separated), or * - `key`: a 'key' in key:value tag syntax; defines a separate alert for each tag in the group (multi-alert) - `operator`: <, <=, >, >=, ==, or != - `#`: an integer or decimal number used to set the threshold If you are using the `_change_` or `_pct_change_` time aggregator, instead use `change_aggr(time_aggr(time_window), timeshift):space_aggr:metric{tags} [by {key}] operator #` with: - `change_aggr` change, pct_change - `time_aggr` avg, sum, max, min [Learn more](https://docs.datadoghq.com/monitors/monitor_types/#define-the-conditions) - `time_window` last\\_#m (between 1 and 2880 depending on the monitor type), last\\_#h (between 1 and 48 depending on the monitor type), or last_#d (1 or 2) - `timeshift` #m_ago (5, 10, 15, or 30), #h_ago (1, 2, or 4), or 1d_ago Use this to create an outlier monitor using the following query: `avg(last_30m):outliers(avg:system.cpu.user{role:es-events-data} by {host}, 'dbscan', 7) > 0` **Service Check Query** Example: `\"check\".over(tags).last(count).count_by_status()` - **`check`** name of the check, e.g. `datadog.agent.up` - **`tags`** one or more quoted tags (comma-separated), or \"*\". e.g.: `.over(\"env:prod\", \"role:db\")` - **`count`** must be at greater than or equal to your max threshold (defined in the `options`). It is limited to 100. For example, if you've specified to notify on 1 critical, 3 ok, and 2 warn statuses, `count` should be 3. **Event Alert Query** Example: `events('sources:nagios status:error,warning priority:normal tags: \"string query\"').rollup(\"count\").last(\"1h\")\"` - **`event`**, the event query string: - **`string_query`** free text query to match against event title and text. - **`sources`** event sources (comma-separated). - **`status`** event statuses (comma-separated). Valid options: error, warn, and info. - **`priority`** event priorities (comma-separated). Valid options: low, normal, all. - **`host`** event reporting host (comma-separated). - **`tags`** event tags (comma-separated). - **`excluded_tags`** excluded event tags (comma-separated). - **`rollup`** the stats roll-up method. `count` is the only supported method now. - **`last`** the timeframe to roll up the counts. Examples: 45m, 4h. Supported timeframes: m, h and d. This value should not exceed 48 hours. **NOTE** Only available on US1 and EU. **Event V2 Alert Query** Example: `events(query).rollup(rollup_method[, measure]).last(time_window) operator #` - **`query`** The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - **`rollup_method`** The stats roll-up method - supports `count`, `avg` and `cardinality`. - **`measure`** For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - **`time_window`** #m (5, 10, 15, or 30), #h (1, 2, or 4, 24). - **`operator`** `<`, `<=`, `>`, `>=`, `==`, or `!=`. - **`#`** an integer or decimal number used to set the threshold. **NOTE** Only available on US1-FED, US3, and in closed beta on EU and US1. **Process Alert Query** Example: `processes(search).over(tags).rollup('count').last(timeframe) operator #` - **`search`** free text search string for querying processes. Matching processes match results on the [Live Processes](https://docs.datadoghq.com/infrastructure/process/?tab=linuxwindows) page. - **`tags`** one or more tags (comma-separated) - **`timeframe`** the timeframe to roll up the counts. Examples: 10m, 4h. Supported timeframes: s, m, h and d - **`operator`** <, <=, >, >=, ==, or != - **`#`** an integer or decimal number used to set the threshold **Logs Alert Query** Example: `logs(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator #` - **`query`** The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). - **`index_name`** For multi-index organizations, the log index in which the request is performed. - **`rollup_method`** The stats roll-up method - supports `count`, `avg` and `cardinality`. - **`measure`** For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. - **`time_window`** #m (between 1 and 2880), #h (between 1 and 48) - **`operator`** `<`, `<=`, `>`, `>=`, `==`, or `!=`. - **`#`** an integer or decimal number used to set the threshold. **Composite Query** Example: `12345 && 67890`, where `12345` and `67890` are the IDs of non-composite monitors * **`name`** [*required*, *default* = **dynamic, based on query**]: The name of the alert. * **`message`** [*required*, *default* = **dynamic, based on query**]: A message to include with notifications for this monitor. Email notifications can be sent to specific users by using the same '@username' notation as events. * **`tags`** [*optional*, *default* = **empty list**]: A list of tags to associate with your monitor. When getting all monitor details via the API, use the `monitor_tags` argument to filter results by these tags. It is only available via the API and isn't visible or editable in the Datadog UI. **SLO Alert Query** Example: `error_budget(\"slo_id\").over(\"time_window\") operator #` - **`slo_id`**: The alphanumeric SLO ID of the SLO you are configuring the alert for. - **`time_window`**: The time window of the SLO target you wish to alert on. Valid options: `7d`, `30d`, `90d`. - **`operator`**: `>=` or `>`
|
85
85
|
|
86
86
|
### Examples
|
87
87
|
|
@@ -7,11 +7,13 @@
|
|
7
7
|
| **background_color** | **String** | Background color of the note. | [optional] |
|
8
8
|
| **content** | **String** | Content of the note. | |
|
9
9
|
| **font_size** | **String** | Size of the text. | [optional] |
|
10
|
+
| **has_padding** | **Boolean** | Whether to add padding or not. | [optional][default to true] |
|
10
11
|
| **show_tick** | **Boolean** | Whether to show a tick or not. | [optional] |
|
11
12
|
| **text_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] |
|
12
13
|
| **tick_edge** | [**WidgetTickEdge**](WidgetTickEdge.md) | | [optional] |
|
13
14
|
| **tick_pos** | **String** | Where to position the tick on an edge. | [optional] |
|
14
15
|
| **type** | [**NoteWidgetDefinitionType**](NoteWidgetDefinitionType.md) | | [default to 'note'] |
|
16
|
+
| **vertical_align** | [**WidgetVerticalAlign**](WidgetVerticalAlign.md) | | [optional] |
|
15
17
|
|
16
18
|
## Example
|
17
19
|
|
@@ -22,11 +24,13 @@ instance = DatadogAPIClient::V1::NoteWidgetDefinition.new(
|
|
22
24
|
background_color: null,
|
23
25
|
content: ,
|
24
26
|
font_size: null,
|
27
|
+
has_padding: null,
|
25
28
|
show_tick: null,
|
26
29
|
text_align: null,
|
27
30
|
tick_edge: null,
|
28
31
|
tick_pos: null,
|
29
|
-
type: null
|
32
|
+
type: null,
|
33
|
+
vertical_align: null
|
30
34
|
)
|
31
35
|
```
|
32
36
|
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# DatadogAPIClient::V1::NotebookAbsoluteTime
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **_end** | **Time** | The end time. | |
|
8
|
+
| **live** | **Boolean** | Indicates whether the timeframe should be shifted to end at the current time. | [optional] |
|
9
|
+
| **start** | **Time** | The start time. | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'datadog_api_client/v1'
|
15
|
+
|
16
|
+
instance = DatadogAPIClient::V1::NotebookAbsoluteTime.new(
|
17
|
+
_end: 2021-02-24T20:18:28Z,
|
18
|
+
live: null,
|
19
|
+
start: 2021-02-24T19:18:28Z
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,34 @@
|
|
1
|
+
# DatadogAPIClient::V1::NotebookAuthor
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **created_at** | **Time** | Creation time of the user. | [optional] |
|
8
|
+
| **disabled** | **Boolean** | Whether the user is disabled. | [optional] |
|
9
|
+
| **email** | **String** | Email of the user. | [optional] |
|
10
|
+
| **handle** | **String** | Handle of the user. | [optional] |
|
11
|
+
| **icon** | **String** | URL of the user's icon. | [optional] |
|
12
|
+
| **name** | **String** | Name of the user. | [optional] |
|
13
|
+
| **status** | **String** | Status of the user. | [optional] |
|
14
|
+
| **title** | **String** | Title of the user. | [optional] |
|
15
|
+
| **verified** | **Boolean** | Whether the user is verified. | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'datadog_api_client/v1'
|
21
|
+
|
22
|
+
instance = DatadogAPIClient::V1::NotebookAuthor.new(
|
23
|
+
created_at: null,
|
24
|
+
disabled: null,
|
25
|
+
email: null,
|
26
|
+
handle: null,
|
27
|
+
icon: null,
|
28
|
+
name: null,
|
29
|
+
status: null,
|
30
|
+
title: null,
|
31
|
+
verified: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|