cribl-control-plane 0.2.1rc3__py3-none-any.whl → 0.2.1rc4__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 +4 -4
- cribl_control_plane/groups_sdk.py +0 -3
- cribl_control_plane/models/__init__.py +105 -28
- cribl_control_plane/models/input.py +14 -14
- cribl_control_plane/models/inputappscope.py +20 -16
- cribl_control_plane/models/inputconfluentcloud.py +110 -0
- cribl_control_plane/models/inputcriblhttp.py +20 -16
- cribl_control_plane/models/inputcribllakehttp.py +20 -16
- cribl_control_plane/models/inputcribltcp.py +20 -16
- cribl_control_plane/models/inputdatadogagent.py +20 -16
- cribl_control_plane/models/inputedgeprometheus.py +44 -36
- cribl_control_plane/models/inputelastic.py +44 -27
- cribl_control_plane/models/inputeventhub.py +118 -0
- cribl_control_plane/models/inputfirehose.py +20 -16
- cribl_control_plane/models/inputgrafana.py +39 -31
- cribl_control_plane/models/inputhttp.py +20 -16
- cribl_control_plane/models/inputhttpraw.py +20 -16
- cribl_control_plane/models/inputkafka.py +108 -0
- cribl_control_plane/models/inputloki.py +20 -16
- cribl_control_plane/models/inputmetrics.py +20 -16
- cribl_control_plane/models/inputmodeldriventelemetry.py +20 -16
- cribl_control_plane/models/inputopentelemetry.py +19 -15
- cribl_control_plane/models/inputprometheus.py +44 -36
- cribl_control_plane/models/inputprometheusrw.py +20 -16
- cribl_control_plane/models/inputsplunk.py +20 -16
- cribl_control_plane/models/inputsplunkhec.py +19 -15
- cribl_control_plane/models/inputsyslog.py +39 -31
- cribl_control_plane/models/inputsystemmetrics.py +20 -10
- cribl_control_plane/models/inputtcp.py +30 -16
- cribl_control_plane/models/inputtcpjson.py +20 -16
- cribl_control_plane/models/inputwindowsmetrics.py +20 -10
- cribl_control_plane/models/inputwineventlogs.py +14 -0
- cribl_control_plane/models/inputwizwebhook.py +20 -16
- cribl_control_plane/models/inputzscalerhec.py +19 -15
- cribl_control_plane/models/output.py +22 -22
- cribl_control_plane/models/outputazureblob.py +7 -0
- cribl_control_plane/models/outputazuredataexplorer.py +283 -93
- cribl_control_plane/models/outputazureeventhub.py +169 -21
- cribl_control_plane/models/outputazurelogs.py +49 -21
- cribl_control_plane/models/outputchronicle.py +49 -21
- cribl_control_plane/models/outputclickhouse.py +49 -21
- cribl_control_plane/models/outputcloudwatch.py +49 -21
- cribl_control_plane/models/outputconfluentcloud.py +167 -22
- cribl_control_plane/models/outputcriblhttp.py +49 -21
- cribl_control_plane/models/outputcribltcp.py +49 -21
- cribl_control_plane/models/outputcrowdstrikenextgensiem.py +50 -22
- cribl_control_plane/models/outputdatabricks.py +7 -0
- cribl_control_plane/models/outputdatadog.py +49 -21
- cribl_control_plane/models/outputdataset.py +49 -21
- cribl_control_plane/models/outputdls3.py +7 -0
- cribl_control_plane/models/outputdynatracehttp.py +49 -21
- cribl_control_plane/models/outputdynatraceotlp.py +49 -21
- cribl_control_plane/models/outputelastic.py +74 -21
- cribl_control_plane/models/outputelasticcloud.py +74 -21
- cribl_control_plane/models/outputfilesystem.py +7 -0
- cribl_control_plane/models/outputgooglechronicle.py +65 -22
- cribl_control_plane/models/outputgooglecloudlogging.py +50 -22
- cribl_control_plane/models/outputgooglecloudstorage.py +7 -0
- cribl_control_plane/models/outputgooglepubsub.py +49 -21
- cribl_control_plane/models/outputgrafanacloud.py +98 -42
- cribl_control_plane/models/outputgraphite.py +49 -21
- cribl_control_plane/models/outputhoneycomb.py +49 -21
- cribl_control_plane/models/outputhumiohec.py +49 -21
- cribl_control_plane/models/outputinfluxdb.py +49 -21
- cribl_control_plane/models/outputkafka.py +162 -19
- cribl_control_plane/models/outputkinesis.py +56 -21
- cribl_control_plane/models/outputloki.py +47 -19
- cribl_control_plane/models/outputminio.py +7 -0
- cribl_control_plane/models/outputmsk.py +54 -19
- cribl_control_plane/models/outputnewrelic.py +49 -21
- cribl_control_plane/models/outputnewrelicevents.py +50 -22
- cribl_control_plane/models/outputopentelemetry.py +49 -21
- cribl_control_plane/models/outputprometheus.py +49 -21
- cribl_control_plane/models/outputs3.py +7 -0
- cribl_control_plane/models/outputsentinel.py +49 -21
- cribl_control_plane/models/outputsentineloneaisiem.py +50 -22
- cribl_control_plane/models/outputservicenow.py +49 -21
- cribl_control_plane/models/outputsignalfx.py +49 -21
- cribl_control_plane/models/outputsns.py +47 -19
- cribl_control_plane/models/outputsplunk.py +49 -21
- cribl_control_plane/models/outputsplunkhec.py +49 -21
- cribl_control_plane/models/outputsplunklb.py +49 -21
- cribl_control_plane/models/outputsqs.py +47 -19
- cribl_control_plane/models/outputstatsd.py +49 -21
- cribl_control_plane/models/outputstatsdext.py +49 -21
- cribl_control_plane/models/outputsumologic.py +49 -21
- cribl_control_plane/models/outputsyslog.py +129 -99
- cribl_control_plane/models/outputtcpjson.py +49 -21
- cribl_control_plane/models/outputwavefront.py +49 -21
- cribl_control_plane/models/outputwebhook.py +49 -21
- cribl_control_plane/models/outputxsiam.py +47 -19
- cribl_control_plane/models/pipeline.py +4 -4
- cribl_control_plane/models/runnablejobcollection.py +12 -8
- cribl_control_plane/models/runnablejobexecutor.py +12 -8
- cribl_control_plane/models/runnablejobscheduledsearch.py +12 -8
- cribl_control_plane/pipelines.py +8 -8
- {cribl_control_plane-0.2.1rc3.dist-info → cribl_control_plane-0.2.1rc4.dist-info}/METADATA +2 -6
- {cribl_control_plane-0.2.1rc3.dist-info → cribl_control_plane-0.2.1rc4.dist-info}/RECORD +99 -102
- cribl_control_plane/mappings.py +0 -205
- cribl_control_plane/models/createadminproductsmappingsactivatebyproductop.py +0 -52
- cribl_control_plane/models/rulesetid.py +0 -13
- {cribl_control_plane-0.2.1rc3.dist-info → cribl_control_plane-0.2.1rc4.dist-info}/WHEEL +0 -0
|
@@ -44,6 +44,17 @@ 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
|
+
|
|
47
58
|
class OutputSnsCompression(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
48
59
|
r"""Codec to use to compress the persisted data"""
|
|
49
60
|
|
|
@@ -62,17 +73,6 @@ class OutputSnsQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
|
62
73
|
DROP = "drop"
|
|
63
74
|
|
|
64
75
|
|
|
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,6 +126,16 @@ 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"""
|
|
129
139
|
pq_max_file_size: NotRequired[str]
|
|
130
140
|
r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
|
|
131
141
|
pq_max_size: NotRequired[str]
|
|
@@ -136,8 +146,6 @@ class OutputSnsTypedDict(TypedDict):
|
|
|
136
146
|
r"""Codec to use to compress the persisted data"""
|
|
137
147
|
pq_on_backpressure: NotRequired[OutputSnsQueueFullBehavior]
|
|
138
148
|
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."""
|
|
141
149
|
pq_controls: NotRequired[OutputSnsPqControlsTypedDict]
|
|
142
150
|
|
|
143
151
|
|
|
@@ -244,6 +252,32 @@ class OutputSns(BaseModel):
|
|
|
244
252
|
aws_secret: Annotated[Optional[str], pydantic.Field(alias="awsSecret")] = None
|
|
245
253
|
r"""Select or create a stored secret that references your access key and secret key"""
|
|
246
254
|
|
|
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
|
+
|
|
247
281
|
pq_max_file_size: Annotated[
|
|
248
282
|
Optional[str], pydantic.Field(alias="pqMaxFileSize")
|
|
249
283
|
] = "1 MB"
|
|
@@ -274,12 +308,6 @@ class OutputSns(BaseModel):
|
|
|
274
308
|
] = OutputSnsQueueFullBehavior.BLOCK
|
|
275
309
|
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."""
|
|
276
310
|
|
|
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
|
-
|
|
283
311
|
pq_controls: Annotated[
|
|
284
312
|
Optional[OutputSnsPqControls], pydantic.Field(alias="pqControls")
|
|
285
313
|
] = None
|
|
@@ -143,6 +143,17 @@ 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
|
+
|
|
146
157
|
class OutputSplunkPqCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
147
158
|
r"""Codec to use to compress the persisted data"""
|
|
148
159
|
|
|
@@ -161,17 +172,6 @@ class OutputSplunkQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
|
161
172
|
DROP = "drop"
|
|
162
173
|
|
|
163
174
|
|
|
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,6 +222,16 @@ 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"""
|
|
225
235
|
pq_max_file_size: NotRequired[str]
|
|
226
236
|
r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
|
|
227
237
|
pq_max_size: NotRequired[str]
|
|
@@ -232,8 +242,6 @@ class OutputSplunkTypedDict(TypedDict):
|
|
|
232
242
|
r"""Codec to use to compress the persisted data"""
|
|
233
243
|
pq_on_backpressure: NotRequired[OutputSplunkQueueFullBehavior]
|
|
234
244
|
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."""
|
|
237
245
|
pq_controls: NotRequired[OutputSplunkPqControlsTypedDict]
|
|
238
246
|
auth_token: NotRequired[str]
|
|
239
247
|
r"""Shared secret token to use when establishing a connection to a Splunk indexer."""
|
|
@@ -346,6 +354,34 @@ class OutputSplunk(BaseModel):
|
|
|
346
354
|
] = OutputSplunkCompressCompression.DISABLED
|
|
347
355
|
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."""
|
|
348
356
|
|
|
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
|
+
|
|
349
385
|
pq_max_file_size: Annotated[
|
|
350
386
|
Optional[str], pydantic.Field(alias="pqMaxFileSize")
|
|
351
387
|
] = "1 MB"
|
|
@@ -377,14 +413,6 @@ class OutputSplunk(BaseModel):
|
|
|
377
413
|
] = OutputSplunkQueueFullBehavior.BLOCK
|
|
378
414
|
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."""
|
|
379
415
|
|
|
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
|
-
|
|
388
416
|
pq_controls: Annotated[
|
|
389
417
|
Optional[OutputSplunkPqControls], pydantic.Field(alias="pqControls")
|
|
390
418
|
] = None
|
|
@@ -124,6 +124,17 @@ 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
|
+
|
|
127
138
|
class OutputSplunkHecCompression(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
128
139
|
r"""Codec to use to compress the persisted data"""
|
|
129
140
|
|
|
@@ -142,17 +153,6 @@ class OutputSplunkHecQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
|
142
153
|
DROP = "drop"
|
|
143
154
|
|
|
144
155
|
|
|
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,6 +231,16 @@ 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"""
|
|
234
244
|
pq_max_file_size: NotRequired[str]
|
|
235
245
|
r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
|
|
236
246
|
pq_max_size: NotRequired[str]
|
|
@@ -241,8 +251,6 @@ class OutputSplunkHecTypedDict(TypedDict):
|
|
|
241
251
|
r"""Codec to use to compress the persisted data"""
|
|
242
252
|
pq_on_backpressure: NotRequired[OutputSplunkHecQueueFullBehavior]
|
|
243
253
|
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."""
|
|
246
254
|
pq_controls: NotRequired[OutputSplunkHecPqControlsTypedDict]
|
|
247
255
|
|
|
248
256
|
|
|
@@ -403,6 +411,34 @@ class OutputSplunkHec(BaseModel):
|
|
|
403
411
|
text_secret: Annotated[Optional[str], pydantic.Field(alias="textSecret")] = None
|
|
404
412
|
r"""Select or create a stored text secret"""
|
|
405
413
|
|
|
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
|
+
|
|
406
442
|
pq_max_file_size: Annotated[
|
|
407
443
|
Optional[str], pydantic.Field(alias="pqMaxFileSize")
|
|
408
444
|
] = "1 MB"
|
|
@@ -434,14 +470,6 @@ class OutputSplunkHec(BaseModel):
|
|
|
434
470
|
] = OutputSplunkHecQueueFullBehavior.BLOCK
|
|
435
471
|
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."""
|
|
436
472
|
|
|
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
|
-
|
|
445
473
|
pq_controls: Annotated[
|
|
446
474
|
Optional[OutputSplunkHecPqControls], pydantic.Field(alias="pqControls")
|
|
447
475
|
] = None
|
|
@@ -277,6 +277,17 @@ 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
|
+
|
|
280
291
|
class OutputSplunkLbPqCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
281
292
|
r"""Codec to use to compress the persisted data"""
|
|
282
293
|
|
|
@@ -295,17 +306,6 @@ class OutputSplunkLbQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
|
295
306
|
DROP = "drop"
|
|
296
307
|
|
|
297
308
|
|
|
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,6 +368,16 @@ 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"""
|
|
371
381
|
pq_max_file_size: NotRequired[str]
|
|
372
382
|
r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
|
|
373
383
|
pq_max_size: NotRequired[str]
|
|
@@ -378,8 +388,6 @@ class OutputSplunkLbTypedDict(TypedDict):
|
|
|
378
388
|
r"""Codec to use to compress the persisted data"""
|
|
379
389
|
pq_on_backpressure: NotRequired[OutputSplunkLbQueueFullBehavior]
|
|
380
390
|
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."""
|
|
383
391
|
pq_controls: NotRequired[OutputSplunkLbPqControlsTypedDict]
|
|
384
392
|
auth_token: NotRequired[str]
|
|
385
393
|
r"""Shared secret token to use when establishing a connection to a Splunk indexer."""
|
|
@@ -523,6 +531,34 @@ class OutputSplunkLb(BaseModel):
|
|
|
523
531
|
exclude_self: Annotated[Optional[bool], pydantic.Field(alias="excludeSelf")] = False
|
|
524
532
|
r"""Exclude all IPs of the current host from the list of any resolved hostnames"""
|
|
525
533
|
|
|
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
|
+
|
|
526
562
|
pq_max_file_size: Annotated[
|
|
527
563
|
Optional[str], pydantic.Field(alias="pqMaxFileSize")
|
|
528
564
|
] = "1 MB"
|
|
@@ -554,14 +590,6 @@ class OutputSplunkLb(BaseModel):
|
|
|
554
590
|
] = OutputSplunkLbQueueFullBehavior.BLOCK
|
|
555
591
|
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."""
|
|
556
592
|
|
|
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
|
-
|
|
565
593
|
pq_controls: Annotated[
|
|
566
594
|
Optional[OutputSplunkLbPqControls], pydantic.Field(alias="pqControls")
|
|
567
595
|
] = None
|
|
@@ -53,6 +53,17 @@ 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
|
+
|
|
56
67
|
class OutputSqsCompression(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
57
68
|
r"""Codec to use to compress the persisted data"""
|
|
58
69
|
|
|
@@ -71,17 +82,6 @@ class OutputSqsQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
|
71
82
|
DROP = "drop"
|
|
72
83
|
|
|
73
84
|
|
|
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,6 +147,16 @@ 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"""
|
|
150
160
|
pq_max_file_size: NotRequired[str]
|
|
151
161
|
r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
|
|
152
162
|
pq_max_size: NotRequired[str]
|
|
@@ -157,8 +167,6 @@ class OutputSqsTypedDict(TypedDict):
|
|
|
157
167
|
r"""Codec to use to compress the persisted data"""
|
|
158
168
|
pq_on_backpressure: NotRequired[OutputSqsQueueFullBehavior]
|
|
159
169
|
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."""
|
|
162
170
|
pq_controls: NotRequired[OutputSqsPqControlsTypedDict]
|
|
163
171
|
|
|
164
172
|
|
|
@@ -298,6 +306,32 @@ class OutputSqs(BaseModel):
|
|
|
298
306
|
aws_secret: Annotated[Optional[str], pydantic.Field(alias="awsSecret")] = None
|
|
299
307
|
r"""Select or create a stored secret that references your access key and secret key"""
|
|
300
308
|
|
|
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
|
+
|
|
301
335
|
pq_max_file_size: Annotated[
|
|
302
336
|
Optional[str], pydantic.Field(alias="pqMaxFileSize")
|
|
303
337
|
] = "1 MB"
|
|
@@ -328,12 +362,6 @@ class OutputSqs(BaseModel):
|
|
|
328
362
|
] = OutputSqsQueueFullBehavior.BLOCK
|
|
329
363
|
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."""
|
|
330
364
|
|
|
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
|
-
|
|
337
365
|
pq_controls: Annotated[
|
|
338
366
|
Optional[OutputSqsPqControls], pydantic.Field(alias="pqControls")
|
|
339
367
|
] = None
|
|
@@ -35,6 +35,17 @@ 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
|
+
|
|
38
49
|
class OutputStatsdCompression(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
39
50
|
r"""Codec to use to compress the persisted data"""
|
|
40
51
|
|
|
@@ -53,17 +64,6 @@ class OutputStatsdQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
|
53
64
|
DROP = "drop"
|
|
54
65
|
|
|
55
66
|
|
|
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,6 +105,16 @@ 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"""
|
|
108
118
|
pq_max_file_size: NotRequired[str]
|
|
109
119
|
r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
|
|
110
120
|
pq_max_size: NotRequired[str]
|
|
@@ -115,8 +125,6 @@ class OutputStatsdTypedDict(TypedDict):
|
|
|
115
125
|
r"""Codec to use to compress the persisted data"""
|
|
116
126
|
pq_on_backpressure: NotRequired[OutputStatsdQueueFullBehavior]
|
|
117
127
|
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."""
|
|
120
128
|
pq_controls: NotRequired[OutputStatsdPqControlsTypedDict]
|
|
121
129
|
|
|
122
130
|
|
|
@@ -191,6 +199,34 @@ class OutputStatsd(BaseModel):
|
|
|
191
199
|
] = OutputStatsdBackpressureBehavior.BLOCK
|
|
192
200
|
r"""How to handle events when all receivers are exerting backpressure"""
|
|
193
201
|
|
|
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
|
+
|
|
194
230
|
pq_max_file_size: Annotated[
|
|
195
231
|
Optional[str], pydantic.Field(alias="pqMaxFileSize")
|
|
196
232
|
] = "1 MB"
|
|
@@ -221,14 +257,6 @@ class OutputStatsd(BaseModel):
|
|
|
221
257
|
] = OutputStatsdQueueFullBehavior.BLOCK
|
|
222
258
|
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."""
|
|
223
259
|
|
|
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
|
-
|
|
232
260
|
pq_controls: Annotated[
|
|
233
261
|
Optional[OutputStatsdPqControls], pydantic.Field(alias="pqControls")
|
|
234
262
|
] = None
|