Skip to content

Commit

Permalink
Merge pull request #142 from stackql/feature/doc-updates
Browse files Browse the repository at this point in the history
updated datadog
  • Loading branch information
jeffreyaven authored May 3, 2024
2 parents 9201ff0 + 4353a95 commit 1bae12f
Show file tree
Hide file tree
Showing 140 changed files with 1,401 additions and 1,064 deletions.
8 changes: 5 additions & 3 deletions docs/datadog-docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@ custom_edit_url: null
image: /img/providers/datadog/stackql-datadog-provider-featured-image.png
id: datadog-doc
slug: /providers/datadog

---

import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';

Monitoring, alerting and reporting platform for cloud platforms and applications.

:::info Provider Summary (v23.12.00194)
Expand Down Expand Up @@ -49,8 +51,8 @@ REGISTRY PULL datadog;

The following system environment variables are used for authentication by default:

- `DD_API_KEY` - Datadog API key (see [Datadog API Key Documentation](https://docs.datadoghq.com/account_management/api-app-keys/#api-keys))
- `DD_APP_KEY` - Datadog Application Key (see [Datadog Application Key Documentation](https://docs.datadoghq.com/account_management/api-app-keys/#application-keys))
- <CopyableCode code="DD_API_KEY" /> - Datadog API key (see [Datadog API Key Documentation](https://docs.datadoghq.com/account_management/api-app-keys/#api-keys))
- <CopyableCode code="DD_APP_KEY" /> - Datadog Application Key (see [Datadog Application Key Documentation](https://docs.datadoghq.com/account_management/api-app-keys/#application-keys))

These variables are sourced at runtime (from the local machine or as CI variables/secrets).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,33 @@ description: Query, monitor, and manage Datadog resources using SQL
custom_edit_url: null
image: /img/providers/datadog/stackql-datadog-provider-featured-image.png
---



import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';




## Overview
<table><tbody>
<tr><td><b>Name</b></td><td><code>apm_retention_filters</code></td></tr>
<tr><td><b>Type</b></td><td>Resource</td></tr>
<tr><td><b>Id</b></td><td><code>datadog.apm_retention_filters.apm_retention_filters</code></td></tr>
<tr><td><b>Id</b></td><td><CopyableCode code="datadog.apm_retention_filters.apm_retention_filters" /></td></tr>
</tbody></table>

## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
| `id` | `string` | The ID of the retention filter. |
| `attributes` | `object` | The attributes of the retention filter. |
| `type` | `string` | The type of the resource. |
| <CopyableCode code="id" /> | `string` | The ID of the retention filter. |
| <CopyableCode code="attributes" /> | `object` | The attributes of the retention filter. |
| <CopyableCode code="type" /> | `string` | The type of the resource. |
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| `get_apm_retention_filter` | `SELECT` | `filter_id, dd_site` | Get an APM retention filter. |
| `list_apm_retention_filters` | `SELECT` | `dd_site` | Get the list of APM retention filters. |
| `create_apm_retention_filter` | `INSERT` | `data__data, dd_site` | Create a retention filter to index spans in your organization.<br />Returns the retention filter definition when the request is successful. |
| `delete_apm_retention_filter` | `DELETE` | `filter_id, dd_site` | Delete a specific retention filter from your organization. |
| `_get_apm_retention_filter` | `EXEC` | `filter_id, dd_site` | Get an APM retention filter. |
| `_list_apm_retention_filters` | `EXEC` | `dd_site` | Get the list of APM retention filters. |
| `reorder_apm_retention_filters` | `EXEC` | `data__data, dd_site` | Re-order the execution order of retention filters. |
| `update_apm_retention_filter` | `EXEC` | `filter_id, data__data, dd_site` | Update a retention filter from your organization. |
| <CopyableCode code="get_apm_retention_filter" /> | `SELECT` | <CopyableCode code="filter_id, dd_site" /> | Get an APM retention filter. |
| <CopyableCode code="list_apm_retention_filters" /> | `SELECT` | <CopyableCode code="dd_site" /> | Get the list of APM retention filters. |
| <CopyableCode code="create_apm_retention_filter" /> | `INSERT` | <CopyableCode code="data__data, dd_site" /> | Create a retention filter to index spans in your organization.<br />Returns the retention filter definition when the request is successful. |
| <CopyableCode code="delete_apm_retention_filter" /> | `DELETE` | <CopyableCode code="filter_id, dd_site" /> | Delete a specific retention filter from your organization. |
| <CopyableCode code="_get_apm_retention_filter" /> | `EXEC` | <CopyableCode code="filter_id, dd_site" /> | Get an APM retention filter. |
| <CopyableCode code="_list_apm_retention_filters" /> | `EXEC` | <CopyableCode code="dd_site" /> | Get the list of APM retention filters. |
| <CopyableCode code="reorder_apm_retention_filters" /> | `EXEC` | <CopyableCode code="data__data, dd_site" /> | Re-order the execution order of retention filters. |
| <CopyableCode code="update_apm_retention_filter" /> | `EXEC` | <CopyableCode code="filter_id, data__data, dd_site" /> | Update a retention filter from your organization. |
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL
custom_edit_url: null
image: /img/providers/datadog/stackql-datadog-provider-featured-image.png
---

APM Retention Filters

:::info Service Summary
Expand Down
21 changes: 12 additions & 9 deletions docs/datadog-docs/providers/datadog/audit/audit_logs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,28 @@ description: Query, monitor, and manage Datadog resources using SQL
custom_edit_url: null
image: /img/providers/datadog/stackql-datadog-provider-featured-image.png
---



import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';




## Overview
<table><tbody>
<tr><td><b>Name</b></td><td><code>audit_logs</code></td></tr>
<tr><td><b>Type</b></td><td>Resource</td></tr>
<tr><td><b>Id</b></td><td><code>datadog.audit.audit_logs</code></td></tr>
<tr><td><b>Id</b></td><td><CopyableCode code="datadog.audit.audit_logs" /></td></tr>
</tbody></table>

## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
| `id` | `string` | Unique ID of the event. |
| `attributes` | `object` | JSON object containing all event attributes and their associated values. |
| `type` | `string` | Type of the event. |
| <CopyableCode code="id" /> | `string` | Unique ID of the event. |
| <CopyableCode code="attributes" /> | `object` | JSON object containing all event attributes and their associated values. |
| <CopyableCode code="type" /> | `string` | Type of the event. |
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| `list_audit_logs` | `SELECT` | `dd_site` | List endpoint returns events that match a Audit Logs search query.<br />[Results are paginated][1].<br /><br />Use this endpoint to see your latest Audit Logs events.<br /><br />[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination |
| `_list_audit_logs` | `EXEC` | `dd_site` | List endpoint returns events that match a Audit Logs search query.<br />[Results are paginated][1].<br /><br />Use this endpoint to see your latest Audit Logs events.<br /><br />[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination |
| `search_audit_logs` | `EXEC` | `dd_site` | List endpoint returns Audit Logs events that match an Audit search query.<br />[Results are paginated][1].<br /><br />Use this endpoint to build complex Audit Logs events filtering and search.<br /><br />[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination |
| <CopyableCode code="list_audit_logs" /> | `SELECT` | <CopyableCode code="dd_site" /> | List endpoint returns events that match a Audit Logs search query.<br />[Results are paginated][1].<br /><br />Use this endpoint to see your latest Audit Logs events.<br /><br />[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination |
| <CopyableCode code="_list_audit_logs" /> | `EXEC` | <CopyableCode code="dd_site" /> | List endpoint returns events that match a Audit Logs search query.<br />[Results are paginated][1].<br /><br />Use this endpoint to see your latest Audit Logs events.<br /><br />[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination |
| <CopyableCode code="search_audit_logs" /> | `EXEC` | <CopyableCode code="dd_site" /> | List endpoint returns Audit Logs events that match an Audit search query.<br />[Results are paginated][1].<br /><br />Use this endpoint to build complex Audit Logs events filtering and search.<br /><br />[1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination |
1 change: 1 addition & 0 deletions docs/datadog-docs/providers/datadog/audit/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL
custom_edit_url: null
image: /img/providers/datadog/stackql-datadog-provider-featured-image.png
---

Search Your Audit Logs Events Over HTTP.

:::info Service Summary
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ description: Query, monitor, and manage Datadog resources using SQL
custom_edit_url: null
image: /img/providers/datadog/stackql-datadog-provider-featured-image.png
---

AuthN Mappings

:::info Service Summary
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,33 @@ description: Query, monitor, and manage Datadog resources using SQL
custom_edit_url: null
image: /img/providers/datadog/stackql-datadog-provider-featured-image.png
---



import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';




## Overview
<table><tbody>
<tr><td><b>Name</b></td><td><code>mappings</code></td></tr>
<tr><td><b>Type</b></td><td>Resource</td></tr>
<tr><td><b>Id</b></td><td><code>datadog.authn_mappings.mappings</code></td></tr>
<tr><td><b>Id</b></td><td><CopyableCode code="datadog.authn_mappings.mappings" /></td></tr>
</tbody></table>

## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
| `id` | `string` | ID of the AuthN Mapping. |
| `attributes` | `object` | Attributes of AuthN Mapping. |
| `relationships` | `object` | All relationships associated with AuthN Mapping. |
| `type` | `string` | AuthN Mappings resource type. |
| <CopyableCode code="id" /> | `string` | ID of the AuthN Mapping. |
| <CopyableCode code="attributes" /> | `object` | Attributes of AuthN Mapping. |
| <CopyableCode code="relationships" /> | `object` | All relationships associated with AuthN Mapping. |
| <CopyableCode code="type" /> | `string` | AuthN Mappings resource type. |
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| `getauthn_mapping` | `SELECT` | `authn_mapping_id, dd_site` | Get an AuthN Mapping specified by the AuthN Mapping UUID. |
| `listauthn_mappings` | `SELECT` | `dd_site` | List all AuthN Mappings in the org. |
| `createauthn_mapping` | `INSERT` | `data__data, dd_site` | Create an AuthN Mapping. |
| `deleteauthn_mapping` | `DELETE` | `authn_mapping_id, dd_site` | Delete an AuthN Mapping specified by AuthN Mapping UUID. |
| `_getauthn_mapping` | `EXEC` | `authn_mapping_id, dd_site` | Get an AuthN Mapping specified by the AuthN Mapping UUID. |
| `_listauthn_mappings` | `EXEC` | `dd_site` | List all AuthN Mappings in the org. |
| `updateauthn_mapping` | `EXEC` | `authn_mapping_id, data__data, dd_site` | Edit an AuthN Mapping. |
| <CopyableCode code="getauthn_mapping" /> | `SELECT` | <CopyableCode code="authn_mapping_id, dd_site" /> | Get an AuthN Mapping specified by the AuthN Mapping UUID. |
| <CopyableCode code="listauthn_mappings" /> | `SELECT` | <CopyableCode code="dd_site" /> | List all AuthN Mappings in the org. |
| <CopyableCode code="createauthn_mapping" /> | `INSERT` | <CopyableCode code="data__data, dd_site" /> | Create an AuthN Mapping. |
| <CopyableCode code="deleteauthn_mapping" /> | `DELETE` | <CopyableCode code="authn_mapping_id, dd_site" /> | Delete an AuthN Mapping specified by AuthN Mapping UUID. |
| <CopyableCode code="_getauthn_mapping" /> | `EXEC` | <CopyableCode code="authn_mapping_id, dd_site" /> | Get an AuthN Mapping specified by the AuthN Mapping UUID. |
| <CopyableCode code="_listauthn_mappings" /> | `EXEC` | <CopyableCode code="dd_site" /> | List all AuthN Mappings in the org. |
| <CopyableCode code="updateauthn_mapping" /> | `EXEC` | <CopyableCode code="authn_mapping_id, data__data, dd_site" /> | Edit an AuthN Mapping. |
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,30 @@ description: Query, monitor, and manage Datadog resources using SQL
custom_edit_url: null
image: /img/providers/datadog/stackql-datadog-provider-featured-image.png
---



import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';




## Overview
<table><tbody>
<tr><td><b>Name</b></td><td><code>app_pipeline_events</code></td></tr>
<tr><td><b>Type</b></td><td>Resource</td></tr>
<tr><td><b>Id</b></td><td><code>datadog.ci_visibility.app_pipeline_events</code></td></tr>
<tr><td><b>Id</b></td><td><CopyableCode code="datadog.ci_visibility.app_pipeline_events" /></td></tr>
</tbody></table>

## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
| `id` | `string` | Unique ID of the event. |
| `attributes` | `object` | JSON object containing all event attributes and their associated values. |
| `type` | `string` | Type of the event. |
| <CopyableCode code="id" /> | `string` | Unique ID of the event. |
| <CopyableCode code="attributes" /> | `object` | JSON object containing all event attributes and their associated values. |
| <CopyableCode code="type" /> | `string` | Type of the event. |
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| `list_ci_app_pipeline_events` | `SELECT` | `dd_site` | 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_ci_app_pipeline_event` | `INSERT` | `dd_site` | 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 />Pipeline events can be submitted with a timestamp that is up to 18 hours in the past. |
| `_list_ci_app_pipeline_events` | `EXEC` | `dd_site` | 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. |
| `aggregate_ci_app_pipeline_events` | `EXEC` | `dd_site` | Use this API endpoint to aggregate CI Visibility pipeline events into buckets of computed metrics and timeseries. |
| `search_ci_app_pipeline_events` | `EXEC` | `dd_site` | 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. |
| <CopyableCode code="list_ci_app_pipeline_events" /> | `SELECT` | <CopyableCode code="dd_site" /> | 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. |
| <CopyableCode code="create_ci_app_pipeline_event" /> | `INSERT` | <CopyableCode code="dd_site" /> | 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 />Pipeline events can be submitted with a timestamp that is up to 18 hours in the past. |
| <CopyableCode code="_list_ci_app_pipeline_events" /> | `EXEC` | <CopyableCode code="dd_site" /> | 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. |
| <CopyableCode code="aggregate_ci_app_pipeline_events" /> | `EXEC` | <CopyableCode code="dd_site" /> | Use this API endpoint to aggregate CI Visibility pipeline events into buckets of computed metrics and timeseries. |
| <CopyableCode code="search_ci_app_pipeline_events" /> | `EXEC` | <CopyableCode code="dd_site" /> | 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. |
Loading

0 comments on commit 1bae12f

Please sign in to comment.