cribl-control-plane 0.0.13__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.

Files changed (197) hide show
  1. cribl_control_plane/__init__.py +17 -0
  2. cribl_control_plane/_hooks/__init__.py +5 -0
  3. cribl_control_plane/_hooks/clientcredentials.py +211 -0
  4. cribl_control_plane/_hooks/registration.py +13 -0
  5. cribl_control_plane/_hooks/sdkhooks.py +81 -0
  6. cribl_control_plane/_hooks/types.py +112 -0
  7. cribl_control_plane/_version.py +15 -0
  8. cribl_control_plane/auth_sdk.py +184 -0
  9. cribl_control_plane/basesdk.py +358 -0
  10. cribl_control_plane/errors/__init__.py +60 -0
  11. cribl_control_plane/errors/apierror.py +38 -0
  12. cribl_control_plane/errors/criblcontrolplaneerror.py +26 -0
  13. cribl_control_plane/errors/error.py +24 -0
  14. cribl_control_plane/errors/healthstatus_error.py +38 -0
  15. cribl_control_plane/errors/no_response_error.py +13 -0
  16. cribl_control_plane/errors/responsevalidationerror.py +25 -0
  17. cribl_control_plane/health.py +166 -0
  18. cribl_control_plane/httpclient.py +126 -0
  19. cribl_control_plane/models/__init__.py +7305 -0
  20. cribl_control_plane/models/addhectokenrequest.py +34 -0
  21. cribl_control_plane/models/authtoken.py +13 -0
  22. cribl_control_plane/models/createinputhectokenbyidop.py +45 -0
  23. cribl_control_plane/models/createinputop.py +24 -0
  24. cribl_control_plane/models/createoutputop.py +24 -0
  25. cribl_control_plane/models/createoutputtestbyidop.py +46 -0
  26. cribl_control_plane/models/criblevent.py +14 -0
  27. cribl_control_plane/models/deleteinputbyidop.py +37 -0
  28. cribl_control_plane/models/deleteoutputbyidop.py +37 -0
  29. cribl_control_plane/models/deleteoutputpqbyidop.py +36 -0
  30. cribl_control_plane/models/getinputbyidop.py +37 -0
  31. cribl_control_plane/models/getoutputbyidop.py +37 -0
  32. cribl_control_plane/models/getoutputpqbyidop.py +36 -0
  33. cribl_control_plane/models/getoutputsamplesbyidop.py +37 -0
  34. cribl_control_plane/models/healthstatus.py +36 -0
  35. cribl_control_plane/models/input.py +199 -0
  36. cribl_control_plane/models/inputappscope.py +448 -0
  37. cribl_control_plane/models/inputazureblob.py +308 -0
  38. cribl_control_plane/models/inputcollection.py +208 -0
  39. cribl_control_plane/models/inputconfluentcloud.py +585 -0
  40. cribl_control_plane/models/inputcribl.py +165 -0
  41. cribl_control_plane/models/inputcriblhttp.py +341 -0
  42. cribl_control_plane/models/inputcribllakehttp.py +342 -0
  43. cribl_control_plane/models/inputcriblmetrics.py +175 -0
  44. cribl_control_plane/models/inputcribltcp.py +299 -0
  45. cribl_control_plane/models/inputcrowdstrike.py +410 -0
  46. cribl_control_plane/models/inputdatadogagent.py +364 -0
  47. cribl_control_plane/models/inputdatagen.py +180 -0
  48. cribl_control_plane/models/inputedgeprometheus.py +551 -0
  49. cribl_control_plane/models/inputelastic.py +494 -0
  50. cribl_control_plane/models/inputeventhub.py +360 -0
  51. cribl_control_plane/models/inputexec.py +213 -0
  52. cribl_control_plane/models/inputfile.py +259 -0
  53. cribl_control_plane/models/inputfirehose.py +341 -0
  54. cribl_control_plane/models/inputgooglepubsub.py +247 -0
  55. cribl_control_plane/models/inputgrafana_union.py +1247 -0
  56. cribl_control_plane/models/inputhttp.py +403 -0
  57. cribl_control_plane/models/inputhttpraw.py +407 -0
  58. cribl_control_plane/models/inputjournalfiles.py +208 -0
  59. cribl_control_plane/models/inputkafka.py +581 -0
  60. cribl_control_plane/models/inputkinesis.py +363 -0
  61. cribl_control_plane/models/inputkubeevents.py +182 -0
  62. cribl_control_plane/models/inputkubelogs.py +256 -0
  63. cribl_control_plane/models/inputkubemetrics.py +233 -0
  64. cribl_control_plane/models/inputloki.py +468 -0
  65. cribl_control_plane/models/inputmetrics.py +290 -0
  66. cribl_control_plane/models/inputmodeldriventelemetry.py +274 -0
  67. cribl_control_plane/models/inputmsk.py +654 -0
  68. cribl_control_plane/models/inputnetflow.py +224 -0
  69. cribl_control_plane/models/inputoffice365mgmt.py +384 -0
  70. cribl_control_plane/models/inputoffice365msgtrace.py +449 -0
  71. cribl_control_plane/models/inputoffice365service.py +377 -0
  72. cribl_control_plane/models/inputopentelemetry.py +516 -0
  73. cribl_control_plane/models/inputprometheus.py +464 -0
  74. cribl_control_plane/models/inputprometheusrw.py +470 -0
  75. cribl_control_plane/models/inputrawudp.py +207 -0
  76. cribl_control_plane/models/inputs3.py +416 -0
  77. cribl_control_plane/models/inputs3inventory.py +440 -0
  78. cribl_control_plane/models/inputsecuritylake.py +425 -0
  79. cribl_control_plane/models/inputsnmp.py +274 -0
  80. cribl_control_plane/models/inputsplunk.py +387 -0
  81. cribl_control_plane/models/inputsplunkhec.py +478 -0
  82. cribl_control_plane/models/inputsplunksearch.py +537 -0
  83. cribl_control_plane/models/inputsqs.py +320 -0
  84. cribl_control_plane/models/inputsyslog_union.py +759 -0
  85. cribl_control_plane/models/inputsystemmetrics.py +533 -0
  86. cribl_control_plane/models/inputsystemstate.py +417 -0
  87. cribl_control_plane/models/inputtcp.py +359 -0
  88. cribl_control_plane/models/inputtcpjson.py +334 -0
  89. cribl_control_plane/models/inputwef.py +498 -0
  90. cribl_control_plane/models/inputwindowsmetrics.py +457 -0
  91. cribl_control_plane/models/inputwineventlogs.py +222 -0
  92. cribl_control_plane/models/inputwiz.py +334 -0
  93. cribl_control_plane/models/inputzscalerhec.py +439 -0
  94. cribl_control_plane/models/listinputop.py +24 -0
  95. cribl_control_plane/models/listoutputop.py +24 -0
  96. cribl_control_plane/models/logininfo.py +16 -0
  97. cribl_control_plane/models/output.py +229 -0
  98. cribl_control_plane/models/outputazureblob.py +471 -0
  99. cribl_control_plane/models/outputazuredataexplorer.py +660 -0
  100. cribl_control_plane/models/outputazureeventhub.py +321 -0
  101. cribl_control_plane/models/outputazurelogs.py +386 -0
  102. cribl_control_plane/models/outputclickhouse.py +650 -0
  103. cribl_control_plane/models/outputcloudwatch.py +273 -0
  104. cribl_control_plane/models/outputconfluentcloud.py +591 -0
  105. cribl_control_plane/models/outputcriblhttp.py +494 -0
  106. cribl_control_plane/models/outputcribllake.py +396 -0
  107. cribl_control_plane/models/outputcribltcp.py +387 -0
  108. cribl_control_plane/models/outputcrowdstrikenextgensiem.py +410 -0
  109. cribl_control_plane/models/outputdatadog.py +472 -0
  110. cribl_control_plane/models/outputdataset.py +437 -0
  111. cribl_control_plane/models/outputdefault.py +55 -0
  112. cribl_control_plane/models/outputdevnull.py +50 -0
  113. cribl_control_plane/models/outputdiskspool.py +89 -0
  114. cribl_control_plane/models/outputdls3.py +560 -0
  115. cribl_control_plane/models/outputdynatracehttp.py +454 -0
  116. cribl_control_plane/models/outputdynatraceotlp.py +486 -0
  117. cribl_control_plane/models/outputelastic.py +494 -0
  118. cribl_control_plane/models/outputelasticcloud.py +407 -0
  119. cribl_control_plane/models/outputexabeam.py +297 -0
  120. cribl_control_plane/models/outputfilesystem.py +357 -0
  121. cribl_control_plane/models/outputgooglechronicle.py +486 -0
  122. cribl_control_plane/models/outputgooglecloudlogging.py +557 -0
  123. cribl_control_plane/models/outputgooglecloudstorage.py +499 -0
  124. cribl_control_plane/models/outputgooglepubsub.py +274 -0
  125. cribl_control_plane/models/outputgrafanacloud_union.py +1024 -0
  126. cribl_control_plane/models/outputgraphite.py +225 -0
  127. cribl_control_plane/models/outputhoneycomb.py +369 -0
  128. cribl_control_plane/models/outputhumiohec.py +389 -0
  129. cribl_control_plane/models/outputinfluxdb.py +523 -0
  130. cribl_control_plane/models/outputkafka.py +581 -0
  131. cribl_control_plane/models/outputkinesis.py +312 -0
  132. cribl_control_plane/models/outputloki.py +425 -0
  133. cribl_control_plane/models/outputminio.py +512 -0
  134. cribl_control_plane/models/outputmsk.py +654 -0
  135. cribl_control_plane/models/outputnetflow.py +80 -0
  136. cribl_control_plane/models/outputnewrelic.py +424 -0
  137. cribl_control_plane/models/outputnewrelicevents.py +401 -0
  138. cribl_control_plane/models/outputopentelemetry.py +669 -0
  139. cribl_control_plane/models/outputprometheus.py +485 -0
  140. cribl_control_plane/models/outputring.py +121 -0
  141. cribl_control_plane/models/outputrouter.py +83 -0
  142. cribl_control_plane/models/outputs3.py +556 -0
  143. cribl_control_plane/models/outputsamplesresponse.py +14 -0
  144. cribl_control_plane/models/outputsecuritylake.py +505 -0
  145. cribl_control_plane/models/outputsentinel.py +488 -0
  146. cribl_control_plane/models/outputsentineloneaisiem.py +505 -0
  147. cribl_control_plane/models/outputservicenow.py +543 -0
  148. cribl_control_plane/models/outputsignalfx.py +369 -0
  149. cribl_control_plane/models/outputsnmp.py +80 -0
  150. cribl_control_plane/models/outputsns.py +274 -0
  151. cribl_control_plane/models/outputsplunk.py +383 -0
  152. cribl_control_plane/models/outputsplunkhec.py +434 -0
  153. cribl_control_plane/models/outputsplunklb.py +558 -0
  154. cribl_control_plane/models/outputsqs.py +328 -0
  155. cribl_control_plane/models/outputstatsd.py +224 -0
  156. cribl_control_plane/models/outputstatsdext.py +225 -0
  157. cribl_control_plane/models/outputsumologic.py +378 -0
  158. cribl_control_plane/models/outputsyslog.py +415 -0
  159. cribl_control_plane/models/outputtcpjson.py +413 -0
  160. cribl_control_plane/models/outputtestrequest.py +15 -0
  161. cribl_control_plane/models/outputtestresponse.py +29 -0
  162. cribl_control_plane/models/outputwavefront.py +369 -0
  163. cribl_control_plane/models/outputwebhook.py +689 -0
  164. cribl_control_plane/models/outputxsiam.py +415 -0
  165. cribl_control_plane/models/schemeclientoauth.py +24 -0
  166. cribl_control_plane/models/security.py +36 -0
  167. cribl_control_plane/models/updatehectokenrequest.py +31 -0
  168. cribl_control_plane/models/updateinputbyidop.py +44 -0
  169. cribl_control_plane/models/updateinputhectokenbyidandtokenop.py +52 -0
  170. cribl_control_plane/models/updateoutputbyidop.py +44 -0
  171. cribl_control_plane/outputs.py +1615 -0
  172. cribl_control_plane/py.typed +1 -0
  173. cribl_control_plane/sdk.py +164 -0
  174. cribl_control_plane/sdkconfiguration.py +36 -0
  175. cribl_control_plane/sources.py +1355 -0
  176. cribl_control_plane/types/__init__.py +21 -0
  177. cribl_control_plane/types/basemodel.py +39 -0
  178. cribl_control_plane/utils/__init__.py +187 -0
  179. cribl_control_plane/utils/annotations.py +55 -0
  180. cribl_control_plane/utils/datetimes.py +23 -0
  181. cribl_control_plane/utils/enums.py +74 -0
  182. cribl_control_plane/utils/eventstreaming.py +238 -0
  183. cribl_control_plane/utils/forms.py +223 -0
  184. cribl_control_plane/utils/headers.py +136 -0
  185. cribl_control_plane/utils/logger.py +27 -0
  186. cribl_control_plane/utils/metadata.py +118 -0
  187. cribl_control_plane/utils/queryparams.py +205 -0
  188. cribl_control_plane/utils/requestbodies.py +66 -0
  189. cribl_control_plane/utils/retries.py +217 -0
  190. cribl_control_plane/utils/security.py +207 -0
  191. cribl_control_plane/utils/serializers.py +249 -0
  192. cribl_control_plane/utils/unmarshal_json_response.py +24 -0
  193. cribl_control_plane/utils/url.py +155 -0
  194. cribl_control_plane/utils/values.py +137 -0
  195. cribl_control_plane-0.0.13.dist-info/METADATA +489 -0
  196. cribl_control_plane-0.0.13.dist-info/RECORD +197 -0
  197. cribl_control_plane-0.0.13.dist-info/WHEEL +4 -0
