ci_app_pipeline_events

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

Overview

Name	ci_app_pipeline_events
Type	Resource
Id	datadog.software_delivery.ci_app_pipeline_events

Fields

The following fields are returned by SELECT queries:

list_ciapp_pipeline_events

Name	Datatype	Description
id	string	Unique ID of the event. (example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA)
attributes	object	JSON object containing all event attributes and their associated values.
type	string	Type of the event. (example: cipipeline)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_ciapp_pipeline_events	select	region	filter[query], filter[from], filter[to], sort, page[cursor], page[limit]	List endpoint returns CI Visibility pipeline events that match a search query. Results are paginated similarly to logs. Use this endpoint to see your latest pipeline events.
create_ciapp_pipeline_event	insert	region		Send your pipeline event to your Datadog platform over HTTP. For details about how pipeline executions are modeled and what execution types we support, see Pipeline Data Model And Execution Types. Multiple events can be sent in an array (up to 1000). Pipeline events can be submitted with a timestamp that is up to 18 hours in the past.
aggregate_ciapp_pipeline_events	exec	region		Use this API endpoint to aggregate CI Visibility pipeline events into buckets of computed metrics and timeseries.
search_ciapp_pipeline_events	exec	region		List endpoint returns CI Visibility pipeline events that match a search query. Results are paginated similarly to logs. Use this endpoint to build complex events filtering and search.

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.

Name	Datatype	Description
region	string	(default: datadoghq.com)
filter[from]	string (date-time)	Minimum timestamp for requested events. (example: 2019-01-02T09:42:36.320Z)
filter[query]	string	Search query following log syntax. (example: @ci.provider.name:github @ci.pipeline.name:Pull Request Labeler)
filter[to]	string (date-time)	Maximum timestamp for requested events. (example: 2019-01-03T09:42:36.320Z)
page[cursor]	string	List following results with a cursor provided in the previous query. (example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==)
page[limit]	integer (int32)	Maximum number of events in the response. (example: 25)
sort	string	Order of events in results.

SELECT examples

list_ciapp_pipeline_events

List endpoint returns CI Visibility pipeline events that match a search query.
Results are paginated similarly to logs.

Use this endpoint to see your latest pipeline events.

SELECT
id,
attributes,
type
FROM datadog.software_delivery.ci_app_pipeline_events
WHERE region = '{{ region }}' -- required
AND filter[query] = '{{ filter[query] }}'
AND filter[from] = '{{ filter[from] }}'
AND filter[to] = '{{ filter[to] }}'
AND sort = '{{ sort }}'
AND page[cursor] = '{{ page[cursor] }}'
AND page[limit] = '{{ page[limit] }}'
;

INSERT examples

create_ciapp_pipeline_event

Send your pipeline event to your Datadog platform over HTTP. For details about how pipeline executions are modeled and what execution types we support, see Pipeline Data Model And Execution Types.

Multiple events can be sent in an array (up to 1000).

Pipeline events can be submitted with a timestamp that is up to 18 hours in the past.

INSERT INTO datadog.software_delivery.ci_app_pipeline_events (
data__data,
region
)
SELECT 
'{{ data }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: ci_app_pipeline_events
  props:
    - name: region
      value: string
      description: Required parameter for the ci_app_pipeline_events resource.
    - name: data
      value: string
      description: |
        Data of the pipeline events to create.

Lifecycle Methods

aggregate_ciapp_pipeline_events

Use this API endpoint to aggregate CI Visibility pipeline events into buckets of computed metrics and timeseries.

EXEC datadog.software_delivery.ci_app_pipeline_events.aggregate_ciapp_pipeline_events 
@region='{{ region }}' --required 
@@json=
'{
"compute": "{{ compute }}", 
"filter": "{{ filter }}", 
"group_by": "{{ group_by }}", 
"options": "{{ options }}"
}'
;

search_ciapp_pipeline_events

List endpoint returns CI Visibility pipeline events that match a search query.
Results are paginated similarly to logs.

Use this endpoint to build complex events filtering and search.

EXEC datadog.software_delivery.ci_app_pipeline_events.search_ciapp_pipeline_events 
@region='{{ region }}' --required 
@@json=
'{
"filter": "{{ filter }}", 
"options": "{{ options }}", 
"page": "{{ page }}", 
"sort": "{{ sort }}"
}'
;