cribl-control-plane 0.0.36__py3-none-any.whl → 0.0.37a1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of cribl-control-plane might be problematic. Click here for more details.

@@ -4,41 +4,41 @@ from __future__ import annotations
4
4
  from cribl_control_plane.types import BaseModel
5
5
  from enum import Enum
6
6
  import pydantic
7
- from typing import Any, List, Optional, Union
8
- from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
7
+ from typing import Any, List, Optional
8
+ from typing_extensions import Annotated, NotRequired, TypedDict
9
9
 
10
10
 
11
- class InputSyslogType2(str, Enum):
11
+ class InputSyslogType(str, Enum):
12
12
  SYSLOG = "syslog"
13
13
 
14
14
 
15
- class InputSyslogConnection2TypedDict(TypedDict):
15
+ class InputSyslogConnectionTypedDict(TypedDict):
16
16
  output: str
17
17
  pipeline: NotRequired[str]
18
18
 
19
19
 
20
- class InputSyslogConnection2(BaseModel):
20
+ class InputSyslogConnection(BaseModel):
21
21
  output: str
22
22
 
23
23
  pipeline: Optional[str] = None
24
24
 
25
25
 
26
- class InputSyslogMode2(str, Enum):
26
+ class InputSyslogMode(str, Enum):
27
27
  r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
28
28
 
29
29
  SMART = "smart"
30
30
  ALWAYS = "always"
31
31
 
32
32
 
33
- class InputSyslogCompression2(str, Enum):
33
+ class InputSyslogCompression(str, Enum):
34
34
  r"""Codec to use to compress the persisted data"""
35
35
 
36
36
  NONE = "none"
37
37
  GZIP = "gzip"
38
38
 
39
39
 
40
- class InputSyslogPq2TypedDict(TypedDict):
41
- mode: NotRequired[InputSyslogMode2]
40
+ class InputSyslogPqTypedDict(TypedDict):
41
+ mode: NotRequired[InputSyslogMode]
42
42
  r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
43
43
  max_buffer_size: NotRequired[float]
44
44
  r"""The maximum number of events to hold in memory before writing the events to disk"""
@@ -50,12 +50,12 @@ class InputSyslogPq2TypedDict(TypedDict):
50
50
  r"""The maximum disk space that the queue can consume (as an average per Worker Process) before queueing stops. Enter a numeral with units of KB, MB, etc."""
51
51
  path: NotRequired[str]
52
52
  r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
53
- compress: NotRequired[InputSyslogCompression2]
53
+ compress: NotRequired[InputSyslogCompression]
54
54
  r"""Codec to use to compress the persisted data"""
55
55
 
56
56
 
57
- class InputSyslogPq2(BaseModel):
58
- mode: Optional[InputSyslogMode2] = InputSyslogMode2.ALWAYS
57
+ class InputSyslogPq(BaseModel):
58
+ mode: Optional[InputSyslogMode] = InputSyslogMode.ALWAYS
59
59
  r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
60
60
 
