Create a retention filter
https://api.datadoghq.com/api/v2/apm/config/retention-filtershttps://api.us3.datadoghq.com/api/v2/apm/config/retention-filtershttps://api.us5.datadoghq.com/api/v2/apm/config/retention-filtershttps://api.datadoghq.eu/api/v2/apm/config/retention-filtershttps://api.ap1.datadoghq.com/api/v2/apm/config/retention-filtershttps://api.ap2.datadoghq.com/api/v2/apm/config/retention-filtershttps://api.uk1.datadoghq.com/api/v2/apm/config/retention-filtershttps://api.ddog-gov.com/api/v2/apm/config/retention-filtershttps://api.us2.ddog-gov.com/api/v2/apm/config/retention-filtersOverview
Create a retention filter to index spans in your organization. Returns the retention filter definition when the request is successful.
Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor cannot be created.
Request
Body Data (required)
The definition of the new retention filter.
data [required]The body of the retention filter to be created.
attributes [required]The object describing the configuration of the retention filter to create/update.
enabled [required]Enable/Disable the retention filter.
filter [required]The spans filter. Spans matching this filter will be indexed and stored.
filter_type [required]The type of retention filter. The value should always be spans-sampling-processor.
spans-sampling-processorspans-sampling-processorname [required]The name of the retention filter.
rate [required]Sample rate to apply to spans going through this retention filter. A value of 1.0 keeps all spans matching the query.
trace_rateSample rate to apply to traces containing spans going through this retention filter. A value of 1.0 keeps all traces with spans matching the query.
type [required]The type of the resource.
apm_retention_filterapm_retention_filterCreate a retention filter returns "OK" response
{
"data": {
"attributes": {
"enabled": true,
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"name": "my retention filter",
"rate": 1.0
},
"type": "apm_retention_filter"
}
}Create a retention filter with trace rate returns "OK" response
{
"data": {
"attributes": {
"enabled": true,
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"name": "my retention filter",
"rate": 1.0,
"trace_rate": 1.0
},
"type": "apm_retention_filter"
}
}Response
OK
The retention filters definition.
dataThe definition of the retention filter.
attributes [required]The attributes of the retention filter.
created_atThe creation timestamp of the retention filter.
created_byThe creator of the retention filter.
editableShows whether the filter can be edited.
enabledThe status of the retention filter (Enabled/Disabled).
execution_orderThe execution order of the retention filter.
filterThe spans filter used to index spans.
filter_typeThe type of retention filter. The value should always be spans-sampling-processor.
spans-sampling-processorspans-sampling-processormodified_atThe modification timestamp of the retention filter.
modified_byThe modifier of the retention filter.
nameThe name of the retention filter.
rateSample rate to apply to spans going through this retention filter. A value of 1.0 keeps all spans matching the query.
trace_rateSample rate to apply to traces containing spans going through this retention filter. A value of 1.0 keeps all traces with spans matching the query.
id [required]The ID of the retention filter.
type [required]The type of the resource.
apm_retention_filterapm_retention_filter{
"data": {
"attributes": {
"created_at": "integer",
"created_by": "string",
"editable": true,
"enabled": true,
"execution_order": "integer",
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"modified_at": "integer",
"modified_by": "string",
"name": "my retention filter",
"rate": 1,
"trace_rate": 1
},
"id": "7RBOb7dLSYWI01yc3pIH8w",
"type": "apm_retention_filter"
}
}Bad Request
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Not Authorized
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Conflict
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Too many requests
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Code Example
Create a retention filter returns "OK" response
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/apm/config/retention-filters" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"enabled": true,
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"name": "my retention filter",
"rate": 1.0
},
"type": "apm_retention_filter"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/apm/config/retention-filters" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"enabled": true,
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"name": "my retention filter",
"rate": 1.0
},
"type": "apm_retention_filter"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/apm/config/retention-filters" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"enabled": true,
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"name": "my retention filter",
"rate": 1.0
},
"type": "apm_retention_filter"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/apm/config/retention-filters" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"enabled": true,
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"name": "my retention filter",
"rate": 1.0
},
"type": "apm_retention_filter"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/apm/config/retention-filters" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"enabled": true,
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"name": "my retention filter",
"rate": 1.0
},
"type": "apm_retention_filter"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/apm/config/retention-filters" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"enabled": true,
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"name": "my retention filter",
"rate": 1.0
},
"type": "apm_retention_filter"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/apm/config/retention-filters" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"enabled": true,
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"name": "my retention filter",
"rate": 1.0
},
"type": "apm_retention_filter"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/apm/config/retention-filters" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"enabled": true,
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"name": "my retention filter",
"rate": 1.0
},
"type": "apm_retention_filter"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/apm/config/retention-filters" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"enabled": true,
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"name": "my retention filter",
"rate": 1.0
},
"type": "apm_retention_filter"
}
}
EOFCreate a retention filter with trace rate returns "OK" response
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/apm/config/retention-filters" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"enabled": true,
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"name": "my retention filter",
"rate": 1.0,
"trace_rate": 1.0
},
"type": "apm_retention_filter"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/apm/config/retention-filters" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"enabled": true,
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"name": "my retention filter",
"rate": 1.0,
"trace_rate": 1.0
},
"type": "apm_retention_filter"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/apm/config/retention-filters" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"enabled": true,
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"name": "my retention filter",
"rate": 1.0,
"trace_rate": 1.0
},
"type": "apm_retention_filter"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/apm/config/retention-filters" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"enabled": true,
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"name": "my retention filter",
"rate": 1.0,
"trace_rate": 1.0
},
"type": "apm_retention_filter"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/apm/config/retention-filters" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"enabled": true,
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"name": "my retention filter",
"rate": 1.0,
"trace_rate": 1.0
},
"type": "apm_retention_filter"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/apm/config/retention-filters" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"enabled": true,
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"name": "my retention filter",
"rate": 1.0,
"trace_rate": 1.0
},
"type": "apm_retention_filter"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/apm/config/retention-filters" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"enabled": true,
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"name": "my retention filter",
"rate": 1.0,
"trace_rate": 1.0
},
"type": "apm_retention_filter"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/apm/config/retention-filters" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"enabled": true,
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"name": "my retention filter",
"rate": 1.0,
"trace_rate": 1.0
},
"type": "apm_retention_filter"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/apm/config/retention-filters" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"enabled": true,
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"filter_type": "spans-sampling-processor",
"name": "my retention filter",
"rate": 1.0,
"trace_rate": 1.0
},
"type": "apm_retention_filter"
}
}
EOFCreate a retention filter returns "OK" response
// Create a retention filter returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
body := datadogV2.RetentionFilterCreateRequest{
Data: datadogV2.RetentionFilterCreateData{
Attributes: datadogV2.RetentionFilterCreateAttributes{
Enabled: true,
Filter: datadogV2.SpansFilterCreate{
Query: "@http.status_code:200 service:my-service",
},
FilterType: datadogV2.RETENTIONFILTERTYPE_SPANS_SAMPLING_PROCESSOR,
Name: "my retention filter",
Rate: 1.0,
},
Type: datadogV2.APMRETENTIONFILTERTYPE_apm_retention_filter,
},
}
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewAPMRetentionFiltersApi(apiClient)
resp, r, err := api.CreateApmRetentionFilter(ctx, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `APMRetentionFiltersApi.CreateApmRetentionFilter`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `APMRetentionFiltersApi.CreateApmRetentionFilter`:\n%s\n", responseContent)
}
Create a retention filter with trace rate returns "OK" response
// Create a retention filter with trace rate returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
body := datadogV2.RetentionFilterCreateRequest{
Data: datadogV2.RetentionFilterCreateData{
Attributes: datadogV2.RetentionFilterCreateAttributes{
Enabled: true,
Filter: datadogV2.SpansFilterCreate{
Query: "@http.status_code:200 service:my-service",
},
FilterType: datadogV2.RETENTIONFILTERTYPE_SPANS_SAMPLING_PROCESSOR,
Name: "my retention filter",
Rate: 1.0,
TraceRate: datadog.PtrFloat64(1.0),
},
Type: datadogV2.APMRETENTIONFILTERTYPE_apm_retention_filter,
},
}
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewAPMRetentionFiltersApi(apiClient)
resp, r, err := api.CreateApmRetentionFilter(ctx, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `APMRetentionFiltersApi.CreateApmRetentionFilter`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `APMRetentionFiltersApi.CreateApmRetentionFilter`:\n%s\n", responseContent)
}
Instructions
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"Create a retention filter returns "OK" response
// Create a retention filter returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ApmRetentionFiltersApi;
import com.datadog.api.client.v2.model.ApmRetentionFilterType;
import com.datadog.api.client.v2.model.RetentionFilterCreateAttributes;
import com.datadog.api.client.v2.model.RetentionFilterCreateData;
import com.datadog.api.client.v2.model.RetentionFilterCreateRequest;
import com.datadog.api.client.v2.model.RetentionFilterCreateResponse;
import com.datadog.api.client.v2.model.RetentionFilterType;
import com.datadog.api.client.v2.model.SpansFilterCreate;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
ApmRetentionFiltersApi apiInstance = new ApmRetentionFiltersApi(defaultClient);
RetentionFilterCreateRequest body =
new RetentionFilterCreateRequest()
.data(
new RetentionFilterCreateData()
.attributes(
new RetentionFilterCreateAttributes()
.enabled(true)
.filter(
new SpansFilterCreate()
.query("@http.status_code:200 service:my-service"))
.filterType(RetentionFilterType.SPANS_SAMPLING_PROCESSOR)
.name("my retention filter")
.rate(1.0))
.type(ApmRetentionFilterType.apm_retention_filter));
try {
RetentionFilterCreateResponse result = apiInstance.createApmRetentionFilter(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ApmRetentionFiltersApi#createApmRetentionFilter");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Create a retention filter with trace rate returns "OK" response
// Create a retention filter with trace rate returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ApmRetentionFiltersApi;
import com.datadog.api.client.v2.model.ApmRetentionFilterType;
import com.datadog.api.client.v2.model.RetentionFilterCreateAttributes;
import com.datadog.api.client.v2.model.RetentionFilterCreateData;
import com.datadog.api.client.v2.model.RetentionFilterCreateRequest;
import com.datadog.api.client.v2.model.RetentionFilterCreateResponse;
import com.datadog.api.client.v2.model.RetentionFilterType;
import com.datadog.api.client.v2.model.SpansFilterCreate;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
ApmRetentionFiltersApi apiInstance = new ApmRetentionFiltersApi(defaultClient);
RetentionFilterCreateRequest body =
new RetentionFilterCreateRequest()
.data(
new RetentionFilterCreateData()
.attributes(
new RetentionFilterCreateAttributes()
.enabled(true)
.filter(
new SpansFilterCreate()
.query("@http.status_code:200 service:my-service"))
.filterType(RetentionFilterType.SPANS_SAMPLING_PROCESSOR)
.name("my retention filter")
.rate(1.0)
.traceRate(1.0))
.type(ApmRetentionFilterType.apm_retention_filter));
try {
RetentionFilterCreateResponse result = apiInstance.createApmRetentionFilter(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ApmRetentionFiltersApi#createApmRetentionFilter");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Instructions
First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"Create a retention filter returns "OK" response
"""
Create a retention filter returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.apm_retention_filters_api import APMRetentionFiltersApi
from datadog_api_client.v2.model.apm_retention_filter_type import ApmRetentionFilterType
from datadog_api_client.v2.model.retention_filter_create_attributes import RetentionFilterCreateAttributes
from datadog_api_client.v2.model.retention_filter_create_data import RetentionFilterCreateData
from datadog_api_client.v2.model.retention_filter_create_request import RetentionFilterCreateRequest
from datadog_api_client.v2.model.retention_filter_type import RetentionFilterType
from datadog_api_client.v2.model.spans_filter_create import SpansFilterCreate
body = RetentionFilterCreateRequest(
data=RetentionFilterCreateData(
attributes=RetentionFilterCreateAttributes(
enabled=True,
filter=SpansFilterCreate(
query="@http.status_code:200 service:my-service",
),
filter_type=RetentionFilterType.SPANS_SAMPLING_PROCESSOR,
name="my retention filter",
rate=1.0,
),
type=ApmRetentionFilterType.apm_retention_filter,
),
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
api_instance = APMRetentionFiltersApi(api_client)
response = api_instance.create_apm_retention_filter(body=body)
print(response)
Create a retention filter with trace rate returns "OK" response
"""
Create a retention filter with trace rate returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.apm_retention_filters_api import APMRetentionFiltersApi
from datadog_api_client.v2.model.apm_retention_filter_type import ApmRetentionFilterType
from datadog_api_client.v2.model.retention_filter_create_attributes import RetentionFilterCreateAttributes
from datadog_api_client.v2.model.retention_filter_create_data import RetentionFilterCreateData
from datadog_api_client.v2.model.retention_filter_create_request import RetentionFilterCreateRequest
from datadog_api_client.v2.model.retention_filter_type import RetentionFilterType
from datadog_api_client.v2.model.spans_filter_create import SpansFilterCreate
body = RetentionFilterCreateRequest(
data=RetentionFilterCreateData(
attributes=RetentionFilterCreateAttributes(
enabled=True,
filter=SpansFilterCreate(
query="@http.status_code:200 service:my-service",
),
filter_type=RetentionFilterType.SPANS_SAMPLING_PROCESSOR,
name="my retention filter",
rate=1.0,
trace_rate=1.0,
),
type=ApmRetentionFilterType.apm_retention_filter,
),
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
api_instance = APMRetentionFiltersApi(api_client)
response = api_instance.create_apm_retention_filter(body=body)
print(response)
Instructions
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"Create a retention filter returns "OK" response
# Create a retention filter returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::APMRetentionFiltersAPI.new
body = DatadogAPIClient::V2::RetentionFilterCreateRequest.new({
data: DatadogAPIClient::V2::RetentionFilterCreateData.new({
attributes: DatadogAPIClient::V2::RetentionFilterCreateAttributes.new({
enabled: true,
filter: DatadogAPIClient::V2::SpansFilterCreate.new({
query: "@http.status_code:200 service:my-service",
}),
filter_type: DatadogAPIClient::V2::RetentionFilterType::SPANS_SAMPLING_PROCESSOR,
name: "my retention filter",
rate: 1.0,
}),
type: DatadogAPIClient::V2::ApmRetentionFilterType::APM_RETENTION_FILTER,
}),
})
p api_instance.create_apm_retention_filter(body)
Create a retention filter with trace rate returns "OK" response
# Create a retention filter with trace rate returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::APMRetentionFiltersAPI.new
body = DatadogAPIClient::V2::RetentionFilterCreateRequest.new({
data: DatadogAPIClient::V2::RetentionFilterCreateData.new({
attributes: DatadogAPIClient::V2::RetentionFilterCreateAttributes.new({
enabled: true,
filter: DatadogAPIClient::V2::SpansFilterCreate.new({
query: "@http.status_code:200 service:my-service",
}),
filter_type: DatadogAPIClient::V2::RetentionFilterType::SPANS_SAMPLING_PROCESSOR,
name: "my retention filter",
rate: 1.0,
trace_rate: 1.0,
}),
type: DatadogAPIClient::V2::ApmRetentionFilterType::APM_RETENTION_FILTER,
}),
})
p api_instance.create_apm_retention_filter(body)
Instructions
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"Create a retention filter returns "OK" response
// Create a retention filter returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_apm_retention_filters::APMRetentionFiltersAPI;
use datadog_api_client::datadogV2::model::ApmRetentionFilterType;
use datadog_api_client::datadogV2::model::RetentionFilterCreateAttributes;
use datadog_api_client::datadogV2::model::RetentionFilterCreateData;
use datadog_api_client::datadogV2::model::RetentionFilterCreateRequest;
use datadog_api_client::datadogV2::model::RetentionFilterType;
use datadog_api_client::datadogV2::model::SpansFilterCreate;
#[tokio::main]
async fn main() {
let body = RetentionFilterCreateRequest::new(RetentionFilterCreateData::new(
RetentionFilterCreateAttributes::new(
true,
SpansFilterCreate::new("@http.status_code:200 service:my-service".to_string()),
RetentionFilterType::SPANS_SAMPLING_PROCESSOR,
"my retention filter".to_string(),
1.0,
),
ApmRetentionFilterType::apm_retention_filter,
));
let configuration = datadog::Configuration::new();
let api = APMRetentionFiltersAPI::with_config(configuration);
let resp = api.create_apm_retention_filter(body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
Create a retention filter with trace rate returns "OK" response
// Create a retention filter with trace rate returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_apm_retention_filters::APMRetentionFiltersAPI;
use datadog_api_client::datadogV2::model::ApmRetentionFilterType;
use datadog_api_client::datadogV2::model::RetentionFilterCreateAttributes;
use datadog_api_client::datadogV2::model::RetentionFilterCreateData;
use datadog_api_client::datadogV2::model::RetentionFilterCreateRequest;
use datadog_api_client::datadogV2::model::RetentionFilterType;
use datadog_api_client::datadogV2::model::SpansFilterCreate;
#[tokio::main]
async fn main() {
let body = RetentionFilterCreateRequest::new(RetentionFilterCreateData::new(
RetentionFilterCreateAttributes::new(
true,
SpansFilterCreate::new("@http.status_code:200 service:my-service".to_string()),
RetentionFilterType::SPANS_SAMPLING_PROCESSOR,
"my retention filter".to_string(),
1.0,
)
.trace_rate(1.0 as f64),
ApmRetentionFilterType::apm_retention_filter,
));
let configuration = datadog::Configuration::new();
let api = APMRetentionFiltersAPI::with_config(configuration);
let resp = api.create_apm_retention_filter(body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
Instructions
First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE="datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runCreate a retention filter returns "OK" response
/**
* Create a retention filter returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
const apiInstance = new v2.APMRetentionFiltersApi(configuration);
const params: v2.APMRetentionFiltersApiCreateApmRetentionFilterRequest = {
body: {
data: {
attributes: {
enabled: true,
filter: {
query: "@http.status_code:200 service:my-service",
},
filterType: "spans-sampling-processor",
name: "my retention filter",
rate: 1.0,
},
type: "apm_retention_filter",
},
},
};
apiInstance
.createApmRetentionFilter(params)
.then((data: v2.RetentionFilterCreateResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
Create a retention filter with trace rate returns "OK" response
/**
* Create a retention filter with trace rate returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
const apiInstance = new v2.APMRetentionFiltersApi(configuration);
const params: v2.APMRetentionFiltersApiCreateApmRetentionFilterRequest = {
body: {
data: {
attributes: {
enabled: true,
filter: {
query: "@http.status_code:200 service:my-service",
},
filterType: "spans-sampling-processor",
name: "my retention filter",
rate: 1.0,
traceRate: 1.0,
},
type: "apm_retention_filter",
},
},
};
apiInstance
.createApmRetentionFilter(params)
.then((data: v2.RetentionFilterCreateResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
Instructions
First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"