cribl-control-plane 0.0.15__py3-none-any.whl → 0.0.17__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/{outputs.py → destinations.py} +69 -71
- cribl_control_plane/errors/healthstatus_error.py +2 -8
- cribl_control_plane/models/__init__.py +5347 -115
- cribl_control_plane/models/createinputop.py +18216 -2
- cribl_control_plane/models/createoutputop.py +18417 -4
- cribl_control_plane/models/createoutputtestbyidop.py +2 -2
- cribl_control_plane/models/deleteoutputbyidop.py +2 -2
- cribl_control_plane/models/deleteoutputpqbyidop.py +2 -2
- cribl_control_plane/models/getoutputbyidop.py +2 -2
- cribl_control_plane/models/getoutputpqbyidop.py +2 -2
- cribl_control_plane/models/getoutputsamplesbyidop.py +2 -2
- cribl_control_plane/models/healthstatus.py +4 -7
- cribl_control_plane/models/inputappscope.py +16 -36
- cribl_control_plane/models/inputazureblob.py +8 -19
- cribl_control_plane/models/inputcollection.py +6 -15
- cribl_control_plane/models/inputconfluentcloud.py +22 -45
- cribl_control_plane/models/inputcribl.py +6 -13
- cribl_control_plane/models/inputcriblhttp.py +12 -27
- cribl_control_plane/models/inputcribllakehttp.py +14 -26
- cribl_control_plane/models/inputcriblmetrics.py +6 -14
- cribl_control_plane/models/inputcribltcp.py +12 -27
- cribl_control_plane/models/inputcrowdstrike.py +12 -28
- cribl_control_plane/models/inputdatadogagent.py +12 -28
- cribl_control_plane/models/inputdatagen.py +6 -13
- cribl_control_plane/models/inputedgeprometheus.py +33 -64
- cribl_control_plane/models/inputelastic.py +18 -44
- cribl_control_plane/models/inputeventhub.py +10 -19
- cribl_control_plane/models/inputexec.py +8 -16
- cribl_control_plane/models/inputfile.py +8 -17
- cribl_control_plane/models/inputfirehose.py +12 -27
- cribl_control_plane/models/inputgooglepubsub.py +10 -23
- cribl_control_plane/models/inputgrafana_union.py +39 -81
- cribl_control_plane/models/inputhttp.py +12 -27
- cribl_control_plane/models/inputhttpraw.py +12 -27
- cribl_control_plane/models/inputjournalfiles.py +8 -16
- cribl_control_plane/models/inputkafka.py +18 -45
- cribl_control_plane/models/inputkinesis.py +18 -42
- cribl_control_plane/models/inputkubeevents.py +6 -13
- cribl_control_plane/models/inputkubelogs.py +10 -18
- cribl_control_plane/models/inputkubemetrics.py +10 -18
- cribl_control_plane/models/inputloki.py +14 -33
- cribl_control_plane/models/inputmetrics.py +10 -25
- cribl_control_plane/models/inputmodeldriventelemetry.py +14 -33
- cribl_control_plane/models/inputmsk.py +20 -52
- cribl_control_plane/models/inputnetflow.py +8 -15
- cribl_control_plane/models/inputoffice365mgmt.py +18 -37
- cribl_control_plane/models/inputoffice365msgtrace.py +20 -41
- cribl_control_plane/models/inputoffice365service.py +20 -41
- cribl_control_plane/models/inputopentelemetry.py +20 -42
- cribl_control_plane/models/inputprometheus.py +22 -54
- cribl_control_plane/models/inputprometheusrw.py +14 -34
- cribl_control_plane/models/inputrawudp.py +8 -15
- cribl_control_plane/models/inputs3.py +10 -23
- cribl_control_plane/models/inputs3inventory.py +12 -28
- cribl_control_plane/models/inputsecuritylake.py +12 -29
- cribl_control_plane/models/inputsnmp.py +10 -20
- cribl_control_plane/models/inputsplunk.py +16 -37
- cribl_control_plane/models/inputsplunkhec.py +14 -33
- cribl_control_plane/models/inputsplunksearch.py +18 -37
- cribl_control_plane/models/inputsqs.py +14 -31
- cribl_control_plane/models/inputsyslog_union.py +29 -53
- cribl_control_plane/models/inputsystemmetrics.py +26 -50
- cribl_control_plane/models/inputsystemstate.py +10 -18
- cribl_control_plane/models/inputtcp.py +14 -33
- cribl_control_plane/models/inputtcpjson.py +14 -33
- cribl_control_plane/models/inputwef.py +22 -45
- cribl_control_plane/models/inputwindowsmetrics.py +26 -46
- cribl_control_plane/models/inputwineventlogs.py +12 -22
- cribl_control_plane/models/inputwiz.py +12 -25
- cribl_control_plane/models/inputzscalerhec.py +14 -33
- cribl_control_plane/models/listoutputop.py +2 -2
- cribl_control_plane/models/output.py +3 -6
- cribl_control_plane/models/outputazureblob.py +20 -52
- cribl_control_plane/models/outputazuredataexplorer.py +30 -77
- cribl_control_plane/models/outputazureeventhub.py +20 -44
- cribl_control_plane/models/outputazurelogs.py +14 -37
- cribl_control_plane/models/outputclickhouse.py +22 -59
- cribl_control_plane/models/outputcloudwatch.py +12 -33
- cribl_control_plane/models/outputconfluentcloud.py +32 -75
- cribl_control_plane/models/outputcriblhttp.py +18 -46
- cribl_control_plane/models/outputcribllake.py +18 -48
- cribl_control_plane/models/outputcribltcp.py +20 -47
- cribl_control_plane/models/outputcrowdstrikenextgensiem.py +16 -54
- cribl_control_plane/models/outputdatadog.py +22 -50
- cribl_control_plane/models/outputdataset.py +20 -48
- cribl_control_plane/models/outputdefault.py +2 -5
- cribl_control_plane/models/outputdevnull.py +2 -5
- cribl_control_plane/models/outputdiskspool.py +4 -9
- cribl_control_plane/models/outputdls3.py +26 -72
- cribl_control_plane/models/outputdynatracehttp.py +22 -57
- cribl_control_plane/models/outputdynatraceotlp.py +24 -59
- cribl_control_plane/models/outputelastic.py +20 -45
- cribl_control_plane/models/outputelasticcloud.py +14 -40
- cribl_control_plane/models/outputexabeam.py +12 -33
- cribl_control_plane/models/outputfilesystem.py +16 -41
- cribl_control_plane/models/outputgooglechronicle.py +18 -54
- cribl_control_plane/models/outputgooglecloudlogging.py +16 -46
- cribl_control_plane/models/outputgooglecloudstorage.py +26 -71
- cribl_control_plane/models/outputgooglepubsub.py +16 -39
- cribl_control_plane/models/{outputgrafanacloud_union.py → outputgrafanacloud.py} +49 -110
- cribl_control_plane/models/outputgraphite.py +16 -35
- cribl_control_plane/models/outputhoneycomb.py +14 -37
- cribl_control_plane/models/outputhumiohec.py +18 -47
- cribl_control_plane/models/outputinfluxdb.py +18 -44
- cribl_control_plane/models/outputkafka.py +28 -73
- cribl_control_plane/models/outputkinesis.py +18 -44
- cribl_control_plane/models/outputloki.py +18 -43
- cribl_control_plane/models/outputminio.py +26 -69
- cribl_control_plane/models/outputmsk.py +30 -81
- cribl_control_plane/models/outputnetflow.py +2 -5
- cribl_control_plane/models/outputnewrelic.py +20 -45
- cribl_control_plane/models/outputnewrelicevents.py +16 -45
- cribl_control_plane/models/outputopentelemetry.py +28 -69
- cribl_control_plane/models/outputprometheus.py +14 -37
- cribl_control_plane/models/outputring.py +10 -21
- cribl_control_plane/models/outputrouter.py +2 -5
- cribl_control_plane/models/outputs3.py +28 -72
- cribl_control_plane/models/outputsecuritylake.py +20 -56
- cribl_control_plane/models/outputsentinel.py +20 -49
- cribl_control_plane/models/outputsentineloneaisiem.py +20 -54
- cribl_control_plane/models/outputservicenow.py +26 -64
- cribl_control_plane/models/outputsignalfx.py +16 -39
- cribl_control_plane/models/outputsnmp.py +2 -5
- cribl_control_plane/models/outputsns.py +16 -40
- cribl_control_plane/models/outputsplunk.py +26 -64
- cribl_control_plane/models/outputsplunkhec.py +14 -37
- cribl_control_plane/models/outputsplunklb.py +36 -83
- cribl_control_plane/models/outputsqs.py +18 -45
- cribl_control_plane/models/outputstatsd.py +16 -34
- cribl_control_plane/models/outputstatsdext.py +14 -33
- cribl_control_plane/models/outputsumologic.py +14 -37
- cribl_control_plane/models/outputsyslog.py +26 -60
- cribl_control_plane/models/outputtcpjson.py +22 -54
- cribl_control_plane/models/outputwavefront.py +14 -37
- cribl_control_plane/models/outputwebhook.py +24 -60
- cribl_control_plane/models/outputxsiam.py +16 -37
- cribl_control_plane/models/updateoutputbyidop.py +4 -4
- cribl_control_plane/sdk.py +3 -5
- cribl_control_plane/sources.py +8 -10
- {cribl_control_plane-0.0.15.dist-info → cribl_control_plane-0.0.17.dist-info}/METADATA +13 -13
- cribl_control_plane-0.0.17.dist-info/RECORD +215 -0
- cribl_control_plane-0.0.15.dist-info/RECORD +0 -215
- {cribl_control_plane-0.0.15.dist-info → cribl_control_plane-0.0.17.dist-info}/WHEEL +0 -0
|
@@ -1,17 +1,14 @@
|
|
|
1
1
|
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
|
|
2
2
|
|
|
3
3
|
from __future__ import annotations
|
|
4
|
-
from cribl_control_plane import utils
|
|
5
4
|
from cribl_control_plane.types import BaseModel
|
|
6
|
-
from cribl_control_plane.utils import validate_open_enum
|
|
7
5
|
from enum import Enum
|
|
8
6
|
import pydantic
|
|
9
|
-
from pydantic.functional_validators import PlainValidator
|
|
10
7
|
from typing import Any, List, Optional
|
|
11
8
|
from typing_extensions import Annotated, NotRequired, TypedDict
|
|
12
9
|
|
|
13
10
|
|
|
14
|
-
class InputWefType(str, Enum
|
|
11
|
+
class InputWefType(str, Enum):
|
|
15
12
|
WEF = "wef"
|
|
16
13
|
|
|
17
14
|
|
|
@@ -26,14 +23,14 @@ class InputWefConnection(BaseModel):
|
|
|
26
23
|
pipeline: Optional[str] = None
|
|
27
24
|
|
|
28
25
|
|
|
29
|
-
class InputWefMode(str, Enum
|
|
26
|
+
class InputWefMode(str, Enum):
|
|
30
27
|
r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
|
|
31
28
|
|
|
32
29
|
SMART = "smart"
|
|
33
30
|
ALWAYS = "always"
|
|
34
31
|
|
|
35
32
|
|
|
36
|
-
class InputWefCompression(str, Enum
|
|
33
|
+
class InputWefCompression(str, Enum):
|
|
37
34
|
r"""Codec to use to compress the persisted data"""
|
|
38
35
|
|
|
39
36
|
NONE = "none"
|
|
@@ -58,9 +55,7 @@ class InputWefPqTypedDict(TypedDict):
|
|
|
58
55
|
|
|
59
56
|
|
|
60
57
|
class InputWefPq(BaseModel):
|
|
61
|
-
mode:
|
|
62
|
-
Optional[InputWefMode], PlainValidator(validate_open_enum(False))
|
|
63
|
-
] = InputWefMode.ALWAYS
|
|
58
|
+
mode: Optional[InputWefMode] = InputWefMode.ALWAYS
|
|
64
59
|
r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
|
|
65
60
|
|
|
66
61
|
max_buffer_size: Annotated[
|
|
@@ -84,27 +79,25 @@ class InputWefPq(BaseModel):
|
|
|
84
79
|
path: Optional[str] = "$CRIBL_HOME/state/queues"
|
|
85
80
|
r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
|
|
86
81
|
|
|
87
|
-
compress:
|
|
88
|
-
Optional[InputWefCompression], PlainValidator(validate_open_enum(False))
|
|
89
|
-
] = InputWefCompression.NONE
|
|
82
|
+
compress: Optional[InputWefCompression] = InputWefCompression.NONE
|
|
90
83
|
r"""Codec to use to compress the persisted data"""
|
|
91
84
|
|
|
92
85
|
|
|
93
|
-
class InputWefAuthenticationMethod(str, Enum
|
|
86
|
+
class InputWefAuthenticationMethod(str, Enum):
|
|
94
87
|
r"""How to authenticate incoming client connections"""
|
|
95
88
|
|
|
96
89
|
CLIENT_CERT = "clientCert"
|
|
97
90
|
KERBEROS = "kerberos"
|
|
98
91
|
|
|
99
92
|
|
|
100
|
-
class InputWefMinimumTLSVersion(str, Enum
|
|
93
|
+
class InputWefMinimumTLSVersion(str, Enum):
|
|
101
94
|
TL_SV1 = "TLSv1"
|
|
102
95
|
TL_SV1_1 = "TLSv1.1"
|
|
103
96
|
TL_SV1_2 = "TLSv1.2"
|
|
104
97
|
TL_SV1_3 = "TLSv1.3"
|
|
105
98
|
|
|
106
99
|
|
|
107
|
-
class InputWefMaximumTLSVersion(str, Enum
|
|
100
|
+
class InputWefMaximumTLSVersion(str, Enum):
|
|
108
101
|
TL_SV1 = "TLSv1"
|
|
109
102
|
TL_SV1_1 = "TLSv1.1"
|
|
110
103
|
TL_SV1_2 = "TLSv1.2"
|
|
@@ -175,19 +168,11 @@ class MTLSSettings(BaseModel):
|
|
|
175
168
|
r"""Regex matching allowable common names in peer certificates' subject attribute"""
|
|
176
169
|
|
|
177
170
|
min_version: Annotated[
|
|
178
|
-
|
|
179
|
-
Optional[InputWefMinimumTLSVersion],
|
|
180
|
-
PlainValidator(validate_open_enum(False)),
|
|
181
|
-
],
|
|
182
|
-
pydantic.Field(alias="minVersion"),
|
|
171
|
+
Optional[InputWefMinimumTLSVersion], pydantic.Field(alias="minVersion")
|
|
183
172
|
] = None
|
|
184
173
|
|
|
185
174
|
max_version: Annotated[
|
|
186
|
-
|
|
187
|
-
Optional[InputWefMaximumTLSVersion],
|
|
188
|
-
PlainValidator(validate_open_enum(False)),
|
|
189
|
-
],
|
|
190
|
-
pydantic.Field(alias="maxVersion"),
|
|
175
|
+
Optional[InputWefMaximumTLSVersion], pydantic.Field(alias="maxVersion")
|
|
191
176
|
] = None
|
|
192
177
|
|
|
193
178
|
ocsp_check: Annotated[Optional[bool], pydantic.Field(alias="ocspCheck")] = False
|
|
@@ -203,25 +188,25 @@ class MTLSSettings(BaseModel):
|
|
|
203
188
|
r"""If enabled, checks will fail on any OCSP error. Otherwise, checks will fail only when a certificate is revoked, ignoring other errors."""
|
|
204
189
|
|
|
205
190
|
|
|
206
|
-
class InputWefFormat(str, Enum
|
|
191
|
+
class InputWefFormat(str, Enum):
|
|
207
192
|
r"""Content format in which the endpoint should deliver events"""
|
|
208
193
|
|
|
209
194
|
RAW = "Raw"
|
|
210
195
|
RENDERED_TEXT = "RenderedText"
|
|
211
196
|
|
|
212
197
|
|
|
213
|
-
class QueryBuilderMode(str, Enum
|
|
198
|
+
class QueryBuilderMode(str, Enum):
|
|
214
199
|
SIMPLE = "simple"
|
|
215
200
|
XML = "xml"
|
|
216
201
|
|
|
217
202
|
|
|
218
|
-
class
|
|
203
|
+
class InputWefSubscriptionMetadatumTypedDict(TypedDict):
|
|
219
204
|
name: str
|
|
220
205
|
value: str
|
|
221
206
|
r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
|
|
222
207
|
|
|
223
208
|
|
|
224
|
-
class
|
|
209
|
+
class InputWefSubscriptionMetadatum(BaseModel):
|
|
225
210
|
name: str
|
|
226
211
|
|
|
227
212
|
value: str
|
|
@@ -249,7 +234,7 @@ class SubscriptionTypedDict(TypedDict):
|
|
|
249
234
|
locale: NotRequired[str]
|
|
250
235
|
r"""The RFC-3066 locale the Windows clients should use when sending events. Defaults to \"en-US\"."""
|
|
251
236
|
query_selector: NotRequired[QueryBuilderMode]
|
|
252
|
-
metadata: NotRequired[List[
|
|
237
|
+
metadata: NotRequired[List[InputWefSubscriptionMetadatumTypedDict]]
|
|
253
238
|
r"""Fields to add to events ingested under this subscription"""
|
|
254
239
|
|
|
255
240
|
|
|
@@ -263,8 +248,7 @@ class Subscription(BaseModel):
|
|
|
263
248
|
r"""Version UUID for this subscription. If any subscription parameters are modified, this value will change."""
|
|
264
249
|
|
|
265
250
|
content_format: Annotated[
|
|
266
|
-
|
|
267
|
-
pydantic.Field(alias="contentFormat"),
|
|
251
|
+
Optional[InputWefFormat], pydantic.Field(alias="contentFormat")
|
|
268
252
|
] = InputWefFormat.RAW
|
|
269
253
|
r"""Content format in which the endpoint should deliver events"""
|
|
270
254
|
|
|
@@ -293,13 +277,10 @@ class Subscription(BaseModel):
|
|
|
293
277
|
r"""The RFC-3066 locale the Windows clients should use when sending events. Defaults to \"en-US\"."""
|
|
294
278
|
|
|
295
279
|
query_selector: Annotated[
|
|
296
|
-
|
|
297
|
-
Optional[QueryBuilderMode], PlainValidator(validate_open_enum(False))
|
|
298
|
-
],
|
|
299
|
-
pydantic.Field(alias="querySelector"),
|
|
280
|
+
Optional[QueryBuilderMode], pydantic.Field(alias="querySelector")
|
|
300
281
|
] = QueryBuilderMode.SIMPLE
|
|
301
282
|
|
|
302
|
-
metadata: Optional[List[
|
|
283
|
+
metadata: Optional[List[InputWefSubscriptionMetadatum]] = None
|
|
303
284
|
r"""Fields to add to events ingested under this subscription"""
|
|
304
285
|
|
|
305
286
|
|
|
@@ -317,11 +298,11 @@ class InputWefMetadatum(BaseModel):
|
|
|
317
298
|
|
|
318
299
|
|
|
319
300
|
class InputWefTypedDict(TypedDict):
|
|
320
|
-
type: InputWefType
|
|
321
301
|
subscriptions: List[SubscriptionTypedDict]
|
|
322
302
|
r"""Subscriptions to events on forwarding endpoints"""
|
|
323
303
|
id: NotRequired[str]
|
|
324
304
|
r"""Unique ID for this input"""
|
|
305
|
+
type: NotRequired[InputWefType]
|
|
325
306
|
disabled: NotRequired[bool]
|
|
326
307
|
pipeline: NotRequired[str]
|
|
327
308
|
r"""Pipeline to process data from this Source before sending it through the Routes"""
|
|
@@ -377,14 +358,14 @@ class InputWefTypedDict(TypedDict):
|
|
|
377
358
|
|
|
378
359
|
|
|
379
360
|
class InputWef(BaseModel):
|
|
380
|
-
type: Annotated[InputWefType, PlainValidator(validate_open_enum(False))]
|
|
381
|
-
|
|
382
361
|
subscriptions: List[Subscription]
|
|
383
362
|
r"""Subscriptions to events on forwarding endpoints"""
|
|
384
363
|
|
|
385
364
|
id: Optional[str] = None
|
|
386
365
|
r"""Unique ID for this input"""
|
|
387
366
|
|
|
367
|
+
type: Optional[InputWefType] = None
|
|
368
|
+
|
|
388
369
|
disabled: Optional[bool] = False
|
|
389
370
|
|
|
390
371
|
pipeline: Optional[str] = None
|
|
@@ -416,11 +397,7 @@ class InputWef(BaseModel):
|
|
|
416
397
|
r"""Port to listen on"""
|
|
417
398
|
|
|
418
399
|
auth_method: Annotated[
|
|
419
|
-
|
|
420
|
-
Optional[InputWefAuthenticationMethod],
|
|
421
|
-
PlainValidator(validate_open_enum(False)),
|
|
422
|
-
],
|
|
423
|
-
pydantic.Field(alias="authMethod"),
|
|
400
|
+
Optional[InputWefAuthenticationMethod], pydantic.Field(alias="authMethod")
|
|
424
401
|
] = InputWefAuthenticationMethod.CLIENT_CERT
|
|
425
402
|
r"""How to authenticate incoming client connections"""
|
|
426
403
|
|
|
@@ -1,17 +1,14 @@
|
|
|
1
1
|
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
|
|
2
2
|
|
|
3
3
|
from __future__ import annotations
|
|
4
|
-
from cribl_control_plane import utils
|
|
5
4
|
from cribl_control_plane.types import BaseModel
|
|
6
|
-
from cribl_control_plane.utils import validate_open_enum
|
|
7
5
|
from enum import Enum
|
|
8
6
|
import pydantic
|
|
9
|
-
from pydantic.functional_validators import PlainValidator
|
|
10
7
|
from typing import List, Optional
|
|
11
8
|
from typing_extensions import Annotated, NotRequired, TypedDict
|
|
12
9
|
|
|
13
10
|
|
|
14
|
-
class InputWindowsMetricsType(str, Enum
|
|
11
|
+
class InputWindowsMetricsType(str, Enum):
|
|
15
12
|
WINDOWS_METRICS = "windows_metrics"
|
|
16
13
|
|
|
17
14
|
|
|
@@ -26,14 +23,14 @@ class InputWindowsMetricsConnection(BaseModel):
|
|
|
26
23
|
pipeline: Optional[str] = None
|
|
27
24
|
|
|
28
25
|
|
|
29
|
-
class InputWindowsMetricsPqMode(str, Enum
|
|
26
|
+
class InputWindowsMetricsPqMode(str, Enum):
|
|
30
27
|
r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
|
|
31
28
|
|
|
32
29
|
SMART = "smart"
|
|
33
30
|
ALWAYS = "always"
|
|
34
31
|
|
|
35
32
|
|
|
36
|
-
class InputWindowsMetricsCompression(str, Enum
|
|
33
|
+
class InputWindowsMetricsCompression(str, Enum):
|
|
37
34
|
r"""Codec to use to compress the persisted data"""
|
|
38
35
|
|
|
39
36
|
NONE = "none"
|
|
@@ -58,9 +55,7 @@ class InputWindowsMetricsPqTypedDict(TypedDict):
|
|
|
58
55
|
|
|
59
56
|
|
|
60
57
|
class InputWindowsMetricsPq(BaseModel):
|
|
61
|
-
mode:
|
|
62
|
-
Optional[InputWindowsMetricsPqMode], PlainValidator(validate_open_enum(False))
|
|
63
|
-
] = InputWindowsMetricsPqMode.ALWAYS
|
|
58
|
+
mode: Optional[InputWindowsMetricsPqMode] = InputWindowsMetricsPqMode.ALWAYS
|
|
64
59
|
r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
|
|
65
60
|
|
|
66
61
|
max_buffer_size: Annotated[
|
|
@@ -84,14 +79,13 @@ class InputWindowsMetricsPq(BaseModel):
|
|
|
84
79
|
path: Optional[str] = "$CRIBL_HOME/state/queues"
|
|
85
80
|
r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
|
|
86
81
|
|
|
87
|
-
compress:
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
] = InputWindowsMetricsCompression.NONE
|
|
82
|
+
compress: Optional[InputWindowsMetricsCompression] = (
|
|
83
|
+
InputWindowsMetricsCompression.NONE
|
|
84
|
+
)
|
|
91
85
|
r"""Codec to use to compress the persisted data"""
|
|
92
86
|
|
|
93
87
|
|
|
94
|
-
class InputWindowsMetricsHostMode(str, Enum
|
|
88
|
+
class InputWindowsMetricsHostMode(str, Enum):
|
|
95
89
|
r"""Select level of detail for host metrics"""
|
|
96
90
|
|
|
97
91
|
BASIC = "basic"
|
|
@@ -100,7 +94,7 @@ class InputWindowsMetricsHostMode(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
|
100
94
|
DISABLED = "disabled"
|
|
101
95
|
|
|
102
96
|
|
|
103
|
-
class InputWindowsMetricsSystemMode(str, Enum
|
|
97
|
+
class InputWindowsMetricsSystemMode(str, Enum):
|
|
104
98
|
r"""Select the level of details for system metrics"""
|
|
105
99
|
|
|
106
100
|
BASIC = "basic"
|
|
@@ -117,17 +111,14 @@ class InputWindowsMetricsSystemTypedDict(TypedDict):
|
|
|
117
111
|
|
|
118
112
|
|
|
119
113
|
class InputWindowsMetricsSystem(BaseModel):
|
|
120
|
-
mode:
|
|
121
|
-
Optional[InputWindowsMetricsSystemMode],
|
|
122
|
-
PlainValidator(validate_open_enum(False)),
|
|
123
|
-
] = InputWindowsMetricsSystemMode.BASIC
|
|
114
|
+
mode: Optional[InputWindowsMetricsSystemMode] = InputWindowsMetricsSystemMode.BASIC
|
|
124
115
|
r"""Select the level of details for system metrics"""
|
|
125
116
|
|
|
126
117
|
detail: Optional[bool] = False
|
|
127
118
|
r"""Generate metrics for all system information"""
|
|
128
119
|
|
|
129
120
|
|
|
130
|
-
class InputWindowsMetricsCPUMode(str, Enum
|
|
121
|
+
class InputWindowsMetricsCPUMode(str, Enum):
|
|
131
122
|
r"""Select the level of details for CPU metrics"""
|
|
132
123
|
|
|
133
124
|
BASIC = "basic"
|
|
@@ -148,9 +139,7 @@ class InputWindowsMetricsCPUTypedDict(TypedDict):
|
|
|
148
139
|
|
|
149
140
|
|
|
150
141
|
class InputWindowsMetricsCPU(BaseModel):
|
|
151
|
-
mode:
|
|
152
|
-
Optional[InputWindowsMetricsCPUMode], PlainValidator(validate_open_enum(False))
|
|
153
|
-
] = InputWindowsMetricsCPUMode.BASIC
|
|
142
|
+
mode: Optional[InputWindowsMetricsCPUMode] = InputWindowsMetricsCPUMode.BASIC
|
|
154
143
|
r"""Select the level of details for CPU metrics"""
|
|
155
144
|
|
|
156
145
|
per_cpu: Annotated[Optional[bool], pydantic.Field(alias="perCpu")] = False
|
|
@@ -163,7 +152,7 @@ class InputWindowsMetricsCPU(BaseModel):
|
|
|
163
152
|
r"""Generate raw, monotonic CPU time counters"""
|
|
164
153
|
|
|
165
154
|
|
|
166
|
-
class InputWindowsMetricsMemoryMode(str, Enum
|
|
155
|
+
class InputWindowsMetricsMemoryMode(str, Enum):
|
|
167
156
|
r"""Select the level of details for memory metrics"""
|
|
168
157
|
|
|
169
158
|
BASIC = "basic"
|
|
@@ -180,17 +169,14 @@ class InputWindowsMetricsMemoryTypedDict(TypedDict):
|
|
|
180
169
|
|
|
181
170
|
|
|
182
171
|
class InputWindowsMetricsMemory(BaseModel):
|
|
183
|
-
mode:
|
|
184
|
-
Optional[InputWindowsMetricsMemoryMode],
|
|
185
|
-
PlainValidator(validate_open_enum(False)),
|
|
186
|
-
] = InputWindowsMetricsMemoryMode.BASIC
|
|
172
|
+
mode: Optional[InputWindowsMetricsMemoryMode] = InputWindowsMetricsMemoryMode.BASIC
|
|
187
173
|
r"""Select the level of details for memory metrics"""
|
|
188
174
|
|
|
189
175
|
detail: Optional[bool] = False
|
|
190
176
|
r"""Generate metrics for all memory states"""
|
|
191
177
|
|
|
192
178
|
|
|
193
|
-
class InputWindowsMetricsNetworkMode(str, Enum
|
|
179
|
+
class InputWindowsMetricsNetworkMode(str, Enum):
|
|
194
180
|
r"""Select the level of details for network metrics"""
|
|
195
181
|
|
|
196
182
|
BASIC = "basic"
|
|
@@ -211,10 +197,9 @@ class InputWindowsMetricsNetworkTypedDict(TypedDict):
|
|
|
211
197
|
|
|
212
198
|
|
|
213
199
|
class InputWindowsMetricsNetwork(BaseModel):
|
|
214
|
-
mode:
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
] = InputWindowsMetricsNetworkMode.BASIC
|
|
200
|
+
mode: Optional[InputWindowsMetricsNetworkMode] = (
|
|
201
|
+
InputWindowsMetricsNetworkMode.BASIC
|
|
202
|
+
)
|
|
218
203
|
r"""Select the level of details for network metrics"""
|
|
219
204
|
|
|
220
205
|
devices: Optional[List[str]] = None
|
|
@@ -229,7 +214,7 @@ class InputWindowsMetricsNetwork(BaseModel):
|
|
|
229
214
|
r"""Generate full network metrics"""
|
|
230
215
|
|
|
231
216
|
|
|
232
|
-
class InputWindowsMetricsDiskMode(str, Enum
|
|
217
|
+
class InputWindowsMetricsDiskMode(str, Enum):
|
|
233
218
|
r"""Select the level of details for disk metrics"""
|
|
234
219
|
|
|
235
220
|
BASIC = "basic"
|
|
@@ -248,9 +233,7 @@ class InputWindowsMetricsDiskTypedDict(TypedDict):
|
|
|
248
233
|
|
|
249
234
|
|
|
250
235
|
class InputWindowsMetricsDisk(BaseModel):
|
|
251
|
-
mode:
|
|
252
|
-
Optional[InputWindowsMetricsDiskMode], PlainValidator(validate_open_enum(False))
|
|
253
|
-
] = InputWindowsMetricsDiskMode.BASIC
|
|
236
|
+
mode: Optional[InputWindowsMetricsDiskMode] = InputWindowsMetricsDiskMode.BASIC
|
|
254
237
|
r"""Select the level of details for disk metrics"""
|
|
255
238
|
|
|
256
239
|
volumes: Optional[List[str]] = None
|
|
@@ -287,9 +270,7 @@ class InputWindowsMetricsHostTypedDict(TypedDict):
|
|
|
287
270
|
|
|
288
271
|
|
|
289
272
|
class InputWindowsMetricsHost(BaseModel):
|
|
290
|
-
mode:
|
|
291
|
-
Optional[InputWindowsMetricsHostMode], PlainValidator(validate_open_enum(False))
|
|
292
|
-
] = InputWindowsMetricsHostMode.BASIC
|
|
273
|
+
mode: Optional[InputWindowsMetricsHostMode] = InputWindowsMetricsHostMode.BASIC
|
|
293
274
|
r"""Select level of detail for host metrics"""
|
|
294
275
|
|
|
295
276
|
custom: Optional[InputWindowsMetricsCustom] = None
|
|
@@ -334,7 +315,7 @@ class InputWindowsMetricsMetadatum(BaseModel):
|
|
|
334
315
|
r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
|
|
335
316
|
|
|
336
317
|
|
|
337
|
-
class InputWindowsMetricsDataCompressionFormat(str, Enum
|
|
318
|
+
class InputWindowsMetricsDataCompressionFormat(str, Enum):
|
|
338
319
|
NONE = "none"
|
|
339
320
|
GZIP = "gzip"
|
|
340
321
|
|
|
@@ -366,10 +347,9 @@ class InputWindowsMetricsPersistence(BaseModel):
|
|
|
366
347
|
max_data_time: Annotated[Optional[str], pydantic.Field(alias="maxDataTime")] = "24h"
|
|
367
348
|
r"""Maximum amount of time to retain data (examples: 2h, 4d). When limit is reached, older data will be deleted."""
|
|
368
349
|
|
|
369
|
-
compress:
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
] = InputWindowsMetricsDataCompressionFormat.GZIP
|
|
350
|
+
compress: Optional[InputWindowsMetricsDataCompressionFormat] = (
|
|
351
|
+
InputWindowsMetricsDataCompressionFormat.GZIP
|
|
352
|
+
)
|
|
373
353
|
|
|
374
354
|
dest_path: Annotated[Optional[str], pydantic.Field(alias="destPath")] = (
|
|
375
355
|
"$CRIBL_HOME/state/windows_metrics"
|
|
@@ -411,7 +391,7 @@ class InputWindowsMetrics(BaseModel):
|
|
|
411
391
|
id: str
|
|
412
392
|
r"""Unique ID for this input"""
|
|
413
393
|
|
|
414
|
-
type:
|
|
394
|
+
type: InputWindowsMetricsType
|
|
415
395
|
|
|
416
396
|
disabled: Optional[bool] = False
|
|
417
397
|
|
|
@@ -1,17 +1,14 @@
|
|
|
1
1
|
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
|
|
2
2
|
|
|
3
3
|
from __future__ import annotations
|
|
4
|
-
from cribl_control_plane import utils
|
|
5
4
|
from cribl_control_plane.types import BaseModel
|
|
6
|
-
from cribl_control_plane.utils import validate_open_enum
|
|
7
5
|
from enum import Enum
|
|
8
6
|
import pydantic
|
|
9
|
-
from pydantic.functional_validators import PlainValidator
|
|
10
7
|
from typing import List, Optional
|
|
11
8
|
from typing_extensions import Annotated, NotRequired, TypedDict
|
|
12
9
|
|
|
13
10
|
|
|
14
|
-
class InputWinEventLogsType(str, Enum
|
|
11
|
+
class InputWinEventLogsType(str, Enum):
|
|
15
12
|
WIN_EVENT_LOGS = "win_event_logs"
|
|
16
13
|
|
|
17
14
|
|
|
@@ -26,14 +23,14 @@ class InputWinEventLogsConnection(BaseModel):
|
|
|
26
23
|
pipeline: Optional[str] = None
|
|
27
24
|
|
|
28
25
|
|
|
29
|
-
class InputWinEventLogsMode(str, Enum
|
|
26
|
+
class InputWinEventLogsMode(str, Enum):
|
|
30
27
|
r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
|
|
31
28
|
|
|
32
29
|
SMART = "smart"
|
|
33
30
|
ALWAYS = "always"
|
|
34
31
|
|
|
35
32
|
|
|
36
|
-
class InputWinEventLogsCompression(str, Enum
|
|
33
|
+
class InputWinEventLogsCompression(str, Enum):
|
|
37
34
|
r"""Codec to use to compress the persisted data"""
|
|
38
35
|
|
|
39
36
|
NONE = "none"
|
|
@@ -58,9 +55,7 @@ class InputWinEventLogsPqTypedDict(TypedDict):
|
|
|
58
55
|
|
|
59
56
|
|
|
60
57
|
class InputWinEventLogsPq(BaseModel):
|
|
61
|
-
mode:
|
|
62
|
-
Optional[InputWinEventLogsMode], PlainValidator(validate_open_enum(False))
|
|
63
|
-
] = InputWinEventLogsMode.ALWAYS
|
|
58
|
+
mode: Optional[InputWinEventLogsMode] = InputWinEventLogsMode.ALWAYS
|
|
64
59
|
r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
|
|
65
60
|
|
|
66
61
|
max_buffer_size: Annotated[
|
|
@@ -84,21 +79,18 @@ class InputWinEventLogsPq(BaseModel):
|
|
|
84
79
|
path: Optional[str] = "$CRIBL_HOME/state/queues"
|
|
85
80
|
r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
|
|
86
81
|
|
|
87
|
-
compress:
|
|
88
|
-
Optional[InputWinEventLogsCompression],
|
|
89
|
-
PlainValidator(validate_open_enum(False)),
|
|
90
|
-
] = InputWinEventLogsCompression.NONE
|
|
82
|
+
compress: Optional[InputWinEventLogsCompression] = InputWinEventLogsCompression.NONE
|
|
91
83
|
r"""Codec to use to compress the persisted data"""
|
|
92
84
|
|
|
93
85
|
|
|
94
|
-
class ReadMode(str, Enum
|
|
86
|
+
class ReadMode(str, Enum):
|
|
95
87
|
r"""Read all stored and future event logs, or only future events"""
|
|
96
88
|
|
|
97
89
|
OLDEST = "oldest"
|
|
98
90
|
NEWEST = "newest"
|
|
99
91
|
|
|
100
92
|
|
|
101
|
-
class EventFormat(str, Enum
|
|
93
|
+
class EventFormat(str, Enum):
|
|
102
94
|
r"""Format of individual events"""
|
|
103
95
|
|
|
104
96
|
JSON = "json"
|
|
@@ -156,7 +148,7 @@ class InputWinEventLogsTypedDict(TypedDict):
|
|
|
156
148
|
|
|
157
149
|
|
|
158
150
|
class InputWinEventLogs(BaseModel):
|
|
159
|
-
type:
|
|
151
|
+
type: InputWinEventLogsType
|
|
160
152
|
|
|
161
153
|
log_names: Annotated[List[str], pydantic.Field(alias="logNames")]
|
|
162
154
|
r"""Enter the event logs to collect. Run \"Get-WinEvent -ListLog *\" in PowerShell to see the available logs."""
|
|
@@ -188,15 +180,13 @@ class InputWinEventLogs(BaseModel):
|
|
|
188
180
|
|
|
189
181
|
pq: Optional[InputWinEventLogsPq] = None
|
|
190
182
|
|
|
191
|
-
read_mode: Annotated[
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
] = ReadMode.OLDEST
|
|
183
|
+
read_mode: Annotated[Optional[ReadMode], pydantic.Field(alias="readMode")] = (
|
|
184
|
+
ReadMode.OLDEST
|
|
185
|
+
)
|
|
195
186
|
r"""Read all stored and future event logs, or only future events"""
|
|
196
187
|
|
|
197
188
|
event_format: Annotated[
|
|
198
|
-
|
|
199
|
-
pydantic.Field(alias="eventFormat"),
|
|
189
|
+
Optional[EventFormat], pydantic.Field(alias="eventFormat")
|
|
200
190
|
] = EventFormat.JSON
|
|
201
191
|
r"""Format of individual events"""
|
|
202
192
|
|
|
@@ -1,17 +1,14 @@
|
|
|
1
1
|
"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
|
|
2
2
|
|
|
3
3
|
from __future__ import annotations
|
|
4
|
-
from cribl_control_plane import utils
|
|
5
4
|
from cribl_control_plane.types import BaseModel
|
|
6
|
-
from cribl_control_plane.utils import validate_open_enum
|
|
7
5
|
from enum import Enum
|
|
8
6
|
import pydantic
|
|
9
|
-
from pydantic.functional_validators import PlainValidator
|
|
10
7
|
from typing import List, Optional
|
|
11
8
|
from typing_extensions import Annotated, NotRequired, TypedDict
|
|
12
9
|
|
|
13
10
|
|
|
14
|
-
class InputWizType(str, Enum
|
|
11
|
+
class InputWizType(str, Enum):
|
|
15
12
|
WIZ = "wiz"
|
|
16
13
|
|
|
17
14
|
|
|
@@ -26,14 +23,14 @@ class InputWizConnection(BaseModel):
|
|
|
26
23
|
pipeline: Optional[str] = None
|
|
27
24
|
|
|
28
25
|
|
|
29
|
-
class InputWizMode(str, Enum
|
|
26
|
+
class InputWizMode(str, Enum):
|
|
30
27
|
r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
|
|
31
28
|
|
|
32
29
|
SMART = "smart"
|
|
33
30
|
ALWAYS = "always"
|
|
34
31
|
|
|
35
32
|
|
|
36
|
-
class InputWizCompression(str, Enum
|
|
33
|
+
class InputWizCompression(str, Enum):
|
|
37
34
|
r"""Codec to use to compress the persisted data"""
|
|
38
35
|
|
|
39
36
|
NONE = "none"
|
|
@@ -58,9 +55,7 @@ class InputWizPqTypedDict(TypedDict):
|
|
|
58
55
|
|
|
59
56
|
|
|
60
57
|
class InputWizPq(BaseModel):
|
|
61
|
-
mode:
|
|
62
|
-
Optional[InputWizMode], PlainValidator(validate_open_enum(False))
|
|
63
|
-
] = InputWizMode.ALWAYS
|
|
58
|
+
mode: Optional[InputWizMode] = InputWizMode.ALWAYS
|
|
64
59
|
r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
|
|
65
60
|
|
|
66
61
|
max_buffer_size: Annotated[
|
|
@@ -84,9 +79,7 @@ class InputWizPq(BaseModel):
|
|
|
84
79
|
path: Optional[str] = "$CRIBL_HOME/state/queues"
|
|
85
80
|
r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
|
|
86
81
|
|
|
87
|
-
compress:
|
|
88
|
-
Optional[InputWizCompression], PlainValidator(validate_open_enum(False))
|
|
89
|
-
] = InputWizCompression.NONE
|
|
82
|
+
compress: Optional[InputWizCompression] = InputWizCompression.NONE
|
|
90
83
|
r"""Codec to use to compress the persisted data"""
|
|
91
84
|
|
|
92
85
|
|
|
@@ -121,7 +114,7 @@ class InputWizMetadatum(BaseModel):
|
|
|
121
114
|
r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
|
|
122
115
|
|
|
123
116
|
|
|
124
|
-
class InputWizRetryType(str, Enum
|
|
117
|
+
class InputWizRetryType(str, Enum):
|
|
125
118
|
r"""The algorithm to use when performing HTTP retries"""
|
|
126
119
|
|
|
127
120
|
NONE = "none"
|
|
@@ -149,9 +142,7 @@ class InputWizRetryRulesTypedDict(TypedDict):
|
|
|
149
142
|
|
|
150
143
|
|
|
151
144
|
class InputWizRetryRules(BaseModel):
|
|
152
|
-
type:
|
|
153
|
-
Optional[InputWizRetryType], PlainValidator(validate_open_enum(False))
|
|
154
|
-
] = InputWizRetryType.BACKOFF
|
|
145
|
+
type: Optional[InputWizRetryType] = InputWizRetryType.BACKOFF
|
|
155
146
|
r"""The algorithm to use when performing HTTP retries"""
|
|
156
147
|
|
|
157
148
|
interval: Optional[float] = 1000
|
|
@@ -182,7 +173,7 @@ class InputWizRetryRules(BaseModel):
|
|
|
182
173
|
r"""Retry request when a connection reset (ECONNRESET) error occurs"""
|
|
183
174
|
|
|
184
175
|
|
|
185
|
-
class InputWizAuthenticationMethod(str, Enum
|
|
176
|
+
class InputWizAuthenticationMethod(str, Enum):
|
|
186
177
|
r"""Enter client secret directly, or select a stored secret"""
|
|
187
178
|
|
|
188
179
|
MANUAL = "manual"
|
|
@@ -190,7 +181,6 @@ class InputWizAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
|
|
|
190
181
|
|
|
191
182
|
|
|
192
183
|
class InputWizTypedDict(TypedDict):
|
|
193
|
-
type: InputWizType
|
|
194
184
|
auth_url: str
|
|
195
185
|
r"""The authentication URL to generate an OAuth token"""
|
|
196
186
|
client_id: str
|
|
@@ -198,6 +188,7 @@ class InputWizTypedDict(TypedDict):
|
|
|
198
188
|
content_config: List[InputWizContentConfigTypedDict]
|
|
199
189
|
id: NotRequired[str]
|
|
200
190
|
r"""Unique ID for this input"""
|
|
191
|
+
type: NotRequired[InputWizType]
|
|
201
192
|
disabled: NotRequired[bool]
|
|
202
193
|
pipeline: NotRequired[str]
|
|
203
194
|
r"""Pipeline to process data from this Source before sending it through the Routes"""
|
|
@@ -239,8 +230,6 @@ class InputWizTypedDict(TypedDict):
|
|
|
239
230
|
|
|
240
231
|
|
|
241
232
|
class InputWiz(BaseModel):
|
|
242
|
-
type: Annotated[InputWizType, PlainValidator(validate_open_enum(False))]
|
|
243
|
-
|
|
244
233
|
auth_url: Annotated[str, pydantic.Field(alias="authUrl")]
|
|
245
234
|
r"""The authentication URL to generate an OAuth token"""
|
|
246
235
|
|
|
@@ -254,6 +243,8 @@ class InputWiz(BaseModel):
|
|
|
254
243
|
id: Optional[str] = None
|
|
255
244
|
r"""Unique ID for this input"""
|
|
256
245
|
|
|
246
|
+
type: Optional[InputWizType] = None
|
|
247
|
+
|
|
257
248
|
disabled: Optional[bool] = False
|
|
258
249
|
|
|
259
250
|
pipeline: Optional[str] = None
|
|
@@ -317,11 +308,7 @@ class InputWiz(BaseModel):
|
|
|
317
308
|
] = None
|
|
318
309
|
|
|
319
310
|
auth_type: Annotated[
|
|
320
|
-
|
|
321
|
-
Optional[InputWizAuthenticationMethod],
|
|
322
|
-
PlainValidator(validate_open_enum(False)),
|
|
323
|
-
],
|
|
324
|
-
pydantic.Field(alias="authType"),
|
|
311
|
+
Optional[InputWizAuthenticationMethod], pydantic.Field(alias="authType")
|
|
325
312
|
] = InputWizAuthenticationMethod.MANUAL
|
|
326
313
|
r"""Enter client secret directly, or select a stored secret"""
|
|
327
314
|
|