61
61
  max_buffer_size: Annotated[
@@ -79,25 +79,25 @@ class InputSyslogPq2(BaseModel):
79
79
  path: Optional[str] = "$CRIBL_HOME/state/queues"
80
80
  r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
81
81
 
82
- compress: Optional[InputSyslogCompression2] = InputSyslogCompression2.NONE
82
+ compress: Optional[InputSyslogCompression] = InputSyslogCompression.NONE
83
83
  r"""Codec to use to compress the persisted data"""
84
84
 
85
85
 
86
- class InputSyslogMinimumTLSVersion2(str, Enum):
86
+ class InputSyslogMinimumTLSVersion(str, Enum):
87
87
  TL_SV1 = "TLSv1"
88
88
  TL_SV1_1 = "TLSv1.1"
89
89
  TL_SV1_2 = "TLSv1.2"
90
90
  TL_SV1_3 = "TLSv1.3"
91
91
 
92
92
 
93
- class InputSyslogMaximumTLSVersion2(str, Enum):
93
+ class InputSyslogMaximumTLSVersion(str, Enum):
94
94
  TL_SV1 = "TLSv1"
95
95
  TL_SV1_1 = "TLSv1.1"
96
96
  TL_SV1_2 = "TLSv1.2"
97
97
  TL_SV1_3 = "TLSv1.3"
98
98
 
99
99
 
100
- class InputSyslogTLSSettingsServerSide2TypedDict(TypedDict):
100
+ class InputSyslogTLSSettingsServerSideTypedDict(TypedDict):
101
101
  disabled: NotRequired[bool]
102
102
  certificate_name: NotRequired[str]
103
103
  r"""The name of the predefined certificate"""
@@ -113,11 +113,11 @@ class InputSyslogTLSSettingsServerSide2TypedDict(TypedDict):
113
113
  r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
114
114
  reject_unauthorized: NotRequired[Any]
115
115
  common_name_regex: NotRequired[Any]
116
- min_version: NotRequired[InputSyslogMinimumTLSVersion2]
117
- max_version: NotRequired[InputSyslogMaximumTLSVersion2]
116
+ min_version: NotRequired[InputSyslogMinimumTLSVersion]
117
+ max_version: NotRequired[InputSyslogMaximumTLSVersion]
118
118
 
119
119
 
120
- class InputSyslogTLSSettingsServerSide2(BaseModel):
120
+ class InputSyslogTLSSettingsServerSide(BaseModel):
121
121
  disabled: Optional[bool] = True
122
122
 
123
123
  certificate_name: Annotated[
@@ -149,31 +149,29 @@ class InputSyslogTLSSettingsServerSide2(BaseModel):
149
149
  ] = None
150
150
 
151
151
  min_version: Annotated[
152
- Optional[InputSyslogMinimumTLSVersion2], pydantic.Field(alias="minVersion")
152
+ Optional[InputSyslogMinimumTLSVersion], pydantic.Field(alias="minVersion")
153
153
  ] = None
154
154
 
155
155
  max_version: Annotated[
156
- Optional[InputSyslogMaximumTLSVersion2], pydantic.Field(alias="maxVersion")
156
+ Optional[InputSyslogMaximumTLSVersion], pydantic.Field(alias="maxVersion")
157
157
  ] = None
158
158
 
159
159
 
160
- class InputSyslogMetadatum2TypedDict(TypedDict):
160
+ class InputSyslogMetadatumTypedDict(TypedDict):
161
161
  name: str
162
162
  value: str
163
163
  r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
164
164
 
165
165
 
166
- class InputSyslogMetadatum2(BaseModel):
166
+ class InputSyslogMetadatum(BaseModel):
167
167
  name: str
168
168
 
169
169
  value: str
170
170
  r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
171
171
 
172
172
 
173
- class InputSyslogSyslog2TypedDict(TypedDict):
174
- type: InputSyslogType2
175
- tcp_port: float
176
- r"""Enter TCP port number to listen on. Not required if listening on UDP."""
173
+ class InputSyslogTypedDict(TypedDict):
174
+ type: InputSyslogType
177
175
  id: NotRequired[str]
178
176
  r"""Unique ID for this input"""
179
177
  disabled: NotRequired[bool]
@@ -187,13 +185,15 @@ class InputSyslogSyslog2TypedDict(TypedDict):
187
185
  r"""Use a disk queue to minimize data loss when connected services block. See [Cribl Docs](https://docs.cribl.io/stream/persistent-queues) for PQ defaults (Cribl-managed Cloud Workers) and configuration options (on-prem and hybrid Workers)."""
188
186
  streamtags: NotRequired[List[str]]
189
187
  r"""Tags for filtering and grouping in @{product}"""
190
- connections: NotRequired[List[InputSyslogConnection2TypedDict]]
188
+ connections: NotRequired[List[InputSyslogConnectionTypedDict]]
191
189
  r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
192
- pq: NotRequired[InputSyslogPq2TypedDict]
190
+ pq: NotRequired[InputSyslogPqTypedDict]
193
191
  host: NotRequired[str]
194
192
  r"""Address to bind on. For IPv4 (all addresses), use the default '0.0.0.0'. For IPv6, enter '::' (all addresses) or specify an IP address."""
195
193
  udp_port: NotRequired[float]
196
194
  r"""Enter UDP port number to listen on. Not required if listening on TCP."""
195
+ tcp_port: NotRequired[float]
196
+ r"""Enter TCP port number to listen on. Not required if listening on UDP."""
197
197
  max_buffer_size: NotRequired[float]
198
198
  r"""Maximum number of events to buffer when downstream is blocking. Only applies to UDP."""
199
199
  ip_whitelist_regex: NotRequired[str]
@@ -222,8 +222,8 @@ class InputSyslogSyslog2TypedDict(TypedDict):
222
222
  r"""How long the server will wait after initiating a closure for a client to close its end of the connection. If the client doesn't close the connection within this time, the server will forcefully terminate the socket to prevent resource leaks and ensure efficient connection cleanup and system stability. Leave at 0 for no inactive socket monitoring."""
223
223
  socket_max_lifespan: NotRequired[float]
224
224
  r"""The maximum duration a socket can remain open, even if active. This helps manage resources and mitigate issues caused by TCP pinning. Set to 0 to disable."""
225
- tls: NotRequired[InputSyslogTLSSettingsServerSide2TypedDict]
226
- metadata: NotRequired[List[InputSyslogMetadatum2TypedDict]]
225
+ tls: NotRequired[InputSyslogTLSSettingsServerSideTypedDict]
226
+ metadata: NotRequired[List[InputSyslogMetadatumTypedDict]]
227
227
  r"""Fields to add to events from this input"""
228
228
  udp_socket_rx_buf_size: NotRequired[float]
229
229
  r"""Optionally, set the SO_RCVBUF socket option for the UDP socket. This value tells the operating system how many bytes can be buffered in the kernel before events are dropped. Leave blank to use the OS default. Caution: Increasing this value will affect OS memory utilization."""
@@ -234,11 +234,8 @@ class InputSyslogSyslog2TypedDict(TypedDict):
234
234
  r"""When enabled, parses PROXY protocol headers during the TLS handshake. Disable if compatibility issues arise."""
235
235
 
236
236
 
237
- class InputSyslogSyslog2(BaseModel):
238
- type: InputSyslogType2
239
-
240
- tcp_port: Annotated[float, pydantic.Field(alias="tcpPort")]
241
- r"""Enter TCP port number to listen on. Not required if listening on UDP."""
237
+ class InputSyslog(BaseModel):
238
+ type: InputSyslogType
242
239
 
243
240
  id: Optional[str] = None
244
241
  r"""Unique ID for this input"""
@@ -262,10 +259,10 @@ class InputSyslogSyslog2(BaseModel):
262
259
  streamtags: Optional[List[str]] = None
263
260
  r"""Tags for filtering and grouping in @{product}"""
264
261
 
265
- connections: Optional[List[InputSyslogConnection2]] = None
262
+ connections: Optional[List[InputSyslogConnection]] = None
266
263
  r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
267
264
 
268
- pq: Optional[InputSyslogPq2] = None
265
+ pq: Optional[InputSyslogPq] = None
269
266
 
270
267
  host: Optional[str] = "0.0.0.0"
271
268
  r"""Address to bind on. For IPv4 (all addresses), use the default '0.0.0.0'. For IPv6, enter '::' (all addresses) or specify an IP address."""
@@ -273,361 +270,6 @@ class InputSyslogSyslog2(BaseModel):
273
270
  udp_port: Annotated[Optional[float], pydantic.Field(alias="udpPort")] = None
274
271
  r"""Enter UDP port number to listen on. Not required if listening on TCP."""
275
272
 
276
- max_buffer_size: Annotated[
277
- Optional[float], pydantic.Field(alias="maxBufferSize")
278
- ] = 1000
279
- r"""Maximum number of events to buffer when downstream is blocking. Only applies to UDP."""
280
-
281
- ip_whitelist_regex: Annotated[
282
- Optional[str], pydantic.Field(alias="ipWhitelistRegex")
283
- ] = "/.*/"
284
- r"""Regex matching IP addresses that are allowed to send data"""
285
-
286
- timestamp_timezone: Annotated[
287
- Optional[str], pydantic.Field(alias="timestampTimezone")
288
- ] = "local"
289
- r"""Timezone to assign to timestamps without timezone info"""
290
-
291
- single_msg_udp_packets: Annotated[
292
- Optional[bool], pydantic.Field(alias="singleMsgUdpPackets")
293
- ] = False
294
- r"""Treat UDP packet data received as full syslog message"""
295
-
296
- enable_proxy_header: Annotated[
297
- Optional[bool], pydantic.Field(alias="enableProxyHeader")
298
- ] = False
299
- r"""Enable if the connection is proxied by a device that supports Proxy Protocol V1 or V2"""
300
-
301
- keep_fields_list: Annotated[
302
- Optional[List[str]], pydantic.Field(alias="keepFieldsList")
303
- ] = None
304
- r"""Wildcard list of fields to keep from source data; * = ALL (default)"""
305
-
306
- octet_counting: Annotated[Optional[bool], pydantic.Field(alias="octetCounting")] = (
307
- False
308
- )
309
- r"""Enable if incoming messages use octet counting per RFC 6587."""
310
-
311
- infer_framing: Annotated[Optional[bool], pydantic.Field(alias="inferFraming")] = (
312
- True
313
- )
314
- r"""Enable if we should infer the syslog framing of the incoming messages."""
315
-
316
- strictly_infer_octet_counting: Annotated[
317
- Optional[bool], pydantic.Field(alias="strictlyInferOctetCounting")
318
- ] = True
319
- r"""Enable if we should infer octet counting only if the messages comply with RFC 5424."""
320
-
321
- allow_non_standard_app_name: Annotated[
322
- Optional[bool], pydantic.Field(alias="allowNonStandardAppName")
323
- ] = False
324
- r"""Enable if RFC 3164-formatted messages have hyphens in the app name portion of the TAG section. If disabled, only alphanumeric characters and underscores are allowed. Ignored for RFC 5424-formatted messages."""
325
-
326
- max_active_cxn: Annotated[Optional[float], pydantic.Field(alias="maxActiveCxn")] = (
327
- 1000
328
- )
329
- r"""Maximum number of active connections allowed per Worker Process for TCP connections. Use 0 for unlimited."""
330
-
331
- socket_idle_timeout: Annotated[
332
- Optional[float], pydantic.Field(alias="socketIdleTimeout")
333
- ] = 0
334
- r"""How long @{product} should wait before assuming that an inactive socket has timed out. After this time, the connection will be closed. Leave at 0 for no inactive socket monitoring."""
335
-
336
- socket_ending_max_wait: Annotated[
337
- Optional[float], pydantic.Field(alias="socketEndingMaxWait")
338
- ] = 30
339
- r"""How long the server will wait after initiating a closure for a client to close its end of the connection. If the client doesn't close the connection within this time, the server will forcefully terminate the socket to prevent resource leaks and ensure efficient connection cleanup and system stability. Leave at 0 for no inactive socket monitoring."""
340
-
341
- socket_max_lifespan: Annotated[
342
- Optional[float], pydantic.Field(alias="socketMaxLifespan")
343
- ] = 0
344
- r"""The maximum duration a socket can remain open, even if active. This helps manage resources and mitigate issues caused by TCP pinning. Set to 0 to disable."""
345
-
346
- tls: Optional[InputSyslogTLSSettingsServerSide2] = None
347
-
348
- metadata: Optional[List[InputSyslogMetadatum2]] = None
349
- r"""Fields to add to events from this input"""
350
-
351
- udp_socket_rx_buf_size: Annotated[
352
- Optional[float], pydantic.Field(alias="udpSocketRxBufSize")
353
- ] = None
354
- r"""Optionally, set the SO_RCVBUF socket option for the UDP socket. This value tells the operating system how many bytes can be buffered in the kernel before events are dropped. Leave blank to use the OS default. Caution: Increasing this value will affect OS memory utilization."""
355
-
356
- enable_load_balancing: Annotated[
357
- Optional[bool], pydantic.Field(alias="enableLoadBalancing")
358
- ] = False
359
- r"""Load balance traffic across all Worker Processes"""
360
-
361
- description: Optional[str] = None
362
-
363
- enable_enhanced_proxy_header_parsing: Annotated[
364
- Optional[bool], pydantic.Field(alias="enableEnhancedProxyHeaderParsing")
365
- ] = None
366
- r"""When enabled, parses PROXY protocol headers during the TLS handshake. Disable if compatibility issues arise."""
367
-
368
-
369
- class InputSyslogType1(str, Enum):
370
- SYSLOG = "syslog"
371
-
372
-
373
- class InputSyslogConnection1TypedDict(TypedDict):
374
- output: str
375
- pipeline: NotRequired[str]
376
-
377
-
378
- class InputSyslogConnection1(BaseModel):
379
- output: str
380
-
381
- pipeline: Optional[str] = None
382
-
383
-
384
- class InputSyslogMode1(str, Enum):
385
- r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
386
-
387
- SMART = "smart"
388
- ALWAYS = "always"
389
-
390
-
391
- class InputSyslogCompression1(str, Enum):
392
- r"""Codec to use to compress the persisted data"""
393
-
394
- NONE = "none"
395
- GZIP = "gzip"
396
-
397
-
398
- class InputSyslogPq1TypedDict(TypedDict):
399
- mode: NotRequired[InputSyslogMode1]
400
- r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
401
- max_buffer_size: NotRequired[float]
402
- r"""The maximum number of events to hold in memory before writing the events to disk"""
403
- commit_frequency: NotRequired[float]
404
- r"""The number of events to send downstream before committing that Stream has read them"""
405
- max_file_size: NotRequired[str]
406
- r"""The maximum size to store in each queue file before closing and optionally compressing. Enter a numeral with units of KB, MB, etc."""
407
- max_size: NotRequired[str]
408
- r"""The maximum disk space that the queue can consume (as an average per Worker Process) before queueing stops. Enter a numeral with units of KB, MB, etc."""
409
- path: NotRequired[str]
410
- r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
411
- compress: NotRequired[InputSyslogCompression1]
412
- r"""Codec to use to compress the persisted data"""
413
-
414
-
415
- class InputSyslogPq1(BaseModel):
416
- mode: Optional[InputSyslogMode1] = InputSyslogMode1.ALWAYS
417
- r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
418
-
419
- max_buffer_size: Annotated[
420
- Optional[float], pydantic.Field(alias="maxBufferSize")
421
- ] = 1000
422
- r"""The maximum number of events to hold in memory before writing the events to disk"""
423
-
424
- commit_frequency: Annotated[
425
- Optional[float], pydantic.Field(alias="commitFrequency")
426
- ] = 42
427
- r"""The number of events to send downstream before committing that Stream has read them"""
428
-
429
- max_file_size: Annotated[Optional[str], pydantic.Field(alias="maxFileSize")] = (
430
- "1 MB"
431
- )
432
- r"""The maximum size to store in each queue file before closing and optionally compressing. Enter a numeral with units of KB, MB, etc."""
433
-
434
- max_size: Annotated[Optional[str], pydantic.Field(alias="maxSize")] = "5GB"
435
- r"""The maximum disk space that the queue can consume (as an average per Worker Process) before queueing stops. Enter a numeral with units of KB, MB, etc."""
436
-
437
- path: Optional[str] = "$CRIBL_HOME/state/queues"
438
- r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
439
-
440
- compress: Optional[InputSyslogCompression1] = InputSyslogCompression1.NONE
441
- r"""Codec to use to compress the persisted data"""
442
-
443
-
444
- class InputSyslogMinimumTLSVersion1(str, Enum):
445
- TL_SV1 = "TLSv1"
446
- TL_SV1_1 = "TLSv1.1"
447
- TL_SV1_2 = "TLSv1.2"
448
- TL_SV1_3 = "TLSv1.3"
449
-
450
-
451
- class InputSyslogMaximumTLSVersion1(str, Enum):
452
- TL_SV1 = "TLSv1"
453
- TL_SV1_1 = "TLSv1.1"
454
- TL_SV1_2 = "TLSv1.2"
455
- TL_SV1_3 = "TLSv1.3"
456
-
457
-
458
- class InputSyslogTLSSettingsServerSide1TypedDict(TypedDict):
459
- disabled: NotRequired[bool]
460
- certificate_name: NotRequired[str]
461
- r"""The name of the predefined certificate"""
462
- priv_key_path: NotRequired[str]
463
- r"""Path on server containing the private key to use. PEM format. Can reference $ENV_VARS."""
464
- passphrase: NotRequired[str]
465
- r"""Passphrase to use to decrypt private key"""
466
- cert_path: NotRequired[str]
467
- r"""Path on server containing certificates to use. PEM format. Can reference $ENV_VARS."""
468
- ca_path: NotRequired[str]
469
- r"""Path on server containing CA certificates to use. PEM format. Can reference $ENV_VARS."""
470
- request_cert: NotRequired[bool]
471
- r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
472
- reject_unauthorized: NotRequired[Any]
473
- common_name_regex: NotRequired[Any]
474
- min_version: NotRequired[InputSyslogMinimumTLSVersion1]
475
- max_version: NotRequired[InputSyslogMaximumTLSVersion1]
476
-
477
-
478
- class InputSyslogTLSSettingsServerSide1(BaseModel):
479
- disabled: Optional[bool] = True
480
-
481
- certificate_name: Annotated[
482
- Optional[str], pydantic.Field(alias="certificateName")
483
- ] = None
484
- r"""The name of the predefined certificate"""
485
-
486
- priv_key_path: Annotated[Optional[str], pydantic.Field(alias="privKeyPath")] = None
487
- r"""Path on server containing the private key to use. PEM format. Can reference $ENV_VARS."""
488
-
489
- passphrase: Optional[str] = None
490
- r"""Passphrase to use to decrypt private key"""
491
-
492
- cert_path: Annotated[Optional[str], pydantic.Field(alias="certPath")] = None
493
- r"""Path on server containing certificates to use. PEM format. Can reference $ENV_VARS."""
494
-
495
- ca_path: Annotated[Optional[str], pydantic.Field(alias="caPath")] = None
496
- r"""Path on server containing CA certificates to use. PEM format. Can reference $ENV_VARS."""
497
-
498
- request_cert: Annotated[Optional[bool], pydantic.Field(alias="requestCert")] = False
499
- r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
500
-
501
- reject_unauthorized: Annotated[
502
- Optional[Any], pydantic.Field(alias="rejectUnauthorized")
503
- ] = None
504
-
505
- common_name_regex: Annotated[
506
- Optional[Any], pydantic.Field(alias="commonNameRegex")
507
- ] = None
508
-
509
- min_version: Annotated[
510
- Optional[InputSyslogMinimumTLSVersion1], pydantic.Field(alias="minVersion")
511
- ] = None
512
-
513
- max_version: Annotated[
514
- Optional[InputSyslogMaximumTLSVersion1], pydantic.Field(alias="maxVersion")
515
- ] = None
516
-
517
-
518
- class InputSyslogMetadatum1TypedDict(TypedDict):
519
- name: str
520
- value: str
521
- r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
522
-
523
-
524
- class InputSyslogMetadatum1(BaseModel):
525
- name: str
526
-
527
- value: str
528
- r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
529
-
530
-
531
- class InputSyslogSyslog1TypedDict(TypedDict):
532
- type: InputSyslogType1
533
- udp_port: float
534
- r"""Enter UDP port number to listen on. Not required if listening on TCP."""
535
- id: NotRequired[str]
536
- r"""Unique ID for this input"""
537
- disabled: NotRequired[bool]
538
- pipeline: NotRequired[str]
539
- r"""Pipeline to process data from this Source before sending it through the Routes"""
540
- send_to_routes: NotRequired[bool]
541
- r"""Select whether to send data to Routes, or directly to Destinations."""
542
- environment: NotRequired[str]
543
- r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
544
- pq_enabled: NotRequired[bool]
545
- r"""Use a disk queue to minimize data loss when connected services block. See [Cribl Docs](https://docs.cribl.io/stream/persistent-queues) for PQ defaults (Cribl-managed Cloud Workers) and configuration options (on-prem and hybrid Workers)."""
546
- streamtags: NotRequired[List[str]]
547
- r"""Tags for filtering and grouping in @{product}"""
548
- connections: NotRequired[List[InputSyslogConnection1TypedDict]]
549
- r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
550
- pq: NotRequired[InputSyslogPq1TypedDict]
551
- host: NotRequired[str]
552
- r"""Address to bind on. For IPv4 (all addresses), use the default '0.0.0.0'. For IPv6, enter '::' (all addresses) or specify an IP address."""
553
- tcp_port: NotRequired[float]
554
- r"""Enter TCP port number to listen on. Not required if listening on UDP."""
555
- max_buffer_size: NotRequired[float]
556
- r"""Maximum number of events to buffer when downstream is blocking. Only applies to UDP."""
557
- ip_whitelist_regex: NotRequired[str]
558
- r"""Regex matching IP addresses that are allowed to send data"""
559
- timestamp_timezone: NotRequired[str]
560
- r"""Timezone to assign to timestamps without timezone info"""
561
- single_msg_udp_packets: NotRequired[bool]
562
- r"""Treat UDP packet data received as full syslog message"""
563
- enable_proxy_header: NotRequired[bool]
564
- r"""Enable if the connection is proxied by a device that supports Proxy Protocol V1 or V2"""
565
- keep_fields_list: NotRequired[List[str]]
566
- r"""Wildcard list of fields to keep from source data; * = ALL (default)"""
567
- octet_counting: NotRequired[bool]
568
- r"""Enable if incoming messages use octet counting per RFC 6587."""
569
- infer_framing: NotRequired[bool]
570
- r"""Enable if we should infer the syslog framing of the incoming messages."""
571
- strictly_infer_octet_counting: NotRequired[bool]
572
- r"""Enable if we should infer octet counting only if the messages comply with RFC 5424."""
573
- allow_non_standard_app_name: NotRequired[bool]
574
- r"""Enable if RFC 3164-formatted messages have hyphens in the app name portion of the TAG section. If disabled, only alphanumeric characters and underscores are allowed. Ignored for RFC 5424-formatted messages."""
575
- max_active_cxn: NotRequired[float]
576
- r"""Maximum number of active connections allowed per Worker Process for TCP connections. Use 0 for unlimited."""
577
- socket_idle_timeout: NotRequired[float]
578
- r"""How long @{product} should wait before assuming that an inactive socket has timed out. After this time, the connection will be closed. Leave at 0 for no inactive socket monitoring."""
579
- socket_ending_max_wait: NotRequired[float]
580
- r"""How long the server will wait after initiating a closure for a client to close its end of the connection. If the client doesn't close the connection within this time, the server will forcefully terminate the socket to prevent resource leaks and ensure efficient connection cleanup and system stability. Leave at 0 for no inactive socket monitoring."""
581
- socket_max_lifespan: NotRequired[float]
582
- r"""The maximum duration a socket can remain open, even if active. This helps manage resources and mitigate issues caused by TCP pinning. Set to 0 to disable."""
583
- tls: NotRequired[InputSyslogTLSSettingsServerSide1TypedDict]
584
- metadata: NotRequired[List[InputSyslogMetadatum1TypedDict]]
585
- r"""Fields to add to events from this input"""
586
- udp_socket_rx_buf_size: NotRequired[float]
587
- r"""Optionally, set the SO_RCVBUF socket option for the UDP socket. This value tells the operating system how many bytes can be buffered in the kernel before events are dropped. Leave blank to use the OS default. Caution: Increasing this value will affect OS memory utilization."""
588
- enable_load_balancing: NotRequired[bool]
589
- r"""Load balance traffic across all Worker Processes"""
590
- description: NotRequired[str]
591
- enable_enhanced_proxy_header_parsing: NotRequired[bool]
592
- r"""When enabled, parses PROXY protocol headers during the TLS handshake. Disable if compatibility issues arise."""
593
-
594
-
595
- class InputSyslogSyslog1(BaseModel):
596
- type: InputSyslogType1
597
-
598
- udp_port: Annotated[float, pydantic.Field(alias="udpPort")]
599
- r"""Enter UDP port number to listen on. Not required if listening on TCP."""
600
-
601
- id: Optional[str] = None
602
- r"""Unique ID for this input"""
603
-
604
- disabled: Optional[bool] = False
605
-
606
- pipeline: Optional[str] = None
607
- r"""Pipeline to process data from this Source before sending it through the Routes"""
608
-
609
- send_to_routes: Annotated[Optional[bool], pydantic.Field(alias="sendToRoutes")] = (
610
- True
611
- )
612
- r"""Select whether to send data to Routes, or directly to Destinations."""
613
-
614
- environment: Optional[str] = None
615
- r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
616
-
617
- pq_enabled: Annotated[Optional[bool], pydantic.Field(alias="pqEnabled")] = False
618
- r"""Use a disk queue to minimize data loss when connected services block. See [Cribl Docs](https://docs.cribl.io/stream/persistent-queues) for PQ defaults (Cribl-managed Cloud Workers) and configuration options (on-prem and hybrid Workers)."""
619
-
620
- streamtags: Optional[List[str]] = None
621
- r"""Tags for filtering and grouping in @{product}"""
622
-
623
- connections: Optional[List[InputSyslogConnection1]] = None
624
- r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
625
-
626
- pq: Optional[InputSyslogPq1] = None
627
-
628
- host: Optional[str] = "0.0.0.0"
629
- r"""Address to bind on. For IPv4 (all addresses), use the default '0.0.0.0'. For IPv6, enter '::' (all addresses) or specify an IP address."""
630
-
631
273
  tcp_port: Annotated[Optional[float], pydantic.Field(alias="tcpPort")] = None
632
274
  r"""Enter TCP port number to listen on. Not required if listening on UDP."""
633
275
 
@@ -701,9 +343,9 @@ class InputSyslogSyslog1(BaseModel):
701
343
  ] = 0
