cribl-control-plane 0.0.16__py3-none-any.whl → 0.0.18__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/errors/healthstatus_error.py +2 -8
- cribl_control_plane/models/__init__.py +4365 -4124
- cribl_control_plane/models/createinputop.py +1734 -2771
- cribl_control_plane/models/createoutputop.py +2153 -4314
- cribl_control_plane/models/createversioncommitop.py +24 -0
- cribl_control_plane/models/createversionpushop.py +23 -0
- cribl_control_plane/models/createversionrevertop.py +47 -0
- cribl_control_plane/models/createversionsyncop.py +23 -0
- cribl_control_plane/models/createversionundoop.py +37 -0
- cribl_control_plane/models/getversionbranchop.py +23 -0
- cribl_control_plane/models/getversioncountop.py +47 -0
- cribl_control_plane/models/getversioncurrentbranchop.py +23 -0
- cribl_control_plane/models/getversiondiffop.py +63 -0
- cribl_control_plane/models/getversionfilesop.py +48 -0
- cribl_control_plane/models/getversioninfoop.py +24 -0
- cribl_control_plane/models/getversionshowop.py +63 -0
- cribl_control_plane/models/getversionstatusop.py +38 -0
- cribl_control_plane/models/gitcommitparams.py +23 -0
- cribl_control_plane/models/gitcommitsummary.py +68 -0
- cribl_control_plane/models/gitfile.py +20 -0
- cribl_control_plane/models/gitfilesresponse.py +22 -0
- cribl_control_plane/models/gitinfo.py +23 -0
- cribl_control_plane/models/gitrevertparams.py +20 -0
- cribl_control_plane/models/gitrevertresult.py +48 -0
- cribl_control_plane/models/gitstatusresult.py +73 -0
- 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 +20 -45
- cribl_control_plane/models/inputcribl.py +6 -13
- cribl_control_plane/models/inputcriblhttp.py +10 -27
- cribl_control_plane/models/inputcribllakehttp.py +12 -26
- cribl_control_plane/models/inputcriblmetrics.py +6 -14
- cribl_control_plane/models/inputcribltcp.py +10 -27
- cribl_control_plane/models/inputcrowdstrike.py +12 -28
- cribl_control_plane/models/inputdatadogagent.py +10 -28
- cribl_control_plane/models/inputdatagen.py +6 -13
- cribl_control_plane/models/inputedgeprometheus.py +31 -64
- cribl_control_plane/models/inputelastic.py +16 -44
- cribl_control_plane/models/inputeventhub.py +8 -19
- cribl_control_plane/models/inputexec.py +8 -16
- cribl_control_plane/models/inputfile.py +8 -17
- cribl_control_plane/models/inputfirehose.py +10 -27
- cribl_control_plane/models/inputgooglepubsub.py +8 -23
- cribl_control_plane/models/inputgrafana_union.py +35 -81
- cribl_control_plane/models/inputhttp.py +10 -27
- cribl_control_plane/models/inputhttpraw.py +10 -27
- cribl_control_plane/models/inputjournalfiles.py +6 -16
- cribl_control_plane/models/inputkafka.py +16 -45
- cribl_control_plane/models/inputkinesis.py +16 -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 +12 -33
- cribl_control_plane/models/inputmetrics.py +10 -25
- cribl_control_plane/models/inputmodeldriventelemetry.py +12 -32
- cribl_control_plane/models/inputmsk.py +18 -52
- cribl_control_plane/models/inputnetflow.py +6 -15
- cribl_control_plane/models/inputoffice365mgmt.py +16 -37
- cribl_control_plane/models/inputoffice365msgtrace.py +18 -39
- cribl_control_plane/models/inputoffice365service.py +18 -39
- cribl_control_plane/models/inputopentelemetry.py +18 -42
- cribl_control_plane/models/inputprometheus.py +20 -54
- cribl_control_plane/models/inputprometheusrw.py +12 -34
- cribl_control_plane/models/inputrawudp.py +6 -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 +8 -20
- cribl_control_plane/models/inputsplunk.py +14 -37
- cribl_control_plane/models/inputsplunkhec.py +12 -33
- cribl_control_plane/models/inputsplunksearch.py +16 -37
- cribl_control_plane/models/inputsqs.py +12 -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 +12 -33
- cribl_control_plane/models/inputtcpjson.py +12 -33
- cribl_control_plane/models/inputwef.py +20 -45
- cribl_control_plane/models/inputwindowsmetrics.py +26 -46
- cribl_control_plane/models/inputwineventlogs.py +12 -22
- cribl_control_plane/models/inputwiz.py +10 -25
- cribl_control_plane/models/inputzscalerhec.py +12 -33
- 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/sdk.py +4 -0
- cribl_control_plane/versioning.py +2309 -0
- {cribl_control_plane-0.0.16.dist-info → cribl_control_plane-0.0.18.dist-info}/METADATA +18 -2
- cribl_control_plane-0.0.18.dist-info/RECORD +237 -0
- cribl_control_plane-0.0.16.dist-info/RECORD +0 -215
- {cribl_control_plane-0.0.16.dist-info → cribl_control_plane-0.0.18.dist-info}/WHEEL +0 -0
|
@@ -1,21 +1,18 @@
|
|
|
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, Union
|
|
11
8
|
from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
|
|
12
9
|
|
|
13
10
|
|
|
14
|
-
class OutputGrafanaCloudType2(str, Enum
|
|
11
|
+
class OutputGrafanaCloudType2(str, Enum):
|
|
15
12
|
GRAFANA_CLOUD = "grafana_cloud"
|
|
16
13
|
|
|
17
14
|
|
|
18
|
-
class OutputGrafanaCloudMessageFormat2(str, Enum
|
|
15
|
+
class OutputGrafanaCloudMessageFormat2(str, Enum):
|
|
19
16
|
r"""Format to use when sending logs to Loki (Protobuf or JSON)"""
|
|
20
17
|
|
|
21
18
|
PROTOBUF = "protobuf"
|
|
@@ -33,9 +30,7 @@ class OutputGrafanaCloudLabel2(BaseModel):
|
|
|
33
30
|
name: Optional[str] = ""
|
|
34
31
|
|
|
35
32
|
|
|
36
|
-
class OutputGrafanaCloudPrometheusAuthAuthenticationType2(
|
|
37
|
-
str, Enum, metaclass=utils.OpenEnumMeta
|
|
38
|
-
):
|
|
33
|
+
class OutputGrafanaCloudPrometheusAuthAuthenticationType2(str, Enum):
|
|
39
34
|
NONE = "none"
|
|
40
35
|
TOKEN = "token"
|
|
41
36
|
TEXT_SECRET = "textSecret"
|
|
@@ -59,10 +54,7 @@ class OutputGrafanaCloudPrometheusAuth2TypedDict(TypedDict):
|
|
|
59
54
|
|
|
60
55
|
class OutputGrafanaCloudPrometheusAuth2(BaseModel):
|
|
61
56
|
auth_type: Annotated[
|
|
62
|
-
|
|
63
|
-
Optional[OutputGrafanaCloudPrometheusAuthAuthenticationType2],
|
|
64
|
-
PlainValidator(validate_open_enum(False)),
|
|
65
|
-
],
|
|
57
|
+
Optional[OutputGrafanaCloudPrometheusAuthAuthenticationType2],
|
|
66
58
|
pydantic.Field(alias="authType"),
|
|
67
59
|
] = OutputGrafanaCloudPrometheusAuthAuthenticationType2.BASIC
|
|
68
60
|
|
|
@@ -84,9 +76,7 @@ class OutputGrafanaCloudPrometheusAuth2(BaseModel):
|
|
|
84
76
|
r"""Select or create a secret that references your credentials"""
|
|
85
77
|
|
|
86
78
|
|
|
87
|
-
class OutputGrafanaCloudLokiAuthAuthenticationType2(
|
|
88
|
-
str, Enum, metaclass=utils.OpenEnumMeta
|
|
89
|
-
):
|
|
79
|
+
class OutputGrafanaCloudLokiAuthAuthenticationType2(str, Enum):
|
|
90
80
|
NONE = "none"
|
|
91
81
|
TOKEN = "token"
|
|
92
82
|
TEXT_SECRET = "textSecret"
|
|
@@ -110,10 +100,7 @@ class OutputGrafanaCloudLokiAuth2TypedDict(TypedDict):
|
|
|
110
100
|
|
|
111
101
|
class OutputGrafanaCloudLokiAuth2(BaseModel):
|
|
112
102
|
auth_type: Annotated[
|
|
113
|
-
|
|
114
|
-
Optional[OutputGrafanaCloudLokiAuthAuthenticationType2],
|
|
115
|
-
PlainValidator(validate_open_enum(False)),
|
|
116
|
-
],
|
|
103
|
+
Optional[OutputGrafanaCloudLokiAuthAuthenticationType2],
|
|
117
104
|
pydantic.Field(alias="authType"),
|
|
118
105
|
] = OutputGrafanaCloudLokiAuthAuthenticationType2.BASIC
|
|
119
106
|
|
|
@@ -146,9 +133,7 @@ class OutputGrafanaCloudExtraHTTPHeader2(BaseModel):
|
|
|
146
133
|
name: Optional[str] = None
|
|
147
134
|
|
|
148
135
|
|
|
149
|
-
class OutputGrafanaCloudFailedRequestLoggingMode2(
|
|
150
|
-
str, Enum, metaclass=utils.OpenEnumMeta
|
|
151
|
-
):
|
|
136
|
+
class OutputGrafanaCloudFailedRequestLoggingMode2(str, Enum):
|
|
152
137
|
r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
|
|
153
138
|
|
|
154
139
|
PAYLOAD = "payload"
|
|
@@ -210,7 +195,7 @@ class OutputGrafanaCloudTimeoutRetrySettings2(BaseModel):
|
|
|
210
195
|
r"""The maximum backoff interval, in milliseconds, Cribl Stream should apply. Default (and minimum) is 10,000 ms (10 seconds); maximum is 180,000 ms (180 seconds)."""
|
|
211
196
|
|
|
212
197
|
|
|
213
|
-
class OutputGrafanaCloudBackpressureBehavior2(str, Enum
|
|
198
|
+
class OutputGrafanaCloudBackpressureBehavior2(str, Enum):
|
|
214
199
|
r"""How to handle events when all receivers are exerting backpressure"""
|
|
215
200
|
|
|
216
201
|
BLOCK = "block"
|
|
@@ -218,21 +203,21 @@ class OutputGrafanaCloudBackpressureBehavior2(str, Enum, metaclass=utils.OpenEnu
|
|
|
218
203
|
QUEUE = "queue"
|
|
219
204
|
|
|
220
205
|
|
|
221
|
-
class OutputGrafanaCloudCompression2(str, Enum
|
|
206
|
+
class OutputGrafanaCloudCompression2(str, Enum):
|
|
222
207
|
r"""Codec to use to compress the persisted data"""
|
|
223
208
|
|
|
224
209
|
NONE = "none"
|
|
225
210
|
GZIP = "gzip"
|
|
226
211
|
|
|
227
212
|
|
|
228
|
-
class OutputGrafanaCloudQueueFullBehavior2(str, Enum
|
|
213
|
+
class OutputGrafanaCloudQueueFullBehavior2(str, Enum):
|
|
229
214
|
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."""
|
|
230
215
|
|
|
231
216
|
BLOCK = "block"
|
|
232
217
|
DROP = "drop"
|
|
233
218
|
|
|
234
219
|
|
|
235
|
-
class OutputGrafanaCloudMode2(str, Enum
|
|
220
|
+
class OutputGrafanaCloudMode2(str, Enum):
|
|
236
221
|
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
222
|
|
|
238
223
|
ERROR = "error"
|
|
@@ -248,7 +233,7 @@ class OutputGrafanaCloudPqControls2(BaseModel):
|
|
|
248
233
|
pass
|
|
249
234
|
|
|
250
235
|
|
|
251
|
-
class
|
|
236
|
+
class OutputGrafanaCloudGrafanaCloud2TypedDict(TypedDict):
|
|
252
237
|
id: str
|
|
253
238
|
r"""Unique ID for this output"""
|
|
254
239
|
type: OutputGrafanaCloudType2
|
|
@@ -328,11 +313,11 @@ class OutputGrafanaCloud2TypedDict(TypedDict):
|
|
|
328
313
|
pq_controls: NotRequired[OutputGrafanaCloudPqControls2TypedDict]
|
|
329
314
|
|
|
330
315
|
|
|
331
|
-
class
|
|
316
|
+
class OutputGrafanaCloudGrafanaCloud2(BaseModel):
|
|
332
317
|
id: str
|
|
333
318
|
r"""Unique ID for this output"""
|
|
334
319
|
|
|
335
|
-
type:
|
|
320
|
+
type: OutputGrafanaCloudType2
|
|
336
321
|
|
|
337
322
|
prometheus_url: Annotated[str, pydantic.Field(alias="prometheusUrl")]
|
|
338
323
|
r"""The remote_write endpoint to send Prometheus metrics to, such as https://prometheus-blocks-prod-us-central1.grafana.net/api/prom/push"""
|
|
@@ -358,10 +343,7 @@ class OutputGrafanaCloud2(BaseModel):
|
|
|
358
343
|
r"""Name of the event field that contains the message to send. If not specified, Stream sends a JSON representation of the whole event."""
|
|
359
344
|
|
|
360
345
|
message_format: Annotated[
|
|
361
|
-
|
|
362
|
-
Optional[OutputGrafanaCloudMessageFormat2],
|
|
363
|
-
PlainValidator(validate_open_enum(False)),
|
|
364
|
-
],
|
|
346
|
+
Optional[OutputGrafanaCloudMessageFormat2],
|
|
365
347
|
pydantic.Field(alias="messageFormat"),
|
|
366
348
|
] = OutputGrafanaCloudMessageFormat2.PROTOBUF
|
|
367
349
|
r"""Format to use when sending logs to Loki (Protobuf or JSON)"""
|
|
@@ -424,10 +406,7 @@ class OutputGrafanaCloud2(BaseModel):
|
|
|
424
406
|
r"""Enable round-robin DNS lookup. When a DNS server returns multiple addresses, @{product} will cycle through them in the order returned. For optimal performance, consider enabling this setting for non-load balanced destinations."""
|
|
425
407
|
|
|
426
408
|
failed_request_logging_mode: Annotated[
|
|
427
|
-
|
|
428
|
-
Optional[OutputGrafanaCloudFailedRequestLoggingMode2],
|
|
429
|
-
PlainValidator(validate_open_enum(False)),
|
|
430
|
-
],
|
|
409
|
+
Optional[OutputGrafanaCloudFailedRequestLoggingMode2],
|
|
431
410
|
pydantic.Field(alias="failedRequestLoggingMode"),
|
|
432
411
|
] = OutputGrafanaCloudFailedRequestLoggingMode2.NONE
|
|
433
412
|
r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
|
|
@@ -454,10 +433,7 @@ class OutputGrafanaCloud2(BaseModel):
|
|
|
454
433
|
r"""Honor any Retry-After header that specifies a delay (in seconds) no longer than 180 seconds after the retry request. @{product} limits the delay to 180 seconds, even if the Retry-After header specifies a longer delay. When enabled, takes precedence over user-configured retry options. When disabled, all Retry-After headers are ignored."""
|
|
455
434
|
|
|
456
435
|
on_backpressure: Annotated[
|
|
457
|
-
|
|
458
|
-
Optional[OutputGrafanaCloudBackpressureBehavior2],
|
|
459
|
-
PlainValidator(validate_open_enum(False)),
|
|
460
|
-
],
|
|
436
|
+
Optional[OutputGrafanaCloudBackpressureBehavior2],
|
|
461
437
|
pydantic.Field(alias="onBackpressure"),
|
|
462
438
|
] = OutputGrafanaCloudBackpressureBehavior2.BLOCK
|
|
463
439
|
r"""How to handle events when all receivers are exerting backpressure"""
|
|
@@ -481,28 +457,18 @@ class OutputGrafanaCloud2(BaseModel):
|
|
|
481
457
|
r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/<output-id>."""
|
|
482
458
|
|
|
483
459
|
pq_compress: Annotated[
|
|
484
|
-
|
|
485
|
-
Optional[OutputGrafanaCloudCompression2],
|
|
486
|
-
PlainValidator(validate_open_enum(False)),
|
|
487
|
-
],
|
|
488
|
-
pydantic.Field(alias="pqCompress"),
|
|
460
|
+
Optional[OutputGrafanaCloudCompression2], pydantic.Field(alias="pqCompress")
|
|
489
461
|
] = OutputGrafanaCloudCompression2.NONE
|
|
490
462
|
r"""Codec to use to compress the persisted data"""
|
|
491
463
|
|
|
492
464
|
pq_on_backpressure: Annotated[
|
|
493
|
-
|
|
494
|
-
Optional[OutputGrafanaCloudQueueFullBehavior2],
|
|
495
|
-
PlainValidator(validate_open_enum(False)),
|
|
496
|
-
],
|
|
465
|
+
Optional[OutputGrafanaCloudQueueFullBehavior2],
|
|
497
466
|
pydantic.Field(alias="pqOnBackpressure"),
|
|
498
467
|
] = OutputGrafanaCloudQueueFullBehavior2.BLOCK
|
|
499
468
|
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."""
|
|
500
469
|
|
|
501
470
|
pq_mode: Annotated[
|
|
502
|
-
|
|
503
|
-
Optional[OutputGrafanaCloudMode2], PlainValidator(validate_open_enum(False))
|
|
504
|
-
],
|
|
505
|
-
pydantic.Field(alias="pqMode"),
|
|
471
|
+
Optional[OutputGrafanaCloudMode2], pydantic.Field(alias="pqMode")
|
|
506
472
|
] = OutputGrafanaCloudMode2.ERROR
|
|
507
473
|
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."""
|
|
508
474
|
|
|
@@ -511,11 +477,11 @@ class OutputGrafanaCloud2(BaseModel):
|
|
|
511
477
|
] = None
|
|
512
478
|
|
|
513
479
|
|
|
514
|
-
class OutputGrafanaCloudType1(str, Enum
|
|
480
|
+
class OutputGrafanaCloudType1(str, Enum):
|
|
515
481
|
GRAFANA_CLOUD = "grafana_cloud"
|
|
516
482
|
|
|
517
483
|
|
|
518
|
-
class OutputGrafanaCloudMessageFormat1(str, Enum
|
|
484
|
+
class OutputGrafanaCloudMessageFormat1(str, Enum):
|
|
519
485
|
r"""Format to use when sending logs to Loki (Protobuf or JSON)"""
|
|
520
486
|
|
|
521
487
|
PROTOBUF = "protobuf"
|
|
@@ -533,9 +499,7 @@ class OutputGrafanaCloudLabel1(BaseModel):
|
|
|
533
499
|
name: Optional[str] = ""
|
|
534
500
|
|
|
535
501
|
|
|
536
|
-
class OutputGrafanaCloudPrometheusAuthAuthenticationType1(
|
|
537
|
-
str, Enum, metaclass=utils.OpenEnumMeta
|
|
538
|
-
):
|
|
502
|
+
class OutputGrafanaCloudPrometheusAuthAuthenticationType1(str, Enum):
|
|
539
503
|
NONE = "none"
|
|
540
504
|
TOKEN = "token"
|
|
541
505
|
TEXT_SECRET = "textSecret"
|
|
@@ -559,10 +523,7 @@ class OutputGrafanaCloudPrometheusAuth1TypedDict(TypedDict):
|
|
|
559
523
|
|
|
560
524
|
class OutputGrafanaCloudPrometheusAuth1(BaseModel):
|
|
561
525
|
auth_type: Annotated[
|
|
562
|
-
|
|
563
|
-
Optional[OutputGrafanaCloudPrometheusAuthAuthenticationType1],
|
|
564
|
-
PlainValidator(validate_open_enum(False)),
|
|
565
|
-
],
|
|
526
|
+
Optional[OutputGrafanaCloudPrometheusAuthAuthenticationType1],
|
|
566
527
|
pydantic.Field(alias="authType"),
|
|
567
528
|
] = OutputGrafanaCloudPrometheusAuthAuthenticationType1.BASIC
|
|
568
529
|
|
|
@@ -584,9 +545,7 @@ class OutputGrafanaCloudPrometheusAuth1(BaseModel):
|
|
|
584
545
|
r"""Select or create a secret that references your credentials"""
|
|
585
546
|
|
|
586
547
|
|
|
587
|
-
class OutputGrafanaCloudLokiAuthAuthenticationType1(
|
|
588
|
-
str, Enum, metaclass=utils.OpenEnumMeta
|
|
589
|
-
):
|
|
548
|
+
class OutputGrafanaCloudLokiAuthAuthenticationType1(str, Enum):
|
|
590
549
|
NONE = "none"
|
|
591
550
|
TOKEN = "token"
|
|
592
551
|
TEXT_SECRET = "textSecret"
|
|
@@ -610,10 +569,7 @@ class OutputGrafanaCloudLokiAuth1TypedDict(TypedDict):
|
|
|
610
569
|
|
|
611
570
|
class OutputGrafanaCloudLokiAuth1(BaseModel):
|
|
612
571
|
auth_type: Annotated[
|
|
613
|
-
|
|
614
|
-
Optional[OutputGrafanaCloudLokiAuthAuthenticationType1],
|
|
615
|
-
PlainValidator(validate_open_enum(False)),
|
|
616
|
-
],
|
|
572
|
+
Optional[OutputGrafanaCloudLokiAuthAuthenticationType1],
|
|
617
573
|
pydantic.Field(alias="authType"),
|
|
618
574
|
] = OutputGrafanaCloudLokiAuthAuthenticationType1.BASIC
|
|
619
575
|
|
|
@@ -646,9 +602,7 @@ class OutputGrafanaCloudExtraHTTPHeader1(BaseModel):
|
|
|
646
602
|
name: Optional[str] = None
|
|
647
603
|
|
|
648
604
|
|
|
649
|
-
class OutputGrafanaCloudFailedRequestLoggingMode1(
|
|
650
|
-
str, Enum, metaclass=utils.OpenEnumMeta
|
|
651
|
-
):
|
|
605
|
+
class OutputGrafanaCloudFailedRequestLoggingMode1(str, Enum):
|
|
652
606
|
r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
|
|
653
607
|
|
|
654
608
|
PAYLOAD = "payload"
|
|
@@ -710,7 +664,7 @@ class OutputGrafanaCloudTimeoutRetrySettings1(BaseModel):
|
|
|
710
664
|
r"""The maximum backoff interval, in milliseconds, Cribl Stream should apply. Default (and minimum) is 10,000 ms (10 seconds); maximum is 180,000 ms (180 seconds)."""
|
|
711
665
|
|
|
712
666
|
|
|
713
|
-
class OutputGrafanaCloudBackpressureBehavior1(str, Enum
|
|
667
|
+
class OutputGrafanaCloudBackpressureBehavior1(str, Enum):
|
|
714
668
|
r"""How to handle events when all receivers are exerting backpressure"""
|
|
715
669
|
|
|
716
670
|
BLOCK = "block"
|
|
@@ -718,21 +672,21 @@ class OutputGrafanaCloudBackpressureBehavior1(str, Enum, metaclass=utils.OpenEnu
|
|
|
718
672
|
QUEUE = "queue"
|
|
719
673
|
|
|
720
674
|
|
|
721
|
-
class OutputGrafanaCloudCompression1(str, Enum
|
|
675
|
+
class OutputGrafanaCloudCompression1(str, Enum):
|
|
722
676
|
r"""Codec to use to compress the persisted data"""
|
|
723
677
|
|
|
724
678
|
NONE = "none"
|
|
725
679
|
GZIP = "gzip"
|
|
726
680
|
|
|
727
681
|
|
|
728
|
-
class OutputGrafanaCloudQueueFullBehavior1(str, Enum
|
|
682
|
+
class OutputGrafanaCloudQueueFullBehavior1(str, Enum):
|
|
729
683
|
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."""
|
|
730
684
|
|
|
731
685
|
BLOCK = "block"
|
|
732
686
|
DROP = "drop"
|
|
733
687
|
|
|
734
688
|
|
|
735
|
-
class OutputGrafanaCloudMode1(str, Enum
|
|
689
|
+
class OutputGrafanaCloudMode1(str, Enum):
|
|
736
690
|
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."""
|
|
737
691
|
|
|
738
692
|
ERROR = "error"
|
|
@@ -748,7 +702,7 @@ class OutputGrafanaCloudPqControls1(BaseModel):
|
|
|
748
702
|
pass
|
|
749
703
|
|
|
750
704
|
|
|
751
|
-
class
|
|
705
|
+
class OutputGrafanaCloudGrafanaCloud1TypedDict(TypedDict):
|
|
752
706
|
id: str
|
|
753
707
|
r"""Unique ID for this output"""
|
|
754
708
|
type: OutputGrafanaCloudType1
|
|
@@ -828,11 +782,11 @@ class OutputGrafanaCloud1TypedDict(TypedDict):
|
|
|
828
782
|
pq_controls: NotRequired[OutputGrafanaCloudPqControls1TypedDict]
|
|
829
783
|
|
|
830
784
|
|
|
831
|
-
class
|
|
785
|
+
class OutputGrafanaCloudGrafanaCloud1(BaseModel):
|
|
832
786
|
id: str
|
|
833
787
|
r"""Unique ID for this output"""
|
|
834
788
|
|
|
835
|
-
type:
|
|
789
|
+
type: OutputGrafanaCloudType1
|
|
836
790
|
|
|
837
791
|
loki_url: Annotated[str, pydantic.Field(alias="lokiUrl")]
|
|
838
792
|
r"""The endpoint to send logs to, such as https://logs-prod-us-central1.grafana.net"""
|
|
@@ -860,10 +814,7 @@ class OutputGrafanaCloud1(BaseModel):
|
|
|
860
814
|
r"""Name of the event field that contains the message to send. If not specified, Stream sends a JSON representation of the whole event."""
|
|
861
815
|
|
|
862
816
|
message_format: Annotated[
|
|
863
|
-
|
|
864
|
-
Optional[OutputGrafanaCloudMessageFormat1],
|
|
865
|
-
PlainValidator(validate_open_enum(False)),
|
|
866
|
-
],
|
|
817
|
+
Optional[OutputGrafanaCloudMessageFormat1],
|
|
867
818
|
pydantic.Field(alias="messageFormat"),
|
|
868
819
|
] = OutputGrafanaCloudMessageFormat1.PROTOBUF
|
|
869
820
|
r"""Format to use when sending logs to Loki (Protobuf or JSON)"""
|
|
@@ -926,10 +877,7 @@ class OutputGrafanaCloud1(BaseModel):
|
|
|
926
877
|
r"""Enable round-robin DNS lookup. When a DNS server returns multiple addresses, @{product} will cycle through them in the order returned. For optimal performance, consider enabling this setting for non-load balanced destinations."""
|
|
927
878
|
|
|
928
879
|
failed_request_logging_mode: Annotated[
|
|
929
|
-
|
|
930
|
-
Optional[OutputGrafanaCloudFailedRequestLoggingMode1],
|
|
931
|
-
PlainValidator(validate_open_enum(False)),
|
|
932
|
-
],
|
|
880
|
+
Optional[OutputGrafanaCloudFailedRequestLoggingMode1],
|
|
933
881
|
pydantic.Field(alias="failedRequestLoggingMode"),
|
|
934
882
|
] = OutputGrafanaCloudFailedRequestLoggingMode1.NONE
|
|
935
883
|
r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
|
|
@@ -956,10 +904,7 @@ class OutputGrafanaCloud1(BaseModel):
|
|
|
956
904
|
r"""Honor any Retry-After header that specifies a delay (in seconds) no longer than 180 seconds after the retry request. @{product} limits the delay to 180 seconds, even if the Retry-After header specifies a longer delay. When enabled, takes precedence over user-configured retry options. When disabled, all Retry-After headers are ignored."""
|
|
957
905
|
|
|
958
906
|
on_backpressure: Annotated[
|
|
959
|
-
|
|
960
|
-
Optional[OutputGrafanaCloudBackpressureBehavior1],
|
|
961
|
-
PlainValidator(validate_open_enum(False)),
|
|
962
|
-
],
|
|
907
|
+
Optional[OutputGrafanaCloudBackpressureBehavior1],
|
|
963
908
|
pydantic.Field(alias="onBackpressure"),
|
|
964
909
|
] = OutputGrafanaCloudBackpressureBehavior1.BLOCK
|
|
965
910
|
r"""How to handle events when all receivers are exerting backpressure"""
|
|
@@ -983,28 +928,18 @@ class OutputGrafanaCloud1(BaseModel):
|
|
|
983
928
|
r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/<output-id>."""
|
|
984
929
|
|
|
985
930
|
pq_compress: Annotated[
|
|
986
|
-
|
|
987
|
-
Optional[OutputGrafanaCloudCompression1],
|
|
988
|
-
PlainValidator(validate_open_enum(False)),
|
|
989
|
-
],
|
|
990
|
-
pydantic.Field(alias="pqCompress"),
|
|
931
|
+
Optional[OutputGrafanaCloudCompression1], pydantic.Field(alias="pqCompress")
|
|
991
932
|
] = OutputGrafanaCloudCompression1.NONE
|
|
992
933
|
r"""Codec to use to compress the persisted data"""
|
|
993
934
|
|
|
994
935
|
pq_on_backpressure: Annotated[
|
|
995
|
-
|
|
996
|
-
Optional[OutputGrafanaCloudQueueFullBehavior1],
|
|
997
|
-
PlainValidator(validate_open_enum(False)),
|
|
998
|
-
],
|
|
936
|
+
Optional[OutputGrafanaCloudQueueFullBehavior1],
|
|
999
937
|
pydantic.Field(alias="pqOnBackpressure"),
|
|
1000
938
|
] = OutputGrafanaCloudQueueFullBehavior1.BLOCK
|
|
1001
939
|
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."""
|
|
1002
940
|
|
|
1003
941
|
pq_mode: Annotated[
|
|
1004
|
-
|
|
1005
|
-
Optional[OutputGrafanaCloudMode1], PlainValidator(validate_open_enum(False))
|
|
1006
|
-
],
|
|
1007
|
-
pydantic.Field(alias="pqMode"),
|
|
942
|
+
Optional[OutputGrafanaCloudMode1], pydantic.Field(alias="pqMode")
|
|
1008
943
|
] = OutputGrafanaCloudMode1.ERROR
|
|
1009
944
|
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."""
|
|
1010
945
|
|
|
@@ -1013,12 +948,16 @@ class OutputGrafanaCloud1(BaseModel):
|
|
|
1013
948
|
] = None
|
|
1014
949
|
|
|
1015
950
|
|
|
1016
|
-
|
|
1017
|
-
"
|
|
1018
|
-
Union[
|
|
951
|
+
OutputGrafanaCloudTypedDict = TypeAliasType(
|
|
952
|
+
"OutputGrafanaCloudTypedDict",
|
|
953
|
+
Union[
|
|
954
|
+
OutputGrafanaCloudGrafanaCloud1TypedDict,
|
|
955
|
+
OutputGrafanaCloudGrafanaCloud2TypedDict,
|
|
956
|
+
],
|
|
1019
957
|
)
|
|
1020
958
|
|
|
1021
959
|
|
|
1022
|
-
|
|
1023
|
-
"
|
|
960
|
+
OutputGrafanaCloud = TypeAliasType(
|
|
961
|
+
"OutputGrafanaCloud",
|
|
962
|
+
Union[OutputGrafanaCloudGrafanaCloud1, OutputGrafanaCloudGrafanaCloud2],
|
|
1024
963
|
)
|
|
@@ -1,28 +1,25 @@
|
|
|
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 OutputGraphiteType(str, Enum
|
|
11
|
+
class OutputGraphiteType(str, Enum):
|
|
15
12
|
GRAPHITE = "graphite"
|
|
16
13
|
|
|
17
14
|
|
|
18
|
-
class OutputGraphiteDestinationProtocol(str, Enum
|
|
15
|
+
class OutputGraphiteDestinationProtocol(str, Enum):
|
|
19
16
|
r"""Protocol to use when communicating with the destination."""
|
|
20
17
|
|
|
21
18
|
UDP = "udp"
|
|
22
19
|
TCP = "tcp"
|
|
23
20
|
|
|
24
21
|
|
|
25
|
-
class OutputGraphiteBackpressureBehavior(str, Enum
|
|
22
|
+
class OutputGraphiteBackpressureBehavior(str, Enum):
|
|
26
23
|
r"""How to handle events when all receivers are exerting backpressure"""
|
|
27
24
|
|
|
28
25
|
BLOCK = "block"
|
|
@@ -30,21 +27,21 @@ class OutputGraphiteBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta
|
|
|
30
27
|
QUEUE = "queue"
|
|
31
28
|
|
|
32
29
|
|
|
33
|
-
class OutputGraphiteCompression(str, Enum
|
|
30
|
+
class OutputGraphiteCompression(str, Enum):
|
|
34
31
|
r"""Codec to use to compress the persisted data"""
|
|
35
32
|
|
|
36
33
|
NONE = "none"
|
|
37
34
|
GZIP = "gzip"
|
|
38
35
|
|
|
39
36
|
|
|
40
|
-
class OutputGraphiteQueueFullBehavior(str, Enum
|
|
37
|
+
class OutputGraphiteQueueFullBehavior(str, Enum):
|
|
41
38
|
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."""
|
|
42
39
|
|
|
43
40
|
BLOCK = "block"
|
|
44
41
|
DROP = "drop"
|
|
45
42
|
|
|
46
43
|
|
|
47
|
-
class OutputGraphiteMode(str, Enum
|
|
44
|
+
class OutputGraphiteMode(str, Enum):
|
|
48
45
|
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
46
|
|
|
50
47
|
ERROR = "error"
|
|
@@ -115,9 +112,7 @@ class OutputGraphite(BaseModel):
|
|
|
115
112
|
id: Optional[str] = None
|
|
116
113
|
r"""Unique ID for this output"""
|
|
117
114
|
|
|
118
|
-
type:
|
|
119
|
-
Optional[OutputGraphiteType], PlainValidator(validate_open_enum(False))
|
|
120
|
-
] = None
|
|
115
|
+
type: Optional[OutputGraphiteType] = None
|
|
121
116
|
|
|
122
117
|
pipeline: Optional[str] = None
|
|
123
118
|
r"""Pipeline to process data before sending out to this output"""
|
|
@@ -133,10 +128,9 @@ class OutputGraphite(BaseModel):
|
|
|
133
128
|
streamtags: Optional[List[str]] = None
|
|
134
129
|
r"""Tags for filtering and grouping in @{product}"""
|
|
135
130
|
|
|
136
|
-
protocol:
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
] = OutputGraphiteDestinationProtocol.UDP
|
|
131
|
+
protocol: Optional[OutputGraphiteDestinationProtocol] = (
|
|
132
|
+
OutputGraphiteDestinationProtocol.UDP
|
|
133
|
+
)
|
|
140
134
|
r"""Protocol to use when communicating with the destination."""
|
|
141
135
|
|
|
142
136
|
port: Optional[float] = 8125
|
|
@@ -173,10 +167,7 @@ class OutputGraphite(BaseModel):
|
|
|
173
167
|
r"""Amount of time (milliseconds) to wait for a write to complete before assuming connection is dead"""
|
|
174
168
|
|
|
175
169
|
on_backpressure: Annotated[
|
|
176
|
-
|
|
177
|
-
Optional[OutputGraphiteBackpressureBehavior],
|
|
178
|
-
PlainValidator(validate_open_enum(False)),
|
|
179
|
-
],
|
|
170
|
+
Optional[OutputGraphiteBackpressureBehavior],
|
|
180
171
|
pydantic.Field(alias="onBackpressure"),
|
|
181
172
|
] = OutputGraphiteBackpressureBehavior.BLOCK
|
|
182
173
|
r"""How to handle events when all receivers are exerting backpressure"""
|
|
@@ -195,29 +186,19 @@ class OutputGraphite(BaseModel):
|
|
|
195
186
|
r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/<output-id>."""
|
|
196
187
|
|
|
197
188
|
pq_compress: Annotated[
|
|
198
|
-
|
|
199
|
-
Optional[OutputGraphiteCompression],
|
|
200
|
-
PlainValidator(validate_open_enum(False)),
|
|
201
|
-
],
|
|
202
|
-
pydantic.Field(alias="pqCompress"),
|
|
189
|
+
Optional[OutputGraphiteCompression], pydantic.Field(alias="pqCompress")
|
|
203
190
|
] = OutputGraphiteCompression.NONE
|
|
204
191
|
r"""Codec to use to compress the persisted data"""
|
|
205
192
|
|
|
206
193
|
pq_on_backpressure: Annotated[
|
|
207
|
-
|
|
208
|
-
Optional[OutputGraphiteQueueFullBehavior],
|
|
209
|
-
PlainValidator(validate_open_enum(False)),
|
|
210
|
-
],
|
|
194
|
+
Optional[OutputGraphiteQueueFullBehavior],
|
|
211
195
|
pydantic.Field(alias="pqOnBackpressure"),
|
|
212
196
|
] = OutputGraphiteQueueFullBehavior.BLOCK
|
|
213
197
|
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."""
|
|
214
198
|
|
|
215
|
-
pq_mode: Annotated[
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
],
|
|
219
|
-
pydantic.Field(alias="pqMode"),
|
|
220
|
-
] = OutputGraphiteMode.ERROR
|
|
199
|
+
pq_mode: Annotated[Optional[OutputGraphiteMode], pydantic.Field(alias="pqMode")] = (
|
|
200
|
+
OutputGraphiteMode.ERROR
|
|
201
|
+
)
|
|
221
202
|
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."""
|
|
222
203
|
|
|
223
204
|
pq_controls: Annotated[
|