Skip to main content

slo_report_job

Creates, updates, deletes, gets or lists a slo_report_job resource.

Overview

Nameslo_report_job
TypeResource
Iddatadog.service_management.slo_report_job

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringThe ID of the report job. (example: dc8d92aa-e0af-11ee-af21-1feeaccaa3a3)
attributesobjectThe attributes portion of the SLO report status response.
typestringThe type of ID. (example: report_id)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_sloreport_job_statusselectreport_id, regionGet the status of the SLO report job.
create_sloreport_jobinsertregion, data__dataCreate a job to generate an SLO report. The report job is processed asynchronously and eventually results in a CSV report being available for download.

Check the status of the job and download the CSV report using the returned report_id.
get_sloreportexecreport_id, regionDownload an SLO report. This can only be performed after the report job has completed.

Reports are not guaranteed to exist indefinitely. Datadog recommends that you download the report as soon as it is available.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstring(default: datadoghq.com)
report_idstringThe ID of the report job.

SELECT examples

Get the status of the SLO report job.

SELECT
id,
attributes,
type
FROM datadog.service_management.slo_report_job
WHERE report_id = '{{ report_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

Create a job to generate an SLO report. The report job is processed asynchronously and eventually results in a CSV report being available for download.

Check the status of the job and download the CSV report using the returned report_id.

INSERT INTO datadog.service_management.slo_report_job (
data__data,
region
)
SELECT
'{{ data }}' /* required */,
'{{ region }}'
RETURNING
data
;

Lifecycle Methods

Download an SLO report. This can only be performed after the report job has completed.

Reports are not guaranteed to exist indefinitely. Datadog recommends that you download the report as soon as it is available.

EXEC datadog.service_management.slo_report_job.get_sloreport 
@report_id='{{ report_id }}' --required,
@region='{{ region }}' --required
;