702
344
  r"""The maximum duration a socket can remain open, even if active. This helps manage resources and mitigate issues caused by TCP pinning. Set to 0 to disable."""
703
345
 
704
- tls: Optional[InputSyslogTLSSettingsServerSide1] = None
346
+ tls: Optional[InputSyslogTLSSettingsServerSide] = None
705
347
 
706
- metadata: Optional[List[InputSyslogMetadatum1]] = None
348
+ metadata: Optional[List[InputSyslogMetadatum]] = None
707
349
  r"""Fields to add to events from this input"""
708
350
 
709
351
  udp_socket_rx_buf_size: Annotated[
@@ -722,14 +364,3 @@ class InputSyslogSyslog1(BaseModel):
722
364
  Optional[bool], pydantic.Field(alias="enableEnhancedProxyHeaderParsing")
723
365
  ] = None
724
366
  r"""When enabled, parses PROXY protocol headers during the TLS handshake. Disable if compatibility issues arise."""
725
-
726
-
727
- InputSyslogTypedDict = TypeAliasType(
728
- "InputSyslogTypedDict",
729
- Union[InputSyslogSyslog1TypedDict, InputSyslogSyslog2TypedDict],
730
- )
731
-
732
-
733
- InputSyslog = TypeAliasType(
734
- "InputSyslog", Union[InputSyslogSyslog1, InputSyslogSyslog2]
735
- )