Skip to content

Commit c359573

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Document behavior of absent Splunk sourcetype in Custom Destinations (#3959)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 76f478f commit c359573

File tree

3 files changed

+16
-12
lines changed

3 files changed

+16
-12
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18679,9 +18679,10 @@ components:
1867918679
description: |-
1868018680
The Splunk sourcetype for the events sent to this Splunk destination.
1868118681

18682-
If absent, the default sourcetype `_json` is used. If set to null, the `sourcetype`
18683-
field is omitted from the Splunk HEC payload entirely. Otherwise, the provided string
18684-
value is used as the sourcetype.
18682+
If the field is absent from the request and no sourcetype has been previously set on this destination, the default sourcetype `_json` is used.
18683+
On update, if the field is absent from the request but a sourcetype was previously set, the previous value is kept.
18684+
If set to `null`, the sourcetype field is omitted from the forwarded event entirely.
18685+
Otherwise, the provided string value is used as the sourcetype.
1868518686
example: my-source
1868618687
nullable: true
1868718688
type: string
@@ -18964,9 +18965,10 @@ components:
1896418965
description: |-
1896518966
The Splunk sourcetype for the events sent to this Splunk destination.
1896618967

18967-
If absent, the default sourcetype `_json` is used. If set to null, the `sourcetype`
18968-
field is omitted from the Splunk HEC payload entirely. Otherwise, the provided string
18969-
value is used as the sourcetype.
18968+
If the field is absent from the request and no sourcetype has been previously set on this destination, the default sourcetype `_json` is used.
18969+
On update, if the field is absent from the request but a sourcetype was previously set, the previous value is kept.
18970+
If set to `null`, the sourcetype field is omitted from the forwarded event entirely.
18971+
Otherwise, the provided string value is used as the sourcetype.
1897018972
example: my-source
1897118973
nullable: true
1897218974
type: string

services/logs_custom_destinations/src/v2/models/CustomDestinationForwardDestinationSplunk.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,10 @@ export class CustomDestinationForwardDestinationSplunk {
1818
/**
1919
* The Splunk sourcetype for the events sent to this Splunk destination.
2020
*
21-
* If absent, the default sourcetype `_json` is used. If set to null, the `sourcetype`
22-
* field is omitted from the Splunk HEC payload entirely. Otherwise, the provided string
23-
* value is used as the sourcetype.
21+
* If the field is absent from the request and no sourcetype has been previously set on this destination, the default sourcetype `_json` is used.
22+
* On update, if the field is absent from the request but a sourcetype was previously set, the previous value is kept.
23+
* If set to `null`, the sourcetype field is omitted from the forwarded event entirely.
24+
* Otherwise, the provided string value is used as the sourcetype.
2425
*/
2526
"sourcetype"?: string;
2627
/**

services/logs_custom_destinations/src/v2/models/CustomDestinationResponseForwardDestinationSplunk.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,10 @@ export class CustomDestinationResponseForwardDestinationSplunk {
1414
/**
1515
* The Splunk sourcetype for the events sent to this Splunk destination.
1616
*
17-
* If absent, the default sourcetype `_json` is used. If set to null, the `sourcetype`
18-
* field is omitted from the Splunk HEC payload entirely. Otherwise, the provided string
19-
* value is used as the sourcetype.
17+
* If the field is absent from the request and no sourcetype has been previously set on this destination, the default sourcetype `_json` is used.
18+
* On update, if the field is absent from the request but a sourcetype was previously set, the previous value is kept.
19+
* If set to `null`, the sourcetype field is omitted from the forwarded event entirely.
20+
* Otherwise, the provided string value is used as the sourcetype.
2021
*/
2122
"sourcetype"?: string;
2223
/**

0 commit comments

Comments
 (0)