1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
// Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2019-Present Datadog, Inc.
use serde::de::{Error, MapAccess, Visitor};
use serde::{Deserialize, Deserializer, Serialize};
use serde_with::skip_serializing_none;
use std::fmt::{self, Formatter};
/// The `splunk_hec` destination forwards logs to Splunk using the HTTP Event Collector (HEC).
///
/// **Supported pipeline types:** logs
#[non_exhaustive]
#[skip_serializing_none]
#[derive(Clone, Debug, PartialEq, Serialize)]
pub struct ObservabilityPipelineSplunkHecDestination {
/// If `true`, Splunk tries to extract timestamps from incoming log events.
/// If `false`, Splunk assigns the time the event was received.
/// Only applies when `endpoint_target` is `event`; cannot be `true` when `endpoint_target` is `raw`.
#[serde(rename = "auto_extract_timestamp")]
pub auto_extract_timestamp: Option<bool>,
/// Configuration for buffer settings on destination components.
#[serde(rename = "buffer")]
pub buffer: Option<crate::datadogV2::model::ObservabilityPipelineBufferOptions>,
/// Encoding format for log events.
#[serde(rename = "encoding")]
pub encoding:
Option<crate::datadogV2::model::ObservabilityPipelineSplunkHecDestinationEncoding>,
/// The Splunk HEC endpoint to send events to. Use `event` to send structured events to the `/event` endpoint, or `raw` to send the raw message to the `/raw` endpoint.
#[serde(rename = "endpoint_target")]
pub endpoint_target:
Option<crate::datadogV2::model::ObservabilityPipelineSplunkHecDestinationEndpointTarget>,
/// Name of the environment variable or secret that holds the Splunk HEC endpoint URL.
#[serde(rename = "endpoint_url_key")]
pub endpoint_url_key: Option<String>,
/// The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components).
#[serde(rename = "id")]
pub id: String,
/// Optional name of the Splunk index where logs are written.
#[serde(rename = "index")]
pub index: Option<String>,
/// List of log field names to send as indexed fields to Splunk HEC. Available only when `encoding` is `json`.
#[serde(rename = "indexed_fields")]
pub indexed_fields: Option<Vec<String>>,
/// A list of component IDs whose output is used as the `input` for this component.
#[serde(rename = "inputs")]
pub inputs: Vec<String>,
/// The Splunk sourcetype to assign to log events.
#[serde(rename = "sourcetype")]
pub sourcetype: Option<String>,
/// Name of the environment variable or secret that holds the Splunk HEC token.
#[serde(rename = "token_key")]
pub token_key: Option<String>,
/// Controls how the Splunk HEC token is supplied. Use `custom` to provide a token with `token_key`, or `from_source` to forward the token received from an upstream Splunk HEC source.
#[serde(rename = "token_strategy")]
pub token_strategy:
Option<crate::datadogV2::model::ObservabilityPipelineSplunkHecDestinationTokenStrategy>,
/// The destination type. Always `splunk_hec`.
#[serde(rename = "type")]
pub type_: crate::datadogV2::model::ObservabilityPipelineSplunkHecDestinationType,
#[serde(flatten)]
pub additional_properties: std::collections::BTreeMap<String, serde_json::Value>,
#[serde(skip)]
#[serde(default)]
pub(crate) _unparsed: bool,
}
impl ObservabilityPipelineSplunkHecDestination {
pub fn new(
id: String,
inputs: Vec<String>,
type_: crate::datadogV2::model::ObservabilityPipelineSplunkHecDestinationType,
) -> ObservabilityPipelineSplunkHecDestination {
ObservabilityPipelineSplunkHecDestination {
auto_extract_timestamp: None,
buffer: None,
encoding: None,
endpoint_target: None,
endpoint_url_key: None,
id,
index: None,
indexed_fields: None,
inputs,
sourcetype: None,
token_key: None,
token_strategy: None,
type_,
additional_properties: std::collections::BTreeMap::new(),
_unparsed: false,
}
}
pub fn auto_extract_timestamp(mut self, value: bool) -> Self {
self.auto_extract_timestamp = Some(value);
self
}
pub fn buffer(
mut self,
value: crate::datadogV2::model::ObservabilityPipelineBufferOptions,
) -> Self {
self.buffer = Some(value);
self
}
pub fn encoding(
mut self,
value: crate::datadogV2::model::ObservabilityPipelineSplunkHecDestinationEncoding,
) -> Self {
self.encoding = Some(value);
self
}
pub fn endpoint_target(
mut self,
value: crate::datadogV2::model::ObservabilityPipelineSplunkHecDestinationEndpointTarget,
) -> Self {
self.endpoint_target = Some(value);
self
}
pub fn endpoint_url_key(mut self, value: String) -> Self {
self.endpoint_url_key = Some(value);
self
}
pub fn index(mut self, value: String) -> Self {
self.index = Some(value);
self
}
pub fn indexed_fields(mut self, value: Vec<String>) -> Self {
self.indexed_fields = Some(value);
self
}
pub fn sourcetype(mut self, value: String) -> Self {
self.sourcetype = Some(value);
self
}
pub fn token_key(mut self, value: String) -> Self {
self.token_key = Some(value);
self
}
pub fn token_strategy(
mut self,
value: crate::datadogV2::model::ObservabilityPipelineSplunkHecDestinationTokenStrategy,
) -> Self {
self.token_strategy = Some(value);
self
}
pub fn additional_properties(
mut self,
value: std::collections::BTreeMap<String, serde_json::Value>,
) -> Self {
self.additional_properties = value;
self
}
}
impl<'de> Deserialize<'de> for ObservabilityPipelineSplunkHecDestination {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
struct ObservabilityPipelineSplunkHecDestinationVisitor;
impl<'a> Visitor<'a> for ObservabilityPipelineSplunkHecDestinationVisitor {
type Value = ObservabilityPipelineSplunkHecDestination;
fn expecting(&self, f: &mut Formatter<'_>) -> fmt::Result {
f.write_str("a mapping")
}
fn visit_map<M>(self, mut map: M) -> Result<Self::Value, M::Error>
where
M: MapAccess<'a>,
{
let mut auto_extract_timestamp: Option<bool> = None;
let mut buffer: Option<
crate::datadogV2::model::ObservabilityPipelineBufferOptions,
> = None;
let mut encoding: Option<
crate::datadogV2::model::ObservabilityPipelineSplunkHecDestinationEncoding,
> = None;
let mut endpoint_target: Option<crate::datadogV2::model::ObservabilityPipelineSplunkHecDestinationEndpointTarget> = None;
let mut endpoint_url_key: Option<String> = None;
let mut id: Option<String> = None;
let mut index: Option<String> = None;
let mut indexed_fields: Option<Vec<String>> = None;
let mut inputs: Option<Vec<String>> = None;
let mut sourcetype: Option<String> = None;
let mut token_key: Option<String> = None;
let mut token_strategy: Option<
crate::datadogV2::model::ObservabilityPipelineSplunkHecDestinationTokenStrategy,
> = None;
let mut type_: Option<
crate::datadogV2::model::ObservabilityPipelineSplunkHecDestinationType,
> = None;
let mut additional_properties: std::collections::BTreeMap<
String,
serde_json::Value,
> = std::collections::BTreeMap::new();
let mut _unparsed = false;
while let Some((k, v)) = map.next_entry::<String, serde_json::Value>()? {
match k.as_str() {
"auto_extract_timestamp" => {
if v.is_null() {
continue;
}
auto_extract_timestamp =
Some(serde_json::from_value(v).map_err(M::Error::custom)?);
}
"buffer" => {
if v.is_null() {
continue;
}
buffer = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
if let Some(ref _buffer) = buffer {
match _buffer {
crate::datadogV2::model::ObservabilityPipelineBufferOptions::UnparsedObject(_buffer) => {
_unparsed = true;
},
_ => {}
}
}
}
"encoding" => {
if v.is_null() {
continue;
}
encoding = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
if let Some(ref _encoding) = encoding {
match _encoding {
crate::datadogV2::model::ObservabilityPipelineSplunkHecDestinationEncoding::UnparsedObject(_encoding) => {
_unparsed = true;
},
_ => {}
}
}
}
"endpoint_target" => {
if v.is_null() {
continue;
}
endpoint_target =
Some(serde_json::from_value(v).map_err(M::Error::custom)?);
if let Some(ref _endpoint_target) = endpoint_target {
match _endpoint_target {
crate::datadogV2::model::ObservabilityPipelineSplunkHecDestinationEndpointTarget::UnparsedObject(_endpoint_target) => {
_unparsed = true;
},
_ => {}
}
}
}
"endpoint_url_key" => {
if v.is_null() {
continue;
}
endpoint_url_key =
Some(serde_json::from_value(v).map_err(M::Error::custom)?);
}
"id" => {
id = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
}
"index" => {
if v.is_null() {
continue;
}
index = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
}
"indexed_fields" => {
if v.is_null() {
continue;
}
indexed_fields =
Some(serde_json::from_value(v).map_err(M::Error::custom)?);
}
"inputs" => {
inputs = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
}
"sourcetype" => {
if v.is_null() {
continue;
}
sourcetype = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
}
"token_key" => {
if v.is_null() {
continue;
}
token_key = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
}
"token_strategy" => {
if v.is_null() {
continue;
}
token_strategy =
Some(serde_json::from_value(v).map_err(M::Error::custom)?);
if let Some(ref _token_strategy) = token_strategy {
match _token_strategy {
crate::datadogV2::model::ObservabilityPipelineSplunkHecDestinationTokenStrategy::UnparsedObject(_token_strategy) => {
_unparsed = true;
},
_ => {}
}
}
}
"type" => {
type_ = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
if let Some(ref _type_) = type_ {
match _type_ {
crate::datadogV2::model::ObservabilityPipelineSplunkHecDestinationType::UnparsedObject(_type_) => {
_unparsed = true;
},
_ => {}
}
}
}
&_ => {
if let Ok(value) = serde_json::from_value(v.clone()) {
additional_properties.insert(k, value);
}
}
}
}
let id = id.ok_or_else(|| M::Error::missing_field("id"))?;
let inputs = inputs.ok_or_else(|| M::Error::missing_field("inputs"))?;
let type_ = type_.ok_or_else(|| M::Error::missing_field("type_"))?;
let content = ObservabilityPipelineSplunkHecDestination {
auto_extract_timestamp,
buffer,
encoding,
endpoint_target,
endpoint_url_key,
id,
index,
indexed_fields,
inputs,
sourcetype,
token_key,
token_strategy,
type_,
additional_properties,
_unparsed,
};
Ok(content)
}
}
deserializer.deserialize_any(ObservabilityPipelineSplunkHecDestinationVisitor)
}
}