cribl-control-plane 0.2.1rc4__py3-none-any.whl → 0.2.1rc6__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.
- cribl_control_plane/_version.py +3 -3
- cribl_control_plane/groups_sdk.py +2 -2
- cribl_control_plane/models/__init__.py +3 -99
- cribl_control_plane/models/createconfiggroupbyproductop.py +2 -2
- cribl_control_plane/models/input.py +14 -14
- cribl_control_plane/models/inputappscope.py +16 -20
- cribl_control_plane/models/inputconfluentcloud.py +0 -110
- cribl_control_plane/models/inputcriblhttp.py +16 -20
- cribl_control_plane/models/inputcribllakehttp.py +16 -20
- cribl_control_plane/models/inputcribltcp.py +16 -20
- cribl_control_plane/models/inputdatadogagent.py +16 -20
- cribl_control_plane/models/inputedgeprometheus.py +36 -44
- cribl_control_plane/models/inputelastic.py +27 -44
- cribl_control_plane/models/inputeventhub.py +0 -118
- cribl_control_plane/models/inputfirehose.py +16 -20
- cribl_control_plane/models/inputgrafana.py +31 -39
- cribl_control_plane/models/inputhttp.py +16 -20
- cribl_control_plane/models/inputhttpraw.py +16 -20
- cribl_control_plane/models/inputkafka.py +0 -108
- cribl_control_plane/models/inputloki.py +16 -20
- cribl_control_plane/models/inputmetrics.py +16 -20
- cribl_control_plane/models/inputmodeldriventelemetry.py +16 -20
- cribl_control_plane/models/inputopentelemetry.py +15 -19
- cribl_control_plane/models/inputprometheus.py +36 -44
- cribl_control_plane/models/inputprometheusrw.py +16 -20
- cribl_control_plane/models/inputsplunk.py +16 -20
- cribl_control_plane/models/inputsplunkhec.py +15 -19
- cribl_control_plane/models/inputsyslog.py +31 -39
- cribl_control_plane/models/inputsystemmetrics.py +10 -20
- cribl_control_plane/models/inputtcp.py +16 -30
- cribl_control_plane/models/inputtcpjson.py +16 -20
- cribl_control_plane/models/inputwindowsmetrics.py +10 -20
- cribl_control_plane/models/inputwineventlogs.py +0 -14
- cribl_control_plane/models/inputwizwebhook.py +16 -20
- cribl_control_plane/models/inputzscalerhec.py +15 -19
- cribl_control_plane/models/output.py +22 -22
- cribl_control_plane/models/outputazureblob.py +0 -7
- cribl_control_plane/models/outputazuredataexplorer.py +93 -283
- cribl_control_plane/models/outputazureeventhub.py +21 -169
- cribl_control_plane/models/outputazurelogs.py +21 -49
- cribl_control_plane/models/outputchronicle.py +21 -49
- cribl_control_plane/models/outputclickhouse.py +21 -49
- cribl_control_plane/models/outputcloudwatch.py +21 -49
- cribl_control_plane/models/outputconfluentcloud.py +22 -167
- cribl_control_plane/models/outputcriblhttp.py +21 -49
- cribl_control_plane/models/outputcribltcp.py +21 -49
- cribl_control_plane/models/outputcrowdstrikenextgensiem.py +22 -50
- cribl_control_plane/models/outputdatabricks.py +0 -7
- cribl_control_plane/models/outputdatadog.py +21 -49
- cribl_control_plane/models/outputdataset.py +21 -49
- cribl_control_plane/models/outputdls3.py +0 -7
- cribl_control_plane/models/outputdynatracehttp.py +21 -49
- cribl_control_plane/models/outputdynatraceotlp.py +21 -49
- cribl_control_plane/models/outputelastic.py +21 -74
- cribl_control_plane/models/outputelasticcloud.py +21 -74
- cribl_control_plane/models/outputfilesystem.py +0 -7
- cribl_control_plane/models/outputgooglechronicle.py +22 -65
- cribl_control_plane/models/outputgooglecloudlogging.py +22 -50
- cribl_control_plane/models/outputgooglecloudstorage.py +0 -7
- cribl_control_plane/models/outputgooglepubsub.py +21 -49
- cribl_control_plane/models/outputgrafanacloud.py +42 -98
- cribl_control_plane/models/outputgraphite.py +21 -49
- cribl_control_plane/models/outputhoneycomb.py +21 -49
- cribl_control_plane/models/outputhumiohec.py +21 -49
- cribl_control_plane/models/outputinfluxdb.py +21 -49
- cribl_control_plane/models/outputkafka.py +19 -162
- cribl_control_plane/models/outputkinesis.py +21 -56
- cribl_control_plane/models/outputloki.py +19 -47
- cribl_control_plane/models/outputminio.py +0 -7
- cribl_control_plane/models/outputmsk.py +19 -54
- cribl_control_plane/models/outputnewrelic.py +21 -49
- cribl_control_plane/models/outputnewrelicevents.py +22 -50
- cribl_control_plane/models/outputopentelemetry.py +21 -49
- cribl_control_plane/models/outputprometheus.py +21 -49
- cribl_control_plane/models/outputs3.py +0 -7
- cribl_control_plane/models/outputsentinel.py +21 -49
- cribl_control_plane/models/outputsentineloneaisiem.py +22 -50
- cribl_control_plane/models/outputservicenow.py +21 -49
- cribl_control_plane/models/outputsignalfx.py +21 -49
- cribl_control_plane/models/outputsns.py +19 -47
- cribl_control_plane/models/outputsplunk.py +21 -49
- cribl_control_plane/models/outputsplunkhec.py +21 -49
- cribl_control_plane/models/outputsplunklb.py +21 -49
- cribl_control_plane/models/outputsqs.py +19 -47
- cribl_control_plane/models/outputstatsd.py +21 -49
- cribl_control_plane/models/outputstatsdext.py +21 -49
- cribl_control_plane/models/outputsumologic.py +21 -49
- cribl_control_plane/models/outputsyslog.py +99 -129
- cribl_control_plane/models/outputtcpjson.py +21 -49
- cribl_control_plane/models/outputwavefront.py +21 -49
- cribl_control_plane/models/outputwebhook.py +21 -49
- cribl_control_plane/models/outputxsiam.py +19 -47
- cribl_control_plane/models/runnablejobcollection.py +8 -12
- cribl_control_plane/models/runnablejobexecutor.py +8 -12
- cribl_control_plane/models/runnablejobscheduledsearch.py +8 -12
- {cribl_control_plane-0.2.1rc4.dist-info → cribl_control_plane-0.2.1rc6.dist-info}/METADATA +1 -1
- {cribl_control_plane-0.2.1rc4.dist-info → cribl_control_plane-0.2.1rc6.dist-info}/RECORD +98 -98
- {cribl_control_plane-0.2.1rc4.dist-info → cribl_control_plane-0.2.1rc6.dist-info}/WHEEL +0 -0
|
@@ -44,17 +44,6 @@ class OutputSnsBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
|
44
44
|
QUEUE = "queue"
|
|
45
45
|
|
|
46
46
|
|
|
47
|
-
class OutputSnsMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
48
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
49
|
-
|
|
50
|
-
# Error
|
|
51
|
-
ERROR = "error"
|
|
52
|
-
# Backpressure
|
|
53
|
-
ALWAYS = "always"
|
|
54
|
-
# Always On
|
|
55
|
-
BACKPRESSURE = "backpressure"
|
|
56
|
-
|
|
57
|
-
|
|
58
47
|
class OutputSnsCompression(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
59
48
|
r"""Codec to use to compress the persisted data"""
|
|
60
49
|
|
|
@@ -73,6 +62,17 @@ class OutputSnsQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
|
73
62
|
DROP = "drop"
|
|
74
63
|
|
|
75
64
|
|
|
65
|
+
class OutputSnsMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
66
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
67
|
+
|
|
68
|
+
# Error
|
|
69
|
+
ERROR = "error"
|
|
70
|
+
# Backpressure
|
|
71
|
+
BACKPRESSURE = "backpressure"
|
|
72
|
+
# Always On
|
|
73
|
+
ALWAYS = "always"
|
|
74
|
+
|
|
75
|
+
|
|
76
76
|
class OutputSnsPqControlsTypedDict(TypedDict):
|
|
77
77
|
pass
|
|
78
78
|
|
|
@@ -126,16 +126,6 @@ class OutputSnsTypedDict(TypedDict):
|
|
|
126
126
|
aws_api_key: NotRequired[str]
|
|
127
127
|
aws_secret: NotRequired[str]
|
|
128
128
|
r"""Select or create a stored secret that references your access key and secret key"""
|
|
129
|
-
pq_strict_ordering: NotRequired[bool]
|
|
130
|
-
r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
|
|
131
|
-
pq_rate_per_sec: NotRequired[float]
|
|
132
|
-
r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
|
|
133
|
-
pq_mode: NotRequired[OutputSnsMode]
|
|
134
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
135
|
-
pq_max_buffer_size: NotRequired[float]
|
|
136
|
-
r"""The maximum number of events to hold in memory before writing the events to disk"""
|
|
137
|
-
pq_max_backpressure_sec: NotRequired[float]
|
|
138
|
-
r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
|
|
139
129
|
pq_max_file_size: NotRequired[str]
|
|
140
130
|
r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
|
|
141
131
|
pq_max_size: NotRequired[str]
|
|
@@ -146,6 +136,8 @@ class OutputSnsTypedDict(TypedDict):
|
|
|
146
136
|
r"""Codec to use to compress the persisted data"""
|
|
147
137
|
pq_on_backpressure: NotRequired[OutputSnsQueueFullBehavior]
|
|
148
138
|
r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
|
|
139
|
+
pq_mode: NotRequired[OutputSnsMode]
|
|
140
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
149
141
|
pq_controls: NotRequired[OutputSnsPqControlsTypedDict]
|
|
150
142
|
|
|
151
143
|
|
|
@@ -252,32 +244,6 @@ class OutputSns(BaseModel):
|
|
|
252
244
|
aws_secret: Annotated[Optional[str], pydantic.Field(alias="awsSecret")] = None
|
|
253
245
|
r"""Select or create a stored secret that references your access key and secret key"""
|
|
254
246
|
|
|
255
|
-
pq_strict_ordering: Annotated[
|
|
256
|
-
Optional[bool], pydantic.Field(alias="pqStrictOrdering")
|
|
257
|
-
] = True
|
|
258
|
-
r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
|
|
259
|
-
|
|
260
|
-
pq_rate_per_sec: Annotated[
|
|
261
|
-
Optional[float], pydantic.Field(alias="pqRatePerSec")
|
|
262
|
-
] = 0
|
|
263
|
-
r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
|
|
264
|
-
|
|
265
|
-
pq_mode: Annotated[
|
|
266
|
-
Annotated[Optional[OutputSnsMode], PlainValidator(validate_open_enum(False))],
|
|
267
|
-
pydantic.Field(alias="pqMode"),
|
|
268
|
-
] = OutputSnsMode.ERROR
|
|
269
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
270
|
-
|
|
271
|
-
pq_max_buffer_size: Annotated[
|
|
272
|
-
Optional[float], pydantic.Field(alias="pqMaxBufferSize")
|
|
273
|
-
] = 42
|
|
274
|
-
r"""The maximum number of events to hold in memory before writing the events to disk"""
|
|
275
|
-
|
|
276
|
-
pq_max_backpressure_sec: Annotated[
|
|
277
|
-
Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
|
|
278
|
-
] = 30
|
|
279
|
-
r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
|
|
280
|
-
|
|
281
247
|
pq_max_file_size: Annotated[
|
|
282
248
|
Optional[str], pydantic.Field(alias="pqMaxFileSize")
|
|
283
249
|
] = "1 MB"
|
|
@@ -308,6 +274,12 @@ class OutputSns(BaseModel):
|
|
|
308
274
|
] = OutputSnsQueueFullBehavior.BLOCK
|
|
309
275
|
r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
|
|
310
276
|
|
|
277
|
+
pq_mode: Annotated[
|
|
278
|
+
Annotated[Optional[OutputSnsMode], PlainValidator(validate_open_enum(False))],
|
|
279
|
+
pydantic.Field(alias="pqMode"),
|
|
280
|
+
] = OutputSnsMode.ERROR
|
|
281
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
282
|
+
|
|
311
283
|
pq_controls: Annotated[
|
|
312
284
|
Optional[OutputSnsPqControls], pydantic.Field(alias="pqControls")
|
|
313
285
|
] = None
|
|
@@ -143,17 +143,6 @@ class OutputSplunkCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
|
143
143
|
ALWAYS = "always"
|
|
144
144
|
|
|
145
145
|
|
|
146
|
-
class OutputSplunkMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
147
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
148
|
-
|
|
149
|
-
# Error
|
|
150
|
-
ERROR = "error"
|
|
151
|
-
# Backpressure
|
|
152
|
-
ALWAYS = "always"
|
|
153
|
-
# Always On
|
|
154
|
-
BACKPRESSURE = "backpressure"
|
|
155
|
-
|
|
156
|
-
|
|
157
146
|
class OutputSplunkPqCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
158
147
|
r"""Codec to use to compress the persisted data"""
|
|
159
148
|
|
|
@@ -172,6 +161,17 @@ class OutputSplunkQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
|
172
161
|
DROP = "drop"
|
|
173
162
|
|
|
174
163
|
|
|
164
|
+
class OutputSplunkMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
165
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
166
|
+
|
|
167
|
+
# Error
|
|
168
|
+
ERROR = "error"
|
|
169
|
+
# Backpressure
|
|
170
|
+
BACKPRESSURE = "backpressure"
|
|
171
|
+
# Always On
|
|
172
|
+
ALWAYS = "always"
|
|
173
|
+
|
|
174
|
+
|
|
175
175
|
class OutputSplunkPqControlsTypedDict(TypedDict):
|
|
176
176
|
pass
|
|
177
177
|
|
|
@@ -222,16 +222,6 @@ class OutputSplunkTypedDict(TypedDict):
|
|
|
222
222
|
r"""Maximum number of times healthcheck can fail before we close connection. If set to 0 (disabled), and the connection to Splunk is forcibly closed, some data loss might occur."""
|
|
223
223
|
compress: NotRequired[OutputSplunkCompressCompression]
|
|
224
224
|
r"""Controls whether the sender should send compressed data to the server. Select 'Disabled' to reject compressed connections or 'Always' to ignore server's configuration and send compressed data."""
|
|
225
|
-
pq_strict_ordering: NotRequired[bool]
|
|
226
|
-
r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
|
|
227
|
-
pq_rate_per_sec: NotRequired[float]
|
|
228
|
-
r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
|
|
229
|
-
pq_mode: NotRequired[OutputSplunkMode]
|
|
230
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
231
|
-
pq_max_buffer_size: NotRequired[float]
|
|
232
|
-
r"""The maximum number of events to hold in memory before writing the events to disk"""
|
|
233
|
-
pq_max_backpressure_sec: NotRequired[float]
|
|
234
|
-
r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
|
|
235
225
|
pq_max_file_size: NotRequired[str]
|
|
236
226
|
r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
|
|
237
227
|
pq_max_size: NotRequired[str]
|
|
@@ -242,6 +232,8 @@ class OutputSplunkTypedDict(TypedDict):
|
|
|
242
232
|
r"""Codec to use to compress the persisted data"""
|
|
243
233
|
pq_on_backpressure: NotRequired[OutputSplunkQueueFullBehavior]
|
|
244
234
|
r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
|
|
235
|
+
pq_mode: NotRequired[OutputSplunkMode]
|
|
236
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
245
237
|
pq_controls: NotRequired[OutputSplunkPqControlsTypedDict]
|
|
246
238
|
auth_token: NotRequired[str]
|
|
247
239
|
r"""Shared secret token to use when establishing a connection to a Splunk indexer."""
|
|
@@ -354,34 +346,6 @@ class OutputSplunk(BaseModel):
|
|
|
354
346
|
] = OutputSplunkCompressCompression.DISABLED
|
|
355
347
|
r"""Controls whether the sender should send compressed data to the server. Select 'Disabled' to reject compressed connections or 'Always' to ignore server's configuration and send compressed data."""
|
|
356
348
|
|
|
357
|
-
pq_strict_ordering: Annotated[
|
|
358
|
-
Optional[bool], pydantic.Field(alias="pqStrictOrdering")
|
|
359
|
-
] = True
|
|
360
|
-
r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
|
|
361
|
-
|
|
362
|
-
pq_rate_per_sec: Annotated[
|
|
363
|
-
Optional[float], pydantic.Field(alias="pqRatePerSec")
|
|
364
|
-
] = 0
|
|
365
|
-
r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
|
|
366
|
-
|
|
367
|
-
pq_mode: Annotated[
|
|
368
|
-
Annotated[
|
|
369
|
-
Optional[OutputSplunkMode], PlainValidator(validate_open_enum(False))
|
|
370
|
-
],
|
|
371
|
-
pydantic.Field(alias="pqMode"),
|
|
372
|
-
] = OutputSplunkMode.ERROR
|
|
373
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
374
|
-
|
|
375
|
-
pq_max_buffer_size: Annotated[
|
|
376
|
-
Optional[float], pydantic.Field(alias="pqMaxBufferSize")
|
|
377
|
-
] = 42
|
|
378
|
-
r"""The maximum number of events to hold in memory before writing the events to disk"""
|
|
379
|
-
|
|
380
|
-
pq_max_backpressure_sec: Annotated[
|
|
381
|
-
Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
|
|
382
|
-
] = 30
|
|
383
|
-
r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
|
|
384
|
-
|
|
385
349
|
pq_max_file_size: Annotated[
|
|
386
350
|
Optional[str], pydantic.Field(alias="pqMaxFileSize")
|
|
387
351
|
] = "1 MB"
|
|
@@ -413,6 +377,14 @@ class OutputSplunk(BaseModel):
|
|
|
413
377
|
] = OutputSplunkQueueFullBehavior.BLOCK
|
|
414
378
|
r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
|
|
415
379
|
|
|
380
|
+
pq_mode: Annotated[
|
|
381
|
+
Annotated[
|
|
382
|
+
Optional[OutputSplunkMode], PlainValidator(validate_open_enum(False))
|
|
383
|
+
],
|
|
384
|
+
pydantic.Field(alias="pqMode"),
|
|
385
|
+
] = OutputSplunkMode.ERROR
|
|
386
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
387
|
+
|
|
416
388
|
pq_controls: Annotated[
|
|
417
389
|
Optional[OutputSplunkPqControls], pydantic.Field(alias="pqControls")
|
|
418
390
|
] = None
|
|
@@ -124,17 +124,6 @@ class OutputSplunkHecURL(BaseModel):
|
|
|
124
124
|
r"""Assign a weight (>0) to each endpoint to indicate its traffic-handling capability"""
|
|
125
125
|
|
|
126
126
|
|
|
127
|
-
class OutputSplunkHecMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
128
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
129
|
-
|
|
130
|
-
# Error
|
|
131
|
-
ERROR = "error"
|
|
132
|
-
# Backpressure
|
|
133
|
-
ALWAYS = "always"
|
|
134
|
-
# Always On
|
|
135
|
-
BACKPRESSURE = "backpressure"
|
|
136
|
-
|
|
137
|
-
|
|
138
127
|
class OutputSplunkHecCompression(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
139
128
|
r"""Codec to use to compress the persisted data"""
|
|
140
129
|
|
|
@@ -153,6 +142,17 @@ class OutputSplunkHecQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
|
153
142
|
DROP = "drop"
|
|
154
143
|
|
|
155
144
|
|
|
145
|
+
class OutputSplunkHecMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
146
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
147
|
+
|
|
148
|
+
# Error
|
|
149
|
+
ERROR = "error"
|
|
150
|
+
# Backpressure
|
|
151
|
+
BACKPRESSURE = "backpressure"
|
|
152
|
+
# Always On
|
|
153
|
+
ALWAYS = "always"
|
|
154
|
+
|
|
155
|
+
|
|
156
156
|
class OutputSplunkHecPqControlsTypedDict(TypedDict):
|
|
157
157
|
pass
|
|
158
158
|
|
|
@@ -231,16 +231,6 @@ class OutputSplunkHecTypedDict(TypedDict):
|
|
|
231
231
|
r"""Splunk HEC authentication token"""
|
|
232
232
|
text_secret: NotRequired[str]
|
|
233
233
|
r"""Select or create a stored text secret"""
|
|
234
|
-
pq_strict_ordering: NotRequired[bool]
|
|
235
|
-
r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
|
|
236
|
-
pq_rate_per_sec: NotRequired[float]
|
|
237
|
-
r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
|
|
238
|
-
pq_mode: NotRequired[OutputSplunkHecMode]
|
|
239
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
240
|
-
pq_max_buffer_size: NotRequired[float]
|
|
241
|
-
r"""The maximum number of events to hold in memory before writing the events to disk"""
|
|
242
|
-
pq_max_backpressure_sec: NotRequired[float]
|
|
243
|
-
r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
|
|
244
234
|
pq_max_file_size: NotRequired[str]
|
|
245
235
|
r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
|
|
246
236
|
pq_max_size: NotRequired[str]
|
|
@@ -251,6 +241,8 @@ class OutputSplunkHecTypedDict(TypedDict):
|
|
|
251
241
|
r"""Codec to use to compress the persisted data"""
|
|
252
242
|
pq_on_backpressure: NotRequired[OutputSplunkHecQueueFullBehavior]
|
|
253
243
|
r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
|
|
244
|
+
pq_mode: NotRequired[OutputSplunkHecMode]
|
|
245
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
254
246
|
pq_controls: NotRequired[OutputSplunkHecPqControlsTypedDict]
|
|
255
247
|
|
|
256
248
|
|
|
@@ -411,34 +403,6 @@ class OutputSplunkHec(BaseModel):
|
|
|
411
403
|
text_secret: Annotated[Optional[str], pydantic.Field(alias="textSecret")] = None
|
|
412
404
|
r"""Select or create a stored text secret"""
|
|
413
405
|
|
|
414
|
-
pq_strict_ordering: Annotated[
|
|
415
|
-
Optional[bool], pydantic.Field(alias="pqStrictOrdering")
|
|
416
|
-
] = True
|
|
417
|
-
r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
|
|
418
|
-
|
|
419
|
-
pq_rate_per_sec: Annotated[
|
|
420
|
-
Optional[float], pydantic.Field(alias="pqRatePerSec")
|
|
421
|
-
] = 0
|
|
422
|
-
r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
|
|
423
|
-
|
|
424
|
-
pq_mode: Annotated[
|
|
425
|
-
Annotated[
|
|
426
|
-
Optional[OutputSplunkHecMode], PlainValidator(validate_open_enum(False))
|
|
427
|
-
],
|
|
428
|
-
pydantic.Field(alias="pqMode"),
|
|
429
|
-
] = OutputSplunkHecMode.ERROR
|
|
430
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
431
|
-
|
|
432
|
-
pq_max_buffer_size: Annotated[
|
|
433
|
-
Optional[float], pydantic.Field(alias="pqMaxBufferSize")
|
|
434
|
-
] = 42
|
|
435
|
-
r"""The maximum number of events to hold in memory before writing the events to disk"""
|
|
436
|
-
|
|
437
|
-
pq_max_backpressure_sec: Annotated[
|
|
438
|
-
Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
|
|
439
|
-
] = 30
|
|
440
|
-
r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
|
|
441
|
-
|
|
442
406
|
pq_max_file_size: Annotated[
|
|
443
407
|
Optional[str], pydantic.Field(alias="pqMaxFileSize")
|
|
444
408
|
] = "1 MB"
|
|
@@ -470,6 +434,14 @@ class OutputSplunkHec(BaseModel):
|
|
|
470
434
|
] = OutputSplunkHecQueueFullBehavior.BLOCK
|
|
471
435
|
r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
|
|
472
436
|
|
|
437
|
+
pq_mode: Annotated[
|
|
438
|
+
Annotated[
|
|
439
|
+
Optional[OutputSplunkHecMode], PlainValidator(validate_open_enum(False))
|
|
440
|
+
],
|
|
441
|
+
pydantic.Field(alias="pqMode"),
|
|
442
|
+
] = OutputSplunkHecMode.ERROR
|
|
443
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
444
|
+
|
|
473
445
|
pq_controls: Annotated[
|
|
474
446
|
Optional[OutputSplunkHecPqControls], pydantic.Field(alias="pqControls")
|
|
475
447
|
] = None
|
|
@@ -277,17 +277,6 @@ class OutputSplunkLbHost(BaseModel):
|
|
|
277
277
|
r"""Assign a weight (>0) to each endpoint to indicate its traffic-handling capability"""
|
|
278
278
|
|
|
279
279
|
|
|
280
|
-
class OutputSplunkLbMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
281
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
282
|
-
|
|
283
|
-
# Error
|
|
284
|
-
ERROR = "error"
|
|
285
|
-
# Backpressure
|
|
286
|
-
ALWAYS = "always"
|
|
287
|
-
# Always On
|
|
288
|
-
BACKPRESSURE = "backpressure"
|
|
289
|
-
|
|
290
|
-
|
|
291
280
|
class OutputSplunkLbPqCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
292
281
|
r"""Codec to use to compress the persisted data"""
|
|
293
282
|
|
|
@@ -306,6 +295,17 @@ class OutputSplunkLbQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
|
306
295
|
DROP = "drop"
|
|
307
296
|
|
|
308
297
|
|
|
298
|
+
class OutputSplunkLbMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
299
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
300
|
+
|
|
301
|
+
# Error
|
|
302
|
+
ERROR = "error"
|
|
303
|
+
# Backpressure
|
|
304
|
+
BACKPRESSURE = "backpressure"
|
|
305
|
+
# Always On
|
|
306
|
+
ALWAYS = "always"
|
|
307
|
+
|
|
308
|
+
|
|
309
309
|
class OutputSplunkLbPqControlsTypedDict(TypedDict):
|
|
310
310
|
pass
|
|
311
311
|
|
|
@@ -368,16 +368,6 @@ class OutputSplunkLbTypedDict(TypedDict):
|
|
|
368
368
|
r"""List of configurations to set up indexer discovery in Splunk Indexer clustering environment."""
|
|
369
369
|
exclude_self: NotRequired[bool]
|
|
370
370
|
r"""Exclude all IPs of the current host from the list of any resolved hostnames"""
|
|
371
|
-
pq_strict_ordering: NotRequired[bool]
|
|
372
|
-
r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
|
|
373
|
-
pq_rate_per_sec: NotRequired[float]
|
|
374
|
-
r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
|
|
375
|
-
pq_mode: NotRequired[OutputSplunkLbMode]
|
|
376
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
377
|
-
pq_max_buffer_size: NotRequired[float]
|
|
378
|
-
r"""The maximum number of events to hold in memory before writing the events to disk"""
|
|
379
|
-
pq_max_backpressure_sec: NotRequired[float]
|
|
380
|
-
r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
|
|
381
371
|
pq_max_file_size: NotRequired[str]
|
|
382
372
|
r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
|
|
383
373
|
pq_max_size: NotRequired[str]
|
|
@@ -388,6 +378,8 @@ class OutputSplunkLbTypedDict(TypedDict):
|
|
|
388
378
|
r"""Codec to use to compress the persisted data"""
|
|
389
379
|
pq_on_backpressure: NotRequired[OutputSplunkLbQueueFullBehavior]
|
|
390
380
|
r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
|
|
381
|
+
pq_mode: NotRequired[OutputSplunkLbMode]
|
|
382
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
391
383
|
pq_controls: NotRequired[OutputSplunkLbPqControlsTypedDict]
|
|
392
384
|
auth_token: NotRequired[str]
|
|
393
385
|
r"""Shared secret token to use when establishing a connection to a Splunk indexer."""
|
|
@@ -531,34 +523,6 @@ class OutputSplunkLb(BaseModel):
|
|
|
531
523
|
exclude_self: Annotated[Optional[bool], pydantic.Field(alias="excludeSelf")] = False
|
|
532
524
|
r"""Exclude all IPs of the current host from the list of any resolved hostnames"""
|
|
533
525
|
|
|
534
|
-
pq_strict_ordering: Annotated[
|
|
535
|
-
Optional[bool], pydantic.Field(alias="pqStrictOrdering")
|
|
536
|
-
] = True
|
|
537
|
-
r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
|
|
538
|
-
|
|
539
|
-
pq_rate_per_sec: Annotated[
|
|
540
|
-
Optional[float], pydantic.Field(alias="pqRatePerSec")
|
|
541
|
-
] = 0
|
|
542
|
-
r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
|
|
543
|
-
|
|
544
|
-
pq_mode: Annotated[
|
|
545
|
-
Annotated[
|
|
546
|
-
Optional[OutputSplunkLbMode], PlainValidator(validate_open_enum(False))
|
|
547
|
-
],
|
|
548
|
-
pydantic.Field(alias="pqMode"),
|
|
549
|
-
] = OutputSplunkLbMode.ERROR
|
|
550
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
551
|
-
|
|
552
|
-
pq_max_buffer_size: Annotated[
|
|
553
|
-
Optional[float], pydantic.Field(alias="pqMaxBufferSize")
|
|
554
|
-
] = 42
|
|
555
|
-
r"""The maximum number of events to hold in memory before writing the events to disk"""
|
|
556
|
-
|
|
557
|
-
pq_max_backpressure_sec: Annotated[
|
|
558
|
-
Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
|
|
559
|
-
] = 30
|
|
560
|
-
r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
|
|
561
|
-
|
|
562
526
|
pq_max_file_size: Annotated[
|
|
563
527
|
Optional[str], pydantic.Field(alias="pqMaxFileSize")
|
|
564
528
|
] = "1 MB"
|
|
@@ -590,6 +554,14 @@ class OutputSplunkLb(BaseModel):
|
|
|
590
554
|
] = OutputSplunkLbQueueFullBehavior.BLOCK
|
|
591
555
|
r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
|
|
592
556
|
|
|
557
|
+
pq_mode: Annotated[
|
|
558
|
+
Annotated[
|
|
559
|
+
Optional[OutputSplunkLbMode], PlainValidator(validate_open_enum(False))
|
|
560
|
+
],
|
|
561
|
+
pydantic.Field(alias="pqMode"),
|
|
562
|
+
] = OutputSplunkLbMode.ERROR
|
|
563
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
564
|
+
|
|
593
565
|
pq_controls: Annotated[
|
|
594
566
|
Optional[OutputSplunkLbPqControls], pydantic.Field(alias="pqControls")
|
|
595
567
|
] = None
|
|
@@ -53,17 +53,6 @@ class OutputSqsBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
|
53
53
|
QUEUE = "queue"
|
|
54
54
|
|
|
55
55
|
|
|
56
|
-
class OutputSqsMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
57
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
58
|
-
|
|
59
|
-
# Error
|
|
60
|
-
ERROR = "error"
|
|
61
|
-
# Backpressure
|
|
62
|
-
ALWAYS = "always"
|
|
63
|
-
# Always On
|
|
64
|
-
BACKPRESSURE = "backpressure"
|
|
65
|
-
|
|
66
|
-
|
|
67
56
|
class OutputSqsCompression(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
68
57
|
r"""Codec to use to compress the persisted data"""
|
|
69
58
|
|
|
@@ -82,6 +71,17 @@ class OutputSqsQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
|
82
71
|
DROP = "drop"
|
|
83
72
|
|
|
84
73
|
|
|
74
|
+
class OutputSqsMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
75
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
76
|
+
|
|
77
|
+
# Error
|
|
78
|
+
ERROR = "error"
|
|
79
|
+
# Backpressure
|
|
80
|
+
BACKPRESSURE = "backpressure"
|
|
81
|
+
# Always On
|
|
82
|
+
ALWAYS = "always"
|
|
83
|
+
|
|
84
|
+
|
|
85
85
|
class OutputSqsPqControlsTypedDict(TypedDict):
|
|
86
86
|
pass
|
|
87
87
|
|
|
@@ -147,16 +147,6 @@ class OutputSqsTypedDict(TypedDict):
|
|
|
147
147
|
aws_api_key: NotRequired[str]
|
|
148
148
|
aws_secret: NotRequired[str]
|
|
149
149
|
r"""Select or create a stored secret that references your access key and secret key"""
|
|
150
|
-
pq_strict_ordering: NotRequired[bool]
|
|
151
|
-
r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
|
|
152
|
-
pq_rate_per_sec: NotRequired[float]
|
|
153
|
-
r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
|
|
154
|
-
pq_mode: NotRequired[OutputSqsMode]
|
|
155
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
156
|
-
pq_max_buffer_size: NotRequired[float]
|
|
157
|
-
r"""The maximum number of events to hold in memory before writing the events to disk"""
|
|
158
|
-
pq_max_backpressure_sec: NotRequired[float]
|
|
159
|
-
r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
|
|
160
150
|
pq_max_file_size: NotRequired[str]
|
|
161
151
|
r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
|
|
162
152
|
pq_max_size: NotRequired[str]
|
|
@@ -167,6 +157,8 @@ class OutputSqsTypedDict(TypedDict):
|
|
|
167
157
|
r"""Codec to use to compress the persisted data"""
|
|
168
158
|
pq_on_backpressure: NotRequired[OutputSqsQueueFullBehavior]
|
|
169
159
|
r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
|
|
160
|
+
pq_mode: NotRequired[OutputSqsMode]
|
|
161
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
170
162
|
pq_controls: NotRequired[OutputSqsPqControlsTypedDict]
|
|
171
163
|
|
|
172
164
|
|
|
@@ -306,32 +298,6 @@ class OutputSqs(BaseModel):
|
|
|
306
298
|
aws_secret: Annotated[Optional[str], pydantic.Field(alias="awsSecret")] = None
|
|
307
299
|
r"""Select or create a stored secret that references your access key and secret key"""
|
|
308
300
|
|
|
309
|
-
pq_strict_ordering: Annotated[
|
|
310
|
-
Optional[bool], pydantic.Field(alias="pqStrictOrdering")
|
|
311
|
-
] = True
|
|
312
|
-
r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
|
|
313
|
-
|
|
314
|
-
pq_rate_per_sec: Annotated[
|
|
315
|
-
Optional[float], pydantic.Field(alias="pqRatePerSec")
|
|
316
|
-
] = 0
|
|
317
|
-
r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
|
|
318
|
-
|
|
319
|
-
pq_mode: Annotated[
|
|
320
|
-
Annotated[Optional[OutputSqsMode], PlainValidator(validate_open_enum(False))],
|
|
321
|
-
pydantic.Field(alias="pqMode"),
|
|
322
|
-
] = OutputSqsMode.ERROR
|
|
323
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
324
|
-
|
|
325
|
-
pq_max_buffer_size: Annotated[
|
|
326
|
-
Optional[float], pydantic.Field(alias="pqMaxBufferSize")
|
|
327
|
-
] = 42
|
|
328
|
-
r"""The maximum number of events to hold in memory before writing the events to disk"""
|
|
329
|
-
|
|
330
|
-
pq_max_backpressure_sec: Annotated[
|
|
331
|
-
Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
|
|
332
|
-
] = 30
|
|
333
|
-
r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
|
|
334
|
-
|
|
335
301
|
pq_max_file_size: Annotated[
|
|
336
302
|
Optional[str], pydantic.Field(alias="pqMaxFileSize")
|
|
337
303
|
] = "1 MB"
|
|
@@ -362,6 +328,12 @@ class OutputSqs(BaseModel):
|
|
|
362
328
|
] = OutputSqsQueueFullBehavior.BLOCK
|
|
363
329
|
r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
|
|
364
330
|
|
|
331
|
+
pq_mode: Annotated[
|
|
332
|
+
Annotated[Optional[OutputSqsMode], PlainValidator(validate_open_enum(False))],
|
|
333
|
+
pydantic.Field(alias="pqMode"),
|
|
334
|
+
] = OutputSqsMode.ERROR
|
|
335
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
336
|
+
|
|
365
337
|
pq_controls: Annotated[
|
|
366
338
|
Optional[OutputSqsPqControls], pydantic.Field(alias="pqControls")
|
|
367
339
|
] = None
|
|
@@ -35,17 +35,6 @@ class OutputStatsdBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
|
35
35
|
QUEUE = "queue"
|
|
36
36
|
|
|
37
37
|
|
|
38
|
-
class OutputStatsdMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
39
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
40
|
-
|
|
41
|
-
# Error
|
|
42
|
-
ERROR = "error"
|
|
43
|
-
# Backpressure
|
|
44
|
-
ALWAYS = "always"
|
|
45
|
-
# Always On
|
|
46
|
-
BACKPRESSURE = "backpressure"
|
|
47
|
-
|
|
48
|
-
|
|
49
38
|
class OutputStatsdCompression(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
50
39
|
r"""Codec to use to compress the persisted data"""
|
|
51
40
|
|
|
@@ -64,6 +53,17 @@ class OutputStatsdQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
|
64
53
|
DROP = "drop"
|
|
65
54
|
|
|
66
55
|
|
|
56
|
+
class OutputStatsdMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
57
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
58
|
+
|
|
59
|
+
# Error
|
|
60
|
+
ERROR = "error"
|
|
61
|
+
# Backpressure
|
|
62
|
+
BACKPRESSURE = "backpressure"
|
|
63
|
+
# Always On
|
|
64
|
+
ALWAYS = "always"
|
|
65
|
+
|
|
66
|
+
|
|
67
67
|
class OutputStatsdPqControlsTypedDict(TypedDict):
|
|
68
68
|
pass
|
|
69
69
|
|
|
@@ -105,16 +105,6 @@ class OutputStatsdTypedDict(TypedDict):
|
|
|
105
105
|
r"""Amount of time (milliseconds) to wait for a write to complete before assuming connection is dead"""
|
|
106
106
|
on_backpressure: NotRequired[OutputStatsdBackpressureBehavior]
|
|
107
107
|
r"""How to handle events when all receivers are exerting backpressure"""
|
|
108
|
-
pq_strict_ordering: NotRequired[bool]
|
|
109
|
-
r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
|
|
110
|
-
pq_rate_per_sec: NotRequired[float]
|
|
111
|
-
r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
|
|
112
|
-
pq_mode: NotRequired[OutputStatsdMode]
|
|
113
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
114
|
-
pq_max_buffer_size: NotRequired[float]
|
|
115
|
-
r"""The maximum number of events to hold in memory before writing the events to disk"""
|
|
116
|
-
pq_max_backpressure_sec: NotRequired[float]
|
|
117
|
-
r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
|
|
118
108
|
pq_max_file_size: NotRequired[str]
|
|
119
109
|
r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
|
|
120
110
|
pq_max_size: NotRequired[str]
|
|
@@ -125,6 +115,8 @@ class OutputStatsdTypedDict(TypedDict):
|
|
|
125
115
|
r"""Codec to use to compress the persisted data"""
|
|
126
116
|
pq_on_backpressure: NotRequired[OutputStatsdQueueFullBehavior]
|
|
127
117
|
r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
|
|
118
|
+
pq_mode: NotRequired[OutputStatsdMode]
|
|
119
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
128
120
|
pq_controls: NotRequired[OutputStatsdPqControlsTypedDict]
|
|
129
121
|
|
|
130
122
|
|
|
@@ -199,34 +191,6 @@ class OutputStatsd(BaseModel):
|
|
|
199
191
|
] = OutputStatsdBackpressureBehavior.BLOCK
|
|
200
192
|
r"""How to handle events when all receivers are exerting backpressure"""
|
|
201
193
|
|
|
202
|
-
pq_strict_ordering: Annotated[
|
|
203
|
-
Optional[bool], pydantic.Field(alias="pqStrictOrdering")
|
|
204
|
-
] = True
|
|
205
|
-
r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
|
|
206
|
-
|
|
207
|
-
pq_rate_per_sec: Annotated[
|
|
208
|
-
Optional[float], pydantic.Field(alias="pqRatePerSec")
|
|
209
|
-
] = 0
|
|
210
|
-
r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
|
|
211
|
-
|
|
212
|
-
pq_mode: Annotated[
|
|
213
|
-
Annotated[
|
|
214
|
-
Optional[OutputStatsdMode], PlainValidator(validate_open_enum(False))
|
|
215
|
-
],
|
|
216
|
-
pydantic.Field(alias="pqMode"),
|
|
217
|
-
] = OutputStatsdMode.ERROR
|
|
218
|
-
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
219
|
-
|
|
220
|
-
pq_max_buffer_size: Annotated[
|
|
221
|
-
Optional[float], pydantic.Field(alias="pqMaxBufferSize")
|
|
222
|
-
] = 42
|
|
223
|
-
r"""The maximum number of events to hold in memory before writing the events to disk"""
|
|
224
|
-
|
|
225
|
-
pq_max_backpressure_sec: Annotated[
|
|
226
|
-
Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
|
|
227
|
-
] = 30
|
|
228
|
-
r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
|
|
229
|
-
|
|
230
194
|
pq_max_file_size: Annotated[
|
|
231
195
|
Optional[str], pydantic.Field(alias="pqMaxFileSize")
|
|
232
196
|
] = "1 MB"
|
|
@@ -257,6 +221,14 @@ class OutputStatsd(BaseModel):
|
|
|
257
221
|
] = OutputStatsdQueueFullBehavior.BLOCK
|
|
258
222
|
r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
|
|
259
223
|
|
|
224
|
+
pq_mode: Annotated[
|
|
225
|
+
Annotated[
|
|
226
|
+
Optional[OutputStatsdMode], PlainValidator(validate_open_enum(False))
|
|
227
|
+
],
|
|
228
|
+
pydantic.Field(alias="pqMode"),
|
|
229
|
+
] = OutputStatsdMode.ERROR
|
|
230
|
+
r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
|
|
231
|
+
|
|
260
232
|
pq_controls: Annotated[
|
|
261
233
|
Optional[OutputStatsdPqControls], pydantic.Field(alias="pqControls")
|
|
262
234
|
] = None
|