@@ -0,0 +1,457 @@
1
+ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
+
3
+ from __future__ import annotations
4
+ from cribl_control_plane import utils
5
+ from cribl_control_plane.types import BaseModel
6
+ from cribl_control_plane.utils import validate_open_enum
7
+ from enum import Enum
8
+ import pydantic
9
+ from pydantic.functional_validators import PlainValidator
10
+ from typing import List, Optional
11
+ from typing_extensions import Annotated, NotRequired, TypedDict
12
+
13
+
14
+ class InputWindowsMetricsType(str, Enum, metaclass=utils.OpenEnumMeta):
15
+ WINDOWS_METRICS = "windows_metrics"
16
+
17
+
18
+ class InputWindowsMetricsConnectionTypedDict(TypedDict):
19
+ output: str
20
+ pipeline: NotRequired[str]
21
+
22
+
23
+ class InputWindowsMetricsConnection(BaseModel):
24
+ output: str
25
+
26
+ pipeline: Optional[str] = None
27
+
28
+
29
+ class InputWindowsMetricsPqMode(str, Enum, metaclass=utils.OpenEnumMeta):
30
+ 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
+
32
+ SMART = "smart"
33
+ ALWAYS = "always"
34
+
35
+
36
+ class InputWindowsMetricsCompression(str, Enum, metaclass=utils.OpenEnumMeta):
37
+ r"""Codec to use to compress the persisted data"""
38
+
39
+ NONE = "none"
40
+ GZIP = "gzip"
41
+
42
+
43
+ class InputWindowsMetricsPqTypedDict(TypedDict):
44
+ mode: NotRequired[InputWindowsMetricsPqMode]
45
+ 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."""
46
+ max_buffer_size: NotRequired[float]
47
+ r"""The maximum number of events to hold in memory before writing the events to disk"""
48
+ commit_frequency: NotRequired[float]
49
+ r"""The number of events to send downstream before committing that Stream has read them"""
50
+ max_file_size: NotRequired[str]
51
+ r"""The maximum size to store in each queue file before closing and optionally compressing. Enter a numeral with units of KB, MB, etc."""
52
+ max_size: NotRequired[str]
53
+ r"""The maximum disk space that the queue can consume (as an average per Worker Process) before queueing stops. Enter a numeral with units of KB, MB, etc."""
54
+ path: NotRequired[str]
55
+ r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
56
+ compress: NotRequired[InputWindowsMetricsCompression]
57
+ r"""Codec to use to compress the persisted data"""
58
+
59
+
60
+ class InputWindowsMetricsPq(BaseModel):
61
+ mode: Annotated[
62
+ Optional[InputWindowsMetricsPqMode], PlainValidator(validate_open_enum(False))
63
+ ] = InputWindowsMetricsPqMode.ALWAYS
64
+ 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
+
66
+ max_buffer_size: Annotated[
67
+ Optional[float], pydantic.Field(alias="maxBufferSize")
68
+ ] = 1000
69
+ r"""The maximum number of events to hold in memory before writing the events to disk"""
70
+
71
+ commit_frequency: Annotated[
72
+ Optional[float], pydantic.Field(alias="commitFrequency")
73
+ ] = 42
74
+ r"""The number of events to send downstream before committing that Stream has read them"""
75
+
76
+ max_file_size: Annotated[Optional[str], pydantic.Field(alias="maxFileSize")] = (
77
+ "1 MB"
78
+ )
79
+ r"""The maximum size to store in each queue file before closing and optionally compressing. Enter a numeral with units of KB, MB, etc."""
80
+
81
+ max_size: Annotated[Optional[str], pydantic.Field(alias="maxSize")] = "5GB"
82
+ r"""The maximum disk space that the queue can consume (as an average per Worker Process) before queueing stops. Enter a numeral with units of KB, MB, etc."""
83
+
84
+ path: Optional[str] = "$CRIBL_HOME/state/queues"
85
+ r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
86
+
87
+ compress: Annotated[
88
+ Optional[InputWindowsMetricsCompression],
89
+ PlainValidator(validate_open_enum(False)),
90
+ ] = InputWindowsMetricsCompression.NONE
91
+ r"""Codec to use to compress the persisted data"""
92
+
93
+
94
+ class InputWindowsMetricsHostMode(str, Enum, metaclass=utils.OpenEnumMeta):
95
+ r"""Select level of detail for host metrics"""
96
+
97
+ BASIC = "basic"
98
+ ALL = "all"
99
+ CUSTOM = "custom"
100
+ DISABLED = "disabled"
101
+
102
+
103
+ class InputWindowsMetricsSystemMode(str, Enum, metaclass=utils.OpenEnumMeta):
104
+ r"""Select the level of details for system metrics"""
105
+
106
+ BASIC = "basic"
107
+ ALL = "all"
108
+ CUSTOM = "custom"
109
+ DISABLED = "disabled"
110
+
111
+
112
+ class InputWindowsMetricsSystemTypedDict(TypedDict):
113
+ mode: NotRequired[InputWindowsMetricsSystemMode]
114
+ r"""Select the level of details for system metrics"""
115
+ detail: NotRequired[bool]
116
+ r"""Generate metrics for all system information"""
117
+
118
+
119
+ class InputWindowsMetricsSystem(BaseModel):
120
+ mode: Annotated[
121
+ Optional[InputWindowsMetricsSystemMode],
122
+ PlainValidator(validate_open_enum(False)),
123
+ ] = InputWindowsMetricsSystemMode.BASIC
124
+ r"""Select the level of details for system metrics"""
125
+
126
+ detail: Optional[bool] = False
127
+ r"""Generate metrics for all system information"""
128
+
129
+
130
+ class InputWindowsMetricsCPUMode(str, Enum, metaclass=utils.OpenEnumMeta):
131
+ r"""Select the level of details for CPU metrics"""
132
+
133
+ BASIC = "basic"
134
+ ALL = "all"
135
+ CUSTOM = "custom"
136
+ DISABLED = "disabled"
137
+
138
+
139
+ class InputWindowsMetricsCPUTypedDict(TypedDict):
140
+ mode: NotRequired[InputWindowsMetricsCPUMode]
141
+ r"""Select the level of details for CPU metrics"""
142
+ per_cpu: NotRequired[bool]
143
+ r"""Generate metrics for each CPU"""
144
+ detail: NotRequired[bool]
145
+ r"""Generate metrics for all CPU states"""
146
+ time: NotRequired[bool]
147
+ r"""Generate raw, monotonic CPU time counters"""
148
+
149
+
150
+ class InputWindowsMetricsCPU(BaseModel):
151
+ mode: Annotated[
152
+ Optional[InputWindowsMetricsCPUMode], PlainValidator(validate_open_enum(False))
153
+ ] = InputWindowsMetricsCPUMode.BASIC
154
+ r"""Select the level of details for CPU metrics"""
155
+
156
+ per_cpu: Annotated[Optional[bool], pydantic.Field(alias="perCpu")] = False
157
+ r"""Generate metrics for each CPU"""
158
+
159
+ detail: Optional[bool] = False
160
+ r"""Generate metrics for all CPU states"""
161
+
162
+ time: Optional[bool] = False
163
+ r"""Generate raw, monotonic CPU time counters"""
164
+
165
+
166
+ class InputWindowsMetricsMemoryMode(str, Enum, metaclass=utils.OpenEnumMeta):
167
+ r"""Select the level of details for memory metrics"""
168
+
169
+ BASIC = "basic"
170
+ ALL = "all"
171
+ CUSTOM = "custom"
172
+ DISABLED = "disabled"
173
+
174
+
175
+ class InputWindowsMetricsMemoryTypedDict(TypedDict):
176
+ mode: NotRequired[InputWindowsMetricsMemoryMode]
177
+ r"""Select the level of details for memory metrics"""
178
+ detail: NotRequired[bool]
179
+ r"""Generate metrics for all memory states"""
180
+
181
+
182
+ class InputWindowsMetricsMemory(BaseModel):
183
+ mode: Annotated[
184
+ Optional[InputWindowsMetricsMemoryMode],
185
+ PlainValidator(validate_open_enum(False)),
186
+ ] = InputWindowsMetricsMemoryMode.BASIC
187
+ r"""Select the level of details for memory metrics"""
188
+
189
+ detail: Optional[bool] = False
190
+ r"""Generate metrics for all memory states"""
191
+
192
+
193
+ class InputWindowsMetricsNetworkMode(str, Enum, metaclass=utils.OpenEnumMeta):
194
+ r"""Select the level of details for network metrics"""
195
+
196
+ BASIC = "basic"
197
+ ALL = "all"
198
+ CUSTOM = "custom"
199
+ DISABLED = "disabled"
200
+
201
+
202
+ class InputWindowsMetricsNetworkTypedDict(TypedDict):
203
+ mode: NotRequired[InputWindowsMetricsNetworkMode]
204
+ r"""Select the level of details for network metrics"""
205
+ devices: NotRequired[List[str]]
206
+ r"""Network interfaces to include/exclude. All interfaces are included if this list is empty."""
207
+ per_interface: NotRequired[bool]
208
+ r"""Generate separate metrics for each interface"""
209
+ detail: NotRequired[bool]
210
+ r"""Generate full network metrics"""
211
+
212
+
213
+ class InputWindowsMetricsNetwork(BaseModel):
214
+ mode: Annotated[
215
+ Optional[InputWindowsMetricsNetworkMode],
216
+ PlainValidator(validate_open_enum(False)),
217
+ ] = InputWindowsMetricsNetworkMode.BASIC
218
+ r"""Select the level of details for network metrics"""
219
+
220
+ devices: Optional[List[str]] = None
221
+ r"""Network interfaces to include/exclude. All interfaces are included if this list is empty."""
222
+
223
+ per_interface: Annotated[Optional[bool], pydantic.Field(alias="perInterface")] = (
224
+ False
225
+ )
226
+ r"""Generate separate metrics for each interface"""
227
+
228
+ detail: Optional[bool] = False
229
+ r"""Generate full network metrics"""
230
+
231
+
232
+ class InputWindowsMetricsDiskMode(str, Enum, metaclass=utils.OpenEnumMeta):
233
+ r"""Select the level of details for disk metrics"""
234
+
235
+ BASIC = "basic"
236
+ ALL = "all"
237
+ CUSTOM = "custom"
238
+ DISABLED = "disabled"
239
+
240
+
241
+ class InputWindowsMetricsDiskTypedDict(TypedDict):
242
+ mode: NotRequired[InputWindowsMetricsDiskMode]
243
+ r"""Select the level of details for disk metrics"""
244
+ volumes: NotRequired[List[str]]
245
+ r"""Windows volumes to include/exclude. E.g.: C:, !E:, etc. Wildcards and ! (not) operators are supported. All volumes are included if this list is empty."""
246
+ per_volume: NotRequired[bool]
247
+ r"""Generate separate metrics for each volume"""
248
+
249
+
250
+ class InputWindowsMetricsDisk(BaseModel):
251
+ mode: Annotated[
252
+ Optional[InputWindowsMetricsDiskMode], PlainValidator(validate_open_enum(False))
253
+ ] = InputWindowsMetricsDiskMode.BASIC
254
+ r"""Select the level of details for disk metrics"""
255
+
256
+ volumes: Optional[List[str]] = None
257
+ r"""Windows volumes to include/exclude. E.g.: C:, !E:, etc. Wildcards and ! (not) operators are supported. All volumes are included if this list is empty."""
258
+
259
+ per_volume: Annotated[Optional[bool], pydantic.Field(alias="perVolume")] = False
260
+ r"""Generate separate metrics for each volume"""
261
+
262
+
263
+ class InputWindowsMetricsCustomTypedDict(TypedDict):
264
+ system: NotRequired[InputWindowsMetricsSystemTypedDict]
265
+ cpu: NotRequired[InputWindowsMetricsCPUTypedDict]
266
+ memory: NotRequired[InputWindowsMetricsMemoryTypedDict]
267
+ network: NotRequired[InputWindowsMetricsNetworkTypedDict]
268
+ disk: NotRequired[InputWindowsMetricsDiskTypedDict]
269
+
270
+
271
+ class InputWindowsMetricsCustom(BaseModel):
272
+ system: Optional[InputWindowsMetricsSystem] = None
273
+
274
+ cpu: Optional[InputWindowsMetricsCPU] = None
275
+
276
+ memory: Optional[InputWindowsMetricsMemory] = None
277
+
278
+ network: Optional[InputWindowsMetricsNetwork] = None
279
+
280
+ disk: Optional[InputWindowsMetricsDisk] = None
281
+
282
+
283
+ class InputWindowsMetricsHostTypedDict(TypedDict):
284
+ mode: NotRequired[InputWindowsMetricsHostMode]
285
+ r"""Select level of detail for host metrics"""
286
+ custom: NotRequired[InputWindowsMetricsCustomTypedDict]
287
+
288
+
289
+ class InputWindowsMetricsHost(BaseModel):
290
+ mode: Annotated[
291
+ Optional[InputWindowsMetricsHostMode], PlainValidator(validate_open_enum(False))
292
+ ] = InputWindowsMetricsHostMode.BASIC
293
+ r"""Select level of detail for host metrics"""
294
+
295
+ custom: Optional[InputWindowsMetricsCustom] = None
296
+
297
+
298
+ class InputWindowsMetricsSetTypedDict(TypedDict):
299
+ name: str
300
+ filter_: str
301
+ include_children: NotRequired[bool]
302
+
303
+
304
+ class InputWindowsMetricsSet(BaseModel):
305
+ name: str
306
+
307
+ filter_: Annotated[str, pydantic.Field(alias="filter")]
308
+
309
+ include_children: Annotated[
310
+ Optional[bool], pydantic.Field(alias="includeChildren")
311
+ ] = False
312
+
313
+
314
+ class InputWindowsMetricsProcessTypedDict(TypedDict):
315
+ sets: NotRequired[List[InputWindowsMetricsSetTypedDict]]
316
+ r"""Configure sets to collect process metrics"""
317
+
318
+
319
+ class InputWindowsMetricsProcess(BaseModel):
320
+ sets: Optional[List[InputWindowsMetricsSet]] = None
321
+ r"""Configure sets to collect process metrics"""
322
+
323
+
324
+ class InputWindowsMetricsMetadatumTypedDict(TypedDict):
325
+ name: str
326
+ value: str
327
+ r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
328
+
329
+
330
+ class InputWindowsMetricsMetadatum(BaseModel):
331
+ name: str
332
+
333
+ value: str
334
+ r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
335
+
336
+
337
+ class InputWindowsMetricsDataCompressionFormat(str, Enum, metaclass=utils.OpenEnumMeta):
338
+ NONE = "none"
339
+ GZIP = "gzip"
340
+
341
+
342
+ class InputWindowsMetricsPersistenceTypedDict(TypedDict):
343
+ enable: NotRequired[bool]
344
+ r"""Spool metrics to disk for Cribl Edge and Search"""
345
+ time_window: NotRequired[str]
346
+ r"""Time span for each file bucket"""
347
+ max_data_size: NotRequired[str]
348
+ r"""Maximum disk space allowed to be consumed (examples: 420MB, 4GB). When limit is reached, older data will be deleted."""
349
+ max_data_time: NotRequired[str]
350
+ r"""Maximum amount of time to retain data (examples: 2h, 4d). When limit is reached, older data will be deleted."""
351
+ compress: NotRequired[InputWindowsMetricsDataCompressionFormat]
352
+ dest_path: NotRequired[str]
353
+ r"""Path to use to write metrics. Defaults to $CRIBL_HOME/state/windows_metrics"""
354
+
355
+
356
+ class InputWindowsMetricsPersistence(BaseModel):
357
+ enable: Optional[bool] = False
358
+ r"""Spool metrics to disk for Cribl Edge and Search"""
359
+
360
+ time_window: Annotated[Optional[str], pydantic.Field(alias="timeWindow")] = "10m"
361
+ r"""Time span for each file bucket"""
362
+
363
+ max_data_size: Annotated[Optional[str], pydantic.Field(alias="maxDataSize")] = "1GB"
364
+ r"""Maximum disk space allowed to be consumed (examples: 420MB, 4GB). When limit is reached, older data will be deleted."""
365
+
366
+ max_data_time: Annotated[Optional[str], pydantic.Field(alias="maxDataTime")] = "24h"
367
+ r"""Maximum amount of time to retain data (examples: 2h, 4d). When limit is reached, older data will be deleted."""
368
+
369
+ compress: Annotated[
370
+ Optional[InputWindowsMetricsDataCompressionFormat],
371
+ PlainValidator(validate_open_enum(False)),
372
+ ] = InputWindowsMetricsDataCompressionFormat.GZIP
373
+
374
+ dest_path: Annotated[Optional[str], pydantic.Field(alias="destPath")] = (
375
+ "$CRIBL_HOME/state/windows_metrics"
376
+ )
377
+ r"""Path to use to write metrics. Defaults to $CRIBL_HOME/state/windows_metrics"""
378
+
379
+
380
+ class InputWindowsMetricsTypedDict(TypedDict):
381
+ id: str
382
+ r"""Unique ID for this input"""
383
+ type: InputWindowsMetricsType
384
+ disabled: NotRequired[bool]
385
+ pipeline: NotRequired[str]
386
+ r"""Pipeline to process data from this Source before sending it through the Routes"""
387
+ send_to_routes: NotRequired[bool]
388
+ r"""Select whether to send data to Routes, or directly to Destinations."""
389
+ environment: NotRequired[str]
390
+ r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
391
+ pq_enabled: NotRequired[bool]
392
+ r"""Use a disk queue to minimize data loss when connected services block. See [Cribl Docs](https://docs.cribl.io/stream/persistent-queues) for PQ defaults (Cribl-managed Cloud Workers) and configuration options (on-prem and hybrid Workers)."""
393
+ streamtags: NotRequired[List[str]]
394
+ r"""Tags for filtering and grouping in @{product}"""
395
+ connections: NotRequired[List[InputWindowsMetricsConnectionTypedDict]]
396
+ r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
397
+ pq: NotRequired[InputWindowsMetricsPqTypedDict]
398
+ interval: NotRequired[float]
399
+ r"""Time, in seconds, between consecutive metric collections. Default is 10 seconds."""
400
+ host: NotRequired[InputWindowsMetricsHostTypedDict]
401
+ process: NotRequired[InputWindowsMetricsProcessTypedDict]
402
+ metadata: NotRequired[List[InputWindowsMetricsMetadatumTypedDict]]
403
+ r"""Fields to add to events from this input"""
404
+ persistence: NotRequired[InputWindowsMetricsPersistenceTypedDict]
405
+ disable_native_module: NotRequired[bool]
406
+ r"""Enable to use built-in tools (PowerShell) to collect metrics instead of native API (default) [Learn more](https://docs.cribl.io/edge/sources-windows-metrics/#advanced-tab)"""
407
+ description: NotRequired[str]
408
+
409
+
410
+ class InputWindowsMetrics(BaseModel):
411
+ id: str
412
+ r"""Unique ID for this input"""
413
+
414
+ type: Annotated[InputWindowsMetricsType, PlainValidator(validate_open_enum(False))]
415
+
416
+ disabled: Optional[bool] = False
417
+
418
+ pipeline: Optional[str] = None
419
+ r"""Pipeline to process data from this Source before sending it through the Routes"""
420
+
421
+ send_to_routes: Annotated[Optional[bool], pydantic.Field(alias="sendToRoutes")] = (
422
+ True
423
+ )
424
+ r"""Select whether to send data to Routes, or directly to Destinations."""
425
+
426
+ environment: Optional[str] = None
427
+ r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
428
+
429
+ pq_enabled: Annotated[Optional[bool], pydantic.Field(alias="pqEnabled")] = False
430
+ r"""Use a disk queue to minimize data loss when connected services block. See [Cribl Docs](https://docs.cribl.io/stream/persistent-queues) for PQ defaults (Cribl-managed Cloud Workers) and configuration options (on-prem and hybrid Workers)."""
431
+
432
+ streamtags: Optional[List[str]] = None
433
+ r"""Tags for filtering and grouping in @{product}"""
434
+
435
+ connections: Optional[List[InputWindowsMetricsConnection]] = None
436
+ r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
437
+
438
+ pq: Optional[InputWindowsMetricsPq] = None
439
+
440
+ interval: Optional[float] = 10
441
+ r"""Time, in seconds, between consecutive metric collections. Default is 10 seconds."""
442
+
443
+ host: Optional[InputWindowsMetricsHost] = None
444
+
445
+ process: Optional[InputWindowsMetricsProcess] = None
446
+
447
+ metadata: Optional[List[InputWindowsMetricsMetadatum]] = None
448
+ r"""Fields to add to events from this input"""
449
+
450
+ persistence: Optional[InputWindowsMetricsPersistence] = None
451
+
452
+ disable_native_module: Annotated[
453
+ Optional[bool], pydantic.Field(alias="disableNativeModule")
454
+ ] = False
455
+ r"""Enable to use built-in tools (PowerShell) to collect metrics instead of native API (default) [Learn more](https://docs.cribl.io/edge/sources-windows-metrics/#advanced-tab)"""
456
+
457
+ description: Optional[str] = None
@@ -0,0 +1,222 @@
1
+ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
2
+
3
+ from __future__ import annotations
4
+ from cribl_control_plane import utils
5
+ from cribl_control_plane.types import BaseModel
6
+ from cribl_control_plane.utils import validate_open_enum
7
+ from enum import Enum
8
+ import pydantic
9
+ from pydantic.functional_validators import PlainValidator
10
+ from typing import List, Optional
11
+ from typing_extensions import Annotated, NotRequired, TypedDict
12
+
13
+
14
+ class InputWinEventLogsType(str, Enum, metaclass=utils.OpenEnumMeta):
15
+ WIN_EVENT_LOGS = "win_event_logs"
16
+
17
+
18
+ class InputWinEventLogsConnectionTypedDict(TypedDict):
19
+ output: str
20
+ pipeline: NotRequired[str]
21
+
22
+
23
+ class InputWinEventLogsConnection(BaseModel):
24
+ output: str
25
+
26
+ pipeline: Optional[str] = None
27
+
28
+
29
+ class InputWinEventLogsMode(str, Enum, metaclass=utils.OpenEnumMeta):
30
+ 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
+
32
+ SMART = "smart"
33
+ ALWAYS = "always"
34
+
35
+
36
+ class InputWinEventLogsCompression(str, Enum, metaclass=utils.OpenEnumMeta):
37
+ r"""Codec to use to compress the persisted data"""
38
+
39
+ NONE = "none"
40
+ GZIP = "gzip"
41
+
42
+
43
+ class InputWinEventLogsPqTypedDict(TypedDict):
44
+ mode: NotRequired[InputWinEventLogsMode]
45
+ 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."""
46
+ max_buffer_size: NotRequired[float]
47
+ r"""The maximum number of events to hold in memory before writing the events to disk"""
48
+ commit_frequency: NotRequired[float]
49
+ r"""The number of events to send downstream before committing that Stream has read them"""
50
+ max_file_size: NotRequired[str]
51
+ r"""The maximum size to store in each queue file before closing and optionally compressing. Enter a numeral with units of KB, MB, etc."""
52
+ max_size: NotRequired[str]
53
+ r"""The maximum disk space that the queue can consume (as an average per Worker Process) before queueing stops. Enter a numeral with units of KB, MB, etc."""
54
+ path: NotRequired[str]
55
+ r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
56
+ compress: NotRequired[InputWinEventLogsCompression]
57
+ r"""Codec to use to compress the persisted data"""
58
+
59
+
60
+ class InputWinEventLogsPq(BaseModel):
61
+ mode: Annotated[
62
+ Optional[InputWinEventLogsMode], PlainValidator(validate_open_enum(False))
63
+ ] = InputWinEventLogsMode.ALWAYS
64
+ 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
+
66
+ max_buffer_size: Annotated[
67
+ Optional[float], pydantic.Field(alias="maxBufferSize")
68
+ ] = 1000
69
+ r"""The maximum number of events to hold in memory before writing the events to disk"""
70
+
71
+ commit_frequency: Annotated[
72
+ Optional[float], pydantic.Field(alias="commitFrequency")
73
+ ] = 42
74
+ r"""The number of events to send downstream before committing that Stream has read them"""
75
+
76
+ max_file_size: Annotated[Optional[str], pydantic.Field(alias="maxFileSize")] = (
77
+ "1 MB"
78
+ )
79
+ r"""The maximum size to store in each queue file before closing and optionally compressing. Enter a numeral with units of KB, MB, etc."""
80
+
81
+ max_size: Annotated[Optional[str], pydantic.Field(alias="maxSize")] = "5GB"
82
+ r"""The maximum disk space that the queue can consume (as an average per Worker Process) before queueing stops. Enter a numeral with units of KB, MB, etc."""
83
+
84
+ path: Optional[str] = "$CRIBL_HOME/state/queues"
85
+ r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
86
+
87
+ compress: Annotated[
88
+ Optional[InputWinEventLogsCompression],
89
+ PlainValidator(validate_open_enum(False)),
90
+ ] = InputWinEventLogsCompression.NONE
91
+ r"""Codec to use to compress the persisted data"""
92
+
93
+
94
+ class ReadMode(str, Enum, metaclass=utils.OpenEnumMeta):
95
+ r"""Read all stored and future event logs, or only future events"""
96
+
97
+ OLDEST = "oldest"
98
+ NEWEST = "newest"
99
+
100
+
101
+ class EventFormat(str, Enum, metaclass=utils.OpenEnumMeta):
102
+ r"""Format of individual events"""
103
+
104
+ JSON = "json"
105
+ XML = "xml"
106
+
107
+
108
+ class InputWinEventLogsMetadatumTypedDict(TypedDict):
109
+ name: str
110
+ value: str
111
+ r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
112
+
113
+
114
+ class InputWinEventLogsMetadatum(BaseModel):
115
+ name: str
116
+
117
+ value: str
118
+ r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
119
+
120
+
121
+ class InputWinEventLogsTypedDict(TypedDict):
122
+ type: InputWinEventLogsType
123
+ log_names: List[str]
124
+ r"""Enter the event logs to collect. Run \"Get-WinEvent -ListLog *\" in PowerShell to see the available logs."""
125
+ id: NotRequired[str]
126
+ r"""Unique ID for this input"""
127
+ disabled: NotRequired[bool]
128
+ pipeline: NotRequired[str]
129
+ r"""Pipeline to process data from this Source before sending it through the Routes"""
130
+ send_to_routes: NotRequired[bool]
131
+ r"""Select whether to send data to Routes, or directly to Destinations."""
132
+ environment: NotRequired[str]
133
+ r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
134
+ pq_enabled: NotRequired[bool]
135
+ r"""Use a disk queue to minimize data loss when connected services block. See [Cribl Docs](https://docs.cribl.io/stream/persistent-queues) for PQ defaults (Cribl-managed Cloud Workers) and configuration options (on-prem and hybrid Workers)."""
136
+ streamtags: NotRequired[List[str]]
137
+ r"""Tags for filtering and grouping in @{product}"""
138
+ connections: NotRequired[List[InputWinEventLogsConnectionTypedDict]]
139
+ r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
140
+ pq: NotRequired[InputWinEventLogsPqTypedDict]
141
+ read_mode: NotRequired[ReadMode]
142
+ r"""Read all stored and future event logs, or only future events"""
143
+ event_format: NotRequired[EventFormat]
144
+ r"""Format of individual events"""
145
+ disable_native_module: NotRequired[bool]
146
+ r"""Enable to use built-in tools (PowerShell for JSON, wevtutil for XML) to collect event logs instead of native API (default) [Learn more](https://docs.cribl.io/edge/sources-windows-event-logs/#advanced-settings)"""
147
+ interval: NotRequired[float]
148
+ r"""Time, in seconds, between checking for new entries (Applicable for pre-4.8.0 nodes that use Windows Tools)"""
149
+ batch_size: NotRequired[float]
150
+ r"""The maximum number of events to read in one polling interval. A batch size higher than 500 can cause delays when pulling from multiple event logs. (Applicable for pre-4.8.0 nodes that use Windows Tools)"""
151
+ metadata: NotRequired[List[InputWinEventLogsMetadatumTypedDict]]
152
+ r"""Fields to add to events from this input"""
153
+ max_event_bytes: NotRequired[float]
154
+ r"""The maximum number of bytes in an event before it is flushed to the pipelines"""
155
+ description: NotRequired[str]
156
+
157
+
158
+ class InputWinEventLogs(BaseModel):
159
+ type: Annotated[InputWinEventLogsType, PlainValidator(validate_open_enum(False))]
160
+
161
+ log_names: Annotated[List[str], pydantic.Field(alias="logNames")]
162
+ r"""Enter the event logs to collect. Run \"Get-WinEvent -ListLog *\" in PowerShell to see the available logs."""
163
+
164
+ id: Optional[str] = None
165
+ r"""Unique ID for this input"""
166
+
167
+ disabled: Optional[bool] = False
168
+
169
+ pipeline: Optional[str] = None
170
+ r"""Pipeline to process data from this Source before sending it through the Routes"""
171
+
172
+ send_to_routes: Annotated[Optional[bool], pydantic.Field(alias="sendToRoutes")] = (
173
+ True
174
+ )
175
+ r"""Select whether to send data to Routes, or directly to Destinations."""
176
+
177
+ environment: Optional[str] = None
178
+ r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
179
+
180
+ pq_enabled: Annotated[Optional[bool], pydantic.Field(alias="pqEnabled")] = False
181
+ r"""Use a disk queue to minimize data loss when connected services block. See [Cribl Docs](https://docs.cribl.io/stream/persistent-queues) for PQ defaults (Cribl-managed Cloud Workers) and configuration options (on-prem and hybrid Workers)."""
182
+
183
+ streamtags: Optional[List[str]] = None
184
+ r"""Tags for filtering and grouping in @{product}"""
185
+
186
+ connections: Optional[List[InputWinEventLogsConnection]] = None
187
+ r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
188
+
189
+ pq: Optional[InputWinEventLogsPq] = None
190
+
191
+ read_mode: Annotated[
192
+ Annotated[Optional[ReadMode], PlainValidator(validate_open_enum(False))],
193
+ pydantic.Field(alias="readMode"),
194
+ ] = ReadMode.OLDEST
195
+ r"""Read all stored and future event logs, or only future events"""
196
+
197
+ event_format: Annotated[
198
+ Annotated[Optional[EventFormat], PlainValidator(validate_open_enum(False))],
199
+ pydantic.Field(alias="eventFormat"),
200
+ ] = EventFormat.JSON
201
+ r"""Format of individual events"""
202
+
203
+ disable_native_module: Annotated[
204
+ Optional[bool], pydantic.Field(alias="disableNativeModule")
205
+ ] = False
206
+ r"""Enable to use built-in tools (PowerShell for JSON, wevtutil for XML) to collect event logs instead of native API (default) [Learn more](https://docs.cribl.io/edge/sources-windows-event-logs/#advanced-settings)"""
207
+
208
+ interval: Optional[float] = 10
209
+ r"""Time, in seconds, between checking for new entries (Applicable for pre-4.8.0 nodes that use Windows Tools)"""
210
+
211
+ batch_size: Annotated[Optional[float], pydantic.Field(alias="batchSize")] = 500
212
+ r"""The maximum number of events to read in one polling interval. A batch size higher than 500 can cause delays when pulling from multiple event logs. (Applicable for pre-4.8.0 nodes that use Windows Tools)"""
213
+
214
+ metadata: Optional[List[InputWinEventLogsMetadatum]] = None
215
+ r"""Fields to add to events from this input"""
216
+
217
+ max_event_bytes: Annotated[
218
+ Optional[float], pydantic.Field(alias="maxEventBytes")
219
+ ] = 51200
220
+ r"""The maximum number of bytes in an event before it is flushed to the pipelines"""
221
+
222
+ description: Optional[str] = None