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. (cipipeline) (example: cipipeline)

Methods

The following methods are available for this resource:

Name	Accessible by	Optional Params	Description
`list_ciapp_pipeline_events`	`select`	`filter[query]`, `filter[from]`, `filter[to]`, `sort`, `page[cursor]`, `page[limit]`	List endpoint returns CI Visibility pipeline events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).<br />[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).<br /><br />Use this endpoint to see your latest pipeline events.
`create_ciapp_pipeline_event`	`insert`		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](https://docs.datadoghq.com/continuous_integration/guides/pipeline_data_model/).<br /><br />Multiple events can be sent in an array (up to 1000).<br /><br />Pipeline events can be submitted with a timestamp that is up to 18 hours in the past.<br />The duration between the event start and end times cannot exceed 1 year.
`aggregate_ciapp_pipeline_events`	`exec`		Use this API endpoint to aggregate CI Visibility pipeline events into buckets of computed metrics and timeseries.
`search_ciapp_pipeline_events`	`exec`		List endpoint returns CI Visibility pipeline events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).<br />[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).<br /><br />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
`site`	`string`	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
`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](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/). [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). Use this endpoint to see your latest pipeline events.

SELECT
id,
attributes,
type
FROM datadog.software_delivery.ci_app_pipeline_events
WHERE 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
Manifest

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](https://docs.datadoghq.com/continuous_integration/guides/pipeline_data_model/). 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. The duration between the event start and end times cannot exceed 1 year.

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

# Description fields are for documentation purposes
- name: ci_app_pipeline_events
props:
  - name: data
    description: |
      Data of the pipeline events to create.
    value:
      attributes:
        env: "{{ env }}"
        provider_name: "{{ provider_name }}"
        resource:
          end: "{{ end }}"
          error:
            domain: "{{ domain }}"
            message: "{{ message }}"
            stack: "{{ stack }}"
            type: "{{ type }}"
          git:
            author_email: "{{ author_email }}"
            author_name: "{{ author_name }}"
            author_time: "{{ author_time }}"
            branch: "{{ branch }}"
            commit_time: "{{ commit_time }}"
            committer_email: "{{ committer_email }}"
            committer_name: "{{ committer_name }}"
            default_branch: "{{ default_branch }}"
            message: "{{ message }}"
            repository_url: "{{ repository_url }}"
            sha: "{{ sha }}"
            tag: "{{ tag }}"
          is_manual: {{ is_manual }}
          is_resumed: {{ is_resumed }}
          level: "{{ level }}"
          metrics:
            - "{{ metrics }}"
          name: "{{ name }}"
          node:
            hostname: "{{ hostname }}"
            labels:
              - "{{ labels }}"
            name: "{{ name }}"
            workspace: "{{ workspace }}"
          parameters: "{{ parameters }}"
          parent_pipeline:
            id: "{{ id }}"
            url: "{{ url }}"
          partial_retry: {{ partial_retry }}
          pipeline_id: "{{ pipeline_id }}"
          previous_attempt:
            id: "{{ id }}"
            url: "{{ url }}"
          queue_time: {{ queue_time }}
          start: "{{ start }}"
          status: "{{ status }}"
          tags:
            - "{{ tags }}"
          unique_id: "{{ unique_id }}"
          url: "{{ url }}"
          dependencies:
            - "{{ dependencies }}"
          id: "{{ id }}"
          pipeline_name: "{{ pipeline_name }}"
          pipeline_unique_id: "{{ pipeline_unique_id }}"
          stage_id: "{{ stage_id }}"
          stage_name: "{{ stage_name }}"
          job_id: "{{ job_id }}"
          job_name: "{{ job_name }}"
        service: "{{ service }}"
      type: "{{ type }}"

Lifecycle Methods

EXEC variables use wire (API) names.

aggregate_ciapp_pipeline_events
search_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 
@@json=
'{
"compute": "{{ compute }}", 
"filter": "{{ filter }}", 
"group_by": "{{ group_by }}", 
"options": "{{ options }}"
}'
;

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

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

Lifecycle Methods​