Skip to content

Commit b1b71a9

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add support for configuring Splunk sourcetype in Custom Destinations (#3664)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 825b7d9 commit b1b71a9

File tree

34 files changed

+1450
-2
lines changed

34 files changed

+1450
-2
lines changed

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18216,6 +18216,16 @@ components:
1821618216
Must have HTTPS scheme and forwarding back to Datadog is not allowed.
1821718217
example: https://example.com
1821818218
type: string
18219+
sourcetype:
18220+
description: |-
18221+
The Splunk sourcetype for the events sent to this Splunk destination.
18222+
18223+
If absent, the default sourcetype `_json` is used. If set to null, the `sourcetype`
18224+
field is omitted from the Splunk HEC payload entirely. Otherwise, the provided string
18225+
value is used as the sourcetype.
18226+
example: my-source
18227+
nullable: true
18228+
type: string
1821918229
type:
1822018230
$ref: "#/components/schemas/CustomDestinationForwardDestinationSplunkType"
1822118231
required:
@@ -18491,6 +18501,16 @@ components:
1849118501
Must have HTTPS scheme and forwarding back to Datadog is not allowed.
1849218502
example: https://example.com
1849318503
type: string
18504+
sourcetype:
18505+
description: |-
18506+
The Splunk sourcetype for the events sent to this Splunk destination.
18507+
18508+
If absent, the default sourcetype `_json` is used. If set to null, the `sourcetype`
18509+
field is omitted from the Splunk HEC payload entirely. Otherwise, the provided string
18510+
value is used as the sourcetype.
18511+
example: my-source
18512+
nullable: true
18513+
type: string
1849418514
type:
1849518515
$ref: "#/components/schemas/CustomDestinationResponseForwardDestinationSplunkType"
1849618516
required:

‎examples/v2/logs-custom-destinations/CreateLogsCustomDestination_140188544.java‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
// Create a Splunk custom destination with a sourcetype returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.LogsCustomDestinationsApi;
6+
import com.datadog.api.client.v2.model.CustomDestinationCreateRequest;
7+
import com.datadog.api.client.v2.model.CustomDestinationCreateRequestAttributes;
8+
import com.datadog.api.client.v2.model.CustomDestinationCreateRequestDefinition;
9+
import com.datadog.api.client.v2.model.CustomDestinationForwardDestination;
10+
import com.datadog.api.client.v2.model.CustomDestinationForwardDestinationSplunk;
11+
import com.datadog.api.client.v2.model.CustomDestinationForwardDestinationSplunkType;
12+
import com.datadog.api.client.v2.model.CustomDestinationResponse;
13+
import com.datadog.api.client.v2.model.CustomDestinationType;
14+
15+
public class Example {
16+
public static void main(String[] args) {
17+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
18+
LogsCustomDestinationsApi apiInstance = new LogsCustomDestinationsApi(defaultClient);
19+
20+
CustomDestinationCreateRequest body =
21+
new CustomDestinationCreateRequest()
22+
.data(
23+
new CustomDestinationCreateRequestDefinition()
24+
.attributes(
25+
new CustomDestinationCreateRequestAttributes()
26+
.enabled(false)
27+
.forwardTags(false)
28+
.forwarderDestination(
29+
new CustomDestinationForwardDestination(
30+
new CustomDestinationForwardDestinationSplunk()
31+
.accessToken("my-access-token")
32+
.endpoint("https://example.com")
33+
.type(
34+
CustomDestinationForwardDestinationSplunkType
35+
.SPLUNK_HEC)
36+
.sourcetype("my-sourcetype")))
37+
.name("Nginx logs")
38+
.query("source:nginx"))
39+
.type(CustomDestinationType.CUSTOM_DESTINATION));
40+
41+
try {
42+
CustomDestinationResponse result = apiInstance.createLogsCustomDestination(body);
43+
System.out.println(result);
44+
} catch (ApiException e) {
45+
System.err.println(
46+
"Exception when calling LogsCustomDestinationsApi#createLogsCustomDestination");
47+
System.err.println("Status code: " + e.getCode());
48+
System.err.println("Reason: " + e.getResponseBody());
49+
System.err.println("Response headers: " + e.getResponseHeaders());
50+
e.printStackTrace();
51+
}
52+
}
53+
}

‎examples/v2/logs-custom-destinations/CreateLogsCustomDestination_1718754520.java‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
// Create a Splunk custom destination without a sourcetype returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.LogsCustomDestinationsApi;
6+
import com.datadog.api.client.v2.model.CustomDestinationCreateRequest;
7+
import com.datadog.api.client.v2.model.CustomDestinationCreateRequestAttributes;
8+
import com.datadog.api.client.v2.model.CustomDestinationCreateRequestDefinition;
9+
import com.datadog.api.client.v2.model.CustomDestinationForwardDestination;
10+
import com.datadog.api.client.v2.model.CustomDestinationForwardDestinationSplunk;
11+
import com.datadog.api.client.v2.model.CustomDestinationForwardDestinationSplunkType;
12+
import com.datadog.api.client.v2.model.CustomDestinationResponse;
13+
import com.datadog.api.client.v2.model.CustomDestinationType;
14+
15+
public class Example {
16+
public static void main(String[] args) {
17+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
18+
LogsCustomDestinationsApi apiInstance = new LogsCustomDestinationsApi(defaultClient);
19+
20+
CustomDestinationCreateRequest body =
21+
new CustomDestinationCreateRequest()
22+
.data(
23+
new CustomDestinationCreateRequestDefinition()
24+
.attributes(
25+
new CustomDestinationCreateRequestAttributes()
26+
.enabled(false)
27+
.forwardTags(false)
28+
.forwarderDestination(
29+
new CustomDestinationForwardDestination(
30+
new CustomDestinationForwardDestinationSplunk()
31+
.accessToken("my-access-token")
32+
.endpoint("https://example.com")
33+
.type(
34+
CustomDestinationForwardDestinationSplunkType
35+
.SPLUNK_HEC)))
36+
.name("Nginx logs")
37+
.query("source:nginx"))
38+
.type(CustomDestinationType.CUSTOM_DESTINATION));
39+
40+
try {
41+
CustomDestinationResponse result = apiInstance.createLogsCustomDestination(body);
42+
System.out.println(result);
43+
} catch (ApiException e) {
44+
System.err.println(
45+
"Exception when calling LogsCustomDestinationsApi#createLogsCustomDestination");
46+
System.err.println("Status code: " + e.getCode());
47+
System.err.println("Reason: " + e.getResponseBody());
48+
System.err.println("Response headers: " + e.getResponseHeaders());
49+
e.printStackTrace();
50+
}
51+
}
52+
}

‎examples/v2/logs-custom-destinations/CreateLogsCustomDestination_2534546779.java‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
// Create a Splunk custom destination with a null sourcetype returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.LogsCustomDestinationsApi;
6+
import com.datadog.api.client.v2.model.CustomDestinationCreateRequest;
7+
import com.datadog.api.client.v2.model.CustomDestinationCreateRequestAttributes;
8+
import com.datadog.api.client.v2.model.CustomDestinationCreateRequestDefinition;
9+
import com.datadog.api.client.v2.model.CustomDestinationForwardDestination;
10+
import com.datadog.api.client.v2.model.CustomDestinationForwardDestinationSplunk;
11+
import com.datadog.api.client.v2.model.CustomDestinationForwardDestinationSplunkType;
12+
import com.datadog.api.client.v2.model.CustomDestinationResponse;
13+
import com.datadog.api.client.v2.model.CustomDestinationType;
14+
15+
public class Example {
16+
public static void main(String[] args) {
17+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
18+
LogsCustomDestinationsApi apiInstance = new LogsCustomDestinationsApi(defaultClient);
19+
20+
CustomDestinationCreateRequest body =
21+
new CustomDestinationCreateRequest()
22+
.data(
23+
new CustomDestinationCreateRequestDefinition()
24+
.attributes(
25+
new CustomDestinationCreateRequestAttributes()
26+
.enabled(false)
27+
.forwardTags(false)
28+
.forwarderDestination(
29+
new CustomDestinationForwardDestination(
30+
new CustomDestinationForwardDestinationSplunk()
31+
.accessToken("my-access-token")
32+
.endpoint("https://example.com")
33+
.type(
34+
CustomDestinationForwardDestinationSplunkType
35+
.SPLUNK_HEC)
36+
.sourcetype(null)))
37+
.name("Nginx logs")
38+
.query("source:nginx"))
39+
.type(CustomDestinationType.CUSTOM_DESTINATION));
40+
41+
try {
42+
CustomDestinationResponse result = apiInstance.createLogsCustomDestination(body);
43+
System.out.println(result);
44+
} catch (ApiException e) {
45+
System.err.println(
46+
"Exception when calling LogsCustomDestinationsApi#createLogsCustomDestination");
47+
System.err.println("Status code: " + e.getCode());
48+
System.err.println("Reason: " + e.getResponseBody());
49+
System.err.println("Response headers: " + e.getResponseHeaders());
50+
e.printStackTrace();
51+
}
52+
}
53+
}

‎examples/v2/logs-custom-destinations/CreateLogsCustomDestination_3120242932.java‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
// Create a Splunk custom destination with an empty string sourcetype returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.LogsCustomDestinationsApi;
6+
import com.datadog.api.client.v2.model.CustomDestinationCreateRequest;
7+
import com.datadog.api.client.v2.model.CustomDestinationCreateRequestAttributes;
8+
import com.datadog.api.client.v2.model.CustomDestinationCreateRequestDefinition;
9+
import com.datadog.api.client.v2.model.CustomDestinationForwardDestination;
10+
import com.datadog.api.client.v2.model.CustomDestinationForwardDestinationSplunk;
11+
import com.datadog.api.client.v2.model.CustomDestinationForwardDestinationSplunkType;
12+
import com.datadog.api.client.v2.model.CustomDestinationResponse;
13+
import com.datadog.api.client.v2.model.CustomDestinationType;
14+
15+
public class Example {
16+
public static void main(String[] args) {
17+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
18+
LogsCustomDestinationsApi apiInstance = new LogsCustomDestinationsApi(defaultClient);
19+
20+
CustomDestinationCreateRequest body =
21+
new CustomDestinationCreateRequest()
22+
.data(
23+
new CustomDestinationCreateRequestDefinition()
24+
.attributes(
25+
new CustomDestinationCreateRequestAttributes()
26+
.enabled(false)
27+
.forwardTags(false)
28+
.forwarderDestination(
29+
new CustomDestinationForwardDestination(
30+
new CustomDestinationForwardDestinationSplunk()
31+
.accessToken("my-access-token")
32+
.endpoint("https://example.com")
33+
.type(
34+
CustomDestinationForwardDestinationSplunkType
35+
.SPLUNK_HEC)
36+
.sourcetype("")))
37+
.name("Nginx logs")
38+
.query("source:nginx"))
39+
.type(CustomDestinationType.CUSTOM_DESTINATION));
40+
41+
try {
42+
CustomDestinationResponse result = apiInstance.createLogsCustomDestination(body);
43+
System.out.println(result);
44+
} catch (ApiException e) {
45+
System.err.println(
46+
"Exception when calling LogsCustomDestinationsApi#createLogsCustomDestination");
47+
System.err.println("Status code: " + e.getCode());
48+
System.err.println("Reason: " + e.getResponseBody());
49+
System.err.println("Response headers: " + e.getResponseHeaders());
50+
e.printStackTrace();
51+
}
52+
}
53+
}

‎examples/v2/logs-custom-destinations/UpdateLogsCustomDestination_2034509257.java‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
// Update a Splunk custom destination's destination preserves the null sourcetype returns "OK"
2+
// response
3+
4+
import com.datadog.api.client.ApiClient;
5+
import com.datadog.api.client.ApiException;
6+
import com.datadog.api.client.v2.api.LogsCustomDestinationsApi;
7+
import com.datadog.api.client.v2.model.CustomDestinationForwardDestination;
8+
import com.datadog.api.client.v2.model.CustomDestinationForwardDestinationSplunk;
9+
import com.datadog.api.client.v2.model.CustomDestinationForwardDestinationSplunkType;
10+
import com.datadog.api.client.v2.model.CustomDestinationResponse;
11+
import com.datadog.api.client.v2.model.CustomDestinationType;
12+
import com.datadog.api.client.v2.model.CustomDestinationUpdateRequest;
13+
import com.datadog.api.client.v2.model.CustomDestinationUpdateRequestAttributes;
14+
import com.datadog.api.client.v2.model.CustomDestinationUpdateRequestDefinition;
15+
16+
public class Example {
17+
public static void main(String[] args) {
18+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
19+
LogsCustomDestinationsApi apiInstance = new LogsCustomDestinationsApi(defaultClient);
20+
21+
// there is a valid "custom_destination_splunk_with_null_sourcetype" in the system
22+
String CUSTOM_DESTINATION_SPLUNK_WITH_NULL_SOURCETYPE_DATA_ID =
23+
System.getenv("CUSTOM_DESTINATION_SPLUNK_WITH_NULL_SOURCETYPE_DATA_ID");
24+
25+
CustomDestinationUpdateRequest body =
26+
new CustomDestinationUpdateRequest()
27+
.data(
28+
new CustomDestinationUpdateRequestDefinition()
29+
.attributes(
30+
new CustomDestinationUpdateRequestAttributes()
31+
.forwarderDestination(
32+
new CustomDestinationForwardDestination(
33+
new CustomDestinationForwardDestinationSplunk()
34+
.type(
35+
CustomDestinationForwardDestinationSplunkType
36+
.SPLUNK_HEC)
37+
.endpoint("https://updated-example.com")
38+
.accessToken("my-access-token"))))
39+
.type(CustomDestinationType.CUSTOM_DESTINATION)
40+
.id(CUSTOM_DESTINATION_SPLUNK_WITH_NULL_SOURCETYPE_DATA_ID));
41+
42+
try {
43+
CustomDestinationResponse result =
44+
apiInstance.updateLogsCustomDestination(
45+
CUSTOM_DESTINATION_SPLUNK_WITH_NULL_SOURCETYPE_DATA_ID, body);
46+
System.out.println(result);
47+
} catch (ApiException e) {
48+
System.err.println(
49+
"Exception when calling LogsCustomDestinationsApi#updateLogsCustomDestination");
50+
System.err.println("Status code: " + e.getCode());
51+
System.err.println("Reason: " + e.getResponseBody());
52+
System.err.println("Response headers: " + e.getResponseHeaders());
53+
e.printStackTrace();
54+
}
55+
}
56+
}

‎examples/v2/logs-custom-destinations/UpdateLogsCustomDestination_213195663.java‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
// Update a Splunk custom destination with a sourcetype returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.LogsCustomDestinationsApi;
6+
import com.datadog.api.client.v2.model.CustomDestinationForwardDestination;
7+
import com.datadog.api.client.v2.model.CustomDestinationForwardDestinationSplunk;
8+
import com.datadog.api.client.v2.model.CustomDestinationForwardDestinationSplunkType;
9+
import com.datadog.api.client.v2.model.CustomDestinationResponse;
10+
import com.datadog.api.client.v2.model.CustomDestinationType;
11+
import com.datadog.api.client.v2.model.CustomDestinationUpdateRequest;
12+
import com.datadog.api.client.v2.model.CustomDestinationUpdateRequestAttributes;
13+
import com.datadog.api.client.v2.model.CustomDestinationUpdateRequestDefinition;
14+
15+
public class Example {
16+
public static void main(String[] args) {
17+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
18+
LogsCustomDestinationsApi apiInstance = new LogsCustomDestinationsApi(defaultClient);
19+
20+
// there is a valid "custom_destination_splunk" in the system
21+
String CUSTOM_DESTINATION_SPLUNK_DATA_ID = System.getenv("CUSTOM_DESTINATION_SPLUNK_DATA_ID");
22+
23+
CustomDestinationUpdateRequest body =
24+
new CustomDestinationUpdateRequest()
25+
.data(
26+
new CustomDestinationUpdateRequestDefinition()
27+
.attributes(
28+
new CustomDestinationUpdateRequestAttributes()
29+
.forwarderDestination(
30+
new CustomDestinationForwardDestination(
31+
new CustomDestinationForwardDestinationSplunk()
32+
.type(
33+
CustomDestinationForwardDestinationSplunkType
34+
.SPLUNK_HEC)
35+
.endpoint("https://example.com")
36+
.accessToken("my-access-token")
37+
.sourcetype("new-sourcetype"))))
38+
.type(CustomDestinationType.CUSTOM_DESTINATION)
39+
.id(CUSTOM_DESTINATION_SPLUNK_DATA_ID));
40+
41+
try {
42+
CustomDestinationResponse result =
43+
apiInstance.updateLogsCustomDestination(CUSTOM_DESTINATION_SPLUNK_DATA_ID, body);
44+
System.out.println(result);
45+
} catch (ApiException e) {
46+
System.err.println(
47+
"Exception when calling LogsCustomDestinationsApi#updateLogsCustomDestination");
48+
System.err.println("Status code: " + e.getCode());
49+
System.err.println("Reason: " + e.getResponseBody());
50+
System.err.println("Response headers: " + e.getResponseHeaders());
51+
e.printStackTrace();
52+
}
53+
}
54+
}

0 commit comments

Comments
 (0)