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,80 @@
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 OutputNetflowType(str, Enum, metaclass=utils.OpenEnumMeta):
15
+ NETFLOW = "netflow"
16
+
17
+
18
+ class OutputNetflowHostTypedDict(TypedDict):
19
+ host: str
20
+ r"""Destination host"""
21
+ port: NotRequired[float]
22
+ r"""Destination port, default is 2055"""
23
+
24
+
25
+ class OutputNetflowHost(BaseModel):
26
+ host: str
27
+ r"""Destination host"""
28
+
29
+ port: Optional[float] = 2055
30
+ r"""Destination port, default is 2055"""
31
+
32
+
33
+ class OutputNetflowTypedDict(TypedDict):
34
+ type: OutputNetflowType
35
+ hosts: List[OutputNetflowHostTypedDict]
36
+ r"""One or more NetFlow destinations to forward events to"""
37
+ id: NotRequired[str]
38
+ r"""Unique ID for this output"""
39
+ pipeline: NotRequired[str]
40
+ r"""Pipeline to process data before sending out to this output"""
41
+ system_fields: NotRequired[List[str]]
42
+ r"""Fields to automatically add to events, such as cribl_pipe. Supports wildcards."""
43
+ environment: NotRequired[str]
44
+ r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
45
+ streamtags: NotRequired[List[str]]
46
+ r"""Tags for filtering and grouping in @{product}"""
47
+ dns_resolve_period_sec: NotRequired[float]
48
+ r"""How often to resolve the destination hostname to an IP address. Ignored if all destinations are IP addresses. A value of 0 means every datagram sent will incur a DNS lookup."""
49
+ description: NotRequired[str]
50
+
51
+
52
+ class OutputNetflow(BaseModel):
53
+ type: Annotated[OutputNetflowType, PlainValidator(validate_open_enum(False))]
54
+
55
+ hosts: List[OutputNetflowHost]
56
+ r"""One or more NetFlow destinations to forward events to"""
57
+
58
+ id: Optional[str] = None
59
+ r"""Unique ID for this output"""
60
+
61
+ pipeline: Optional[str] = None
62
+ r"""Pipeline to process data before sending out to this output"""
63
+
64
+ system_fields: Annotated[
65
+ Optional[List[str]], pydantic.Field(alias="systemFields")
66
+ ] = None
67
+ r"""Fields to automatically add to events, such as cribl_pipe. Supports wildcards."""
68
+
69
+ environment: Optional[str] = None
70
+ r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
71
+
72
+ streamtags: Optional[List[str]] = None
73
+ r"""Tags for filtering and grouping in @{product}"""
74
+
75
+ dns_resolve_period_sec: Annotated[
76
+ Optional[float], pydantic.Field(alias="dnsResolvePeriodSec")
77
+ ] = 0
78
+ r"""How often to resolve the destination hostname to an IP address. Ignored if all destinations are IP addresses. A value of 0 means every datagram sent will incur a DNS lookup."""
79
+
80
+ description: Optional[str] = None
@@ -0,0 +1,424 @@
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 OutputNewrelicType(str, Enum, metaclass=utils.OpenEnumMeta):
15
+ NEWRELIC = "newrelic"
16
+
17
+
18
+ class OutputNewrelicRegion(str, Enum, metaclass=utils.OpenEnumMeta):
19
+ r"""Which New Relic region endpoint to use."""
20
+
21
+ US = "US"
22
+ EU = "EU"
23
+ CUSTOM = "Custom"
24
+
25
+
26
+ class FieldName(str, Enum, metaclass=utils.OpenEnumMeta):
27
+ SERVICE = "service"
28
+ HOSTNAME = "hostname"
29
+ TIMESTAMP = "timestamp"
30
+ AUDIT_ID = "auditId"
31
+
32
+
33
+ class OutputNewrelicMetadatumTypedDict(TypedDict):
34
+ name: FieldName
35
+ value: str
36
+ r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
37
+
38
+
39
+ class OutputNewrelicMetadatum(BaseModel):
40
+ name: Annotated[FieldName, PlainValidator(validate_open_enum(False))]
41
+
42
+ value: str
43
+ r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
44
+
45
+
46
+ class OutputNewrelicExtraHTTPHeaderTypedDict(TypedDict):
47
+ value: str
48
+ name: NotRequired[str]
49
+
50
+
51
+ class OutputNewrelicExtraHTTPHeader(BaseModel):
52
+ value: str
53
+
54
+ name: Optional[str] = None
55
+
56
+
57
+ class OutputNewrelicFailedRequestLoggingMode(str, Enum, metaclass=utils.OpenEnumMeta):
58
+ r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
59
+
60
+ PAYLOAD = "payload"
61
+ PAYLOAD_AND_HEADERS = "payloadAndHeaders"
62
+ NONE = "none"
63
+
64
+
65
+ class OutputNewrelicResponseRetrySettingTypedDict(TypedDict):
66
+ http_status: float
67
+ r"""The HTTP response status code that will trigger retries"""
68
+ initial_backoff: NotRequired[float]
69
+ r"""How long, in milliseconds, Cribl Stream should wait before initiating backoff. Maximum interval is 600,000 ms (10 minutes)."""
70
+ backoff_rate: NotRequired[float]
71
+ r"""Base for exponential backoff. A value of 2 (default) means Cribl Stream will retry after 2 seconds, then 4 seconds, then 8 seconds, etc."""
72
+ max_backoff: NotRequired[float]
73
+ 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)."""
74
+
75
+
76
+ class OutputNewrelicResponseRetrySetting(BaseModel):
77
+ http_status: Annotated[float, pydantic.Field(alias="httpStatus")]
78
+ r"""The HTTP response status code that will trigger retries"""
79
+
80
+ initial_backoff: Annotated[
81
+ Optional[float], pydantic.Field(alias="initialBackoff")
82
+ ] = 1000
83
+ r"""How long, in milliseconds, Cribl Stream should wait before initiating backoff. Maximum interval is 600,000 ms (10 minutes)."""
84
+
85
+ backoff_rate: Annotated[Optional[float], pydantic.Field(alias="backoffRate")] = 2
86
+ r"""Base for exponential backoff. A value of 2 (default) means Cribl Stream will retry after 2 seconds, then 4 seconds, then 8 seconds, etc."""
87
+
88
+ max_backoff: Annotated[Optional[float], pydantic.Field(alias="maxBackoff")] = 10000
89
+ 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)."""
90
+
91
+
92
+ class OutputNewrelicTimeoutRetrySettingsTypedDict(TypedDict):
93
+ timeout_retry: NotRequired[bool]
94
+ initial_backoff: NotRequired[float]
95
+ r"""How long, in milliseconds, Cribl Stream should wait before initiating backoff. Maximum interval is 600,000 ms (10 minutes)."""
96
+ backoff_rate: NotRequired[float]
97
+ r"""Base for exponential backoff. A value of 2 (default) means Cribl Stream will retry after 2 seconds, then 4 seconds, then 8 seconds, etc."""
98
+ max_backoff: NotRequired[float]
99
+ 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)."""
100
+
101
+
102
+ class OutputNewrelicTimeoutRetrySettings(BaseModel):
103
+ timeout_retry: Annotated[Optional[bool], pydantic.Field(alias="timeoutRetry")] = (
104
+ False
105
+ )
106
+
107
+ initial_backoff: Annotated[
108
+ Optional[float], pydantic.Field(alias="initialBackoff")
109
+ ] = 1000
110
+ r"""How long, in milliseconds, Cribl Stream should wait before initiating backoff. Maximum interval is 600,000 ms (10 minutes)."""
111
+
112
+ backoff_rate: Annotated[Optional[float], pydantic.Field(alias="backoffRate")] = 2
113
+ r"""Base for exponential backoff. A value of 2 (default) means Cribl Stream will retry after 2 seconds, then 4 seconds, then 8 seconds, etc."""
114
+
115
+ max_backoff: Annotated[Optional[float], pydantic.Field(alias="maxBackoff")] = 10000
116
+ 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)."""
117
+
118
+
119
+ class OutputNewrelicBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
120
+ r"""How to handle events when all receivers are exerting backpressure"""
121
+
122
+ BLOCK = "block"
123
+ DROP = "drop"
124
+ QUEUE = "queue"
125
+
126
+
127
+ class OutputNewrelicAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
128
+ r"""Enter API key directly, or select a stored secret"""
129
+
130
+ MANUAL = "manual"
131
+ SECRET = "secret"
132
+
133
+
134
+ class OutputNewrelicCompression(str, Enum, metaclass=utils.OpenEnumMeta):
135
+ r"""Codec to use to compress the persisted data"""
136
+
137
+ NONE = "none"
138
+ GZIP = "gzip"
139
+
140
+
141
+ class OutputNewrelicQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
142
+ 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."""
143
+
144
+ BLOCK = "block"
145
+ DROP = "drop"
146
+
147
+
148
+ class OutputNewrelicMode(str, Enum, metaclass=utils.OpenEnumMeta):
149
+ 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."""
150
+
151
+ ERROR = "error"
152
+ BACKPRESSURE = "backpressure"
153
+ ALWAYS = "always"
154
+
155
+
156
+ class OutputNewrelicPqControlsTypedDict(TypedDict):
157
+ pass
158
+
159
+
160
+ class OutputNewrelicPqControls(BaseModel):
161
+ pass
162
+
163
+
164
+ class OutputNewrelicTypedDict(TypedDict):
165
+ id: str
166
+ r"""Unique ID for this output"""
167
+ type: OutputNewrelicType
168
+ pipeline: NotRequired[str]
169
+ r"""Pipeline to process data before sending out to this output"""
170
+ system_fields: NotRequired[List[str]]
171
+ r"""Fields to automatically add to events, such as cribl_pipe. Supports wildcards."""
172
+ environment: NotRequired[str]
173
+ r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
174
+ streamtags: NotRequired[List[str]]
175
+ r"""Tags for filtering and grouping in @{product}"""
176
+ region: NotRequired[OutputNewrelicRegion]
177
+ r"""Which New Relic region endpoint to use."""
178
+ log_type: NotRequired[str]
179
+ r"""Name of the logtype to send with events, e.g.: observability, access_log. The event's 'sourcetype' field (if set) will override this value."""
180
+ message_field: NotRequired[str]
181
+ r"""Name of field to send as log message value. If not present, event will be serialized and sent as JSON."""
182
+ metadata: NotRequired[List[OutputNewrelicMetadatumTypedDict]]
183
+ r"""Fields to add to events from this input"""
184
+ concurrency: NotRequired[float]
185
+ r"""Maximum number of ongoing requests before blocking"""
186
+ max_payload_size_kb: NotRequired[float]
187
+ r"""Maximum size, in KB, of the request body"""
188
+ max_payload_events: NotRequired[float]
189
+ r"""Maximum number of events to include in the request body. Default is 0 (unlimited)."""
190
+ compress: NotRequired[bool]
191
+ r"""Compress the payload body before sending"""
192
+ reject_unauthorized: NotRequired[bool]
193
+ r"""Reject certificates not authorized by a CA in the CA certificate path or by another trusted CA (such as the system's).
194
+ Enabled by default. When this setting is also present in TLS Settings (Client Side),
195
+ that value will take precedence.
196
+ """
197
+ timeout_sec: NotRequired[float]
198
+ r"""Amount of time, in seconds, to wait for a request to complete before canceling it"""
199
+ flush_period_sec: NotRequired[float]
200
+ r"""Maximum time between requests. Small values could cause the payload size to be smaller than the configured Body size limit."""
201
+ extra_http_headers: NotRequired[List[OutputNewrelicExtraHTTPHeaderTypedDict]]
202
+ r"""Headers to add to all events"""
203
+ use_round_robin_dns: NotRequired[bool]
204
+ 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."""
205
+ failed_request_logging_mode: NotRequired[OutputNewrelicFailedRequestLoggingMode]
206
+ r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
207
+ safe_headers: NotRequired[List[str]]
208
+ r"""List of headers that are safe to log in plain text"""
209
+ response_retry_settings: NotRequired[
210
+ List[OutputNewrelicResponseRetrySettingTypedDict]
211
+ ]
212
+ r"""Automatically retry after unsuccessful response status codes, such as 429 (Too Many Requests) or 503 (Service Unavailable)"""
213
+ timeout_retry_settings: NotRequired[OutputNewrelicTimeoutRetrySettingsTypedDict]
214
+ response_honor_retry_after_header: NotRequired[bool]
215
+ 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."""
216
+ on_backpressure: NotRequired[OutputNewrelicBackpressureBehavior]
217
+ r"""How to handle events when all receivers are exerting backpressure"""
218
+ auth_type: NotRequired[OutputNewrelicAuthenticationMethod]
219
+ r"""Enter API key directly, or select a stored secret"""
220
+ total_memory_limit_kb: NotRequired[float]
221
+ r"""Maximum total size of the batches waiting to be sent. If left blank, defaults to 5 times the max body size (if set). If 0, no limit is enforced."""
222
+ description: NotRequired[str]
223
+ custom_url: NotRequired[str]
224
+ pq_max_file_size: NotRequired[str]
225
+ r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
226
+ pq_max_size: NotRequired[str]
227
+ 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."""
228
+ pq_path: NotRequired[str]
229
+ r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/<output-id>."""
230
+ pq_compress: NotRequired[OutputNewrelicCompression]
231
+ r"""Codec to use to compress the persisted data"""
232
+ pq_on_backpressure: NotRequired[OutputNewrelicQueueFullBehavior]
233
+ 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."""
234
+ pq_mode: NotRequired[OutputNewrelicMode]
235
+ 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."""
236
+ pq_controls: NotRequired[OutputNewrelicPqControlsTypedDict]
237
+ api_key: NotRequired[str]
238
+ r"""New Relic API key. Can be overridden using __newRelic_apiKey field."""
239
+ text_secret: NotRequired[str]
240
+ r"""Select or create a stored text secret"""
241
+
242
+
243
+ class OutputNewrelic(BaseModel):
244
+ id: str
245
+ r"""Unique ID for this output"""
246
+
247
+ type: Annotated[OutputNewrelicType, PlainValidator(validate_open_enum(False))]
248
+
249
+ pipeline: Optional[str] = None
250
+ r"""Pipeline to process data before sending out to this output"""
251
+
252
+ system_fields: Annotated[
253
+ Optional[List[str]], pydantic.Field(alias="systemFields")
254
+ ] = None
255
+ r"""Fields to automatically add to events, such as cribl_pipe. Supports wildcards."""
256
+
257
+ environment: Optional[str] = None
258
+ r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
259
+
260
+ streamtags: Optional[List[str]] = None
261
+ r"""Tags for filtering and grouping in @{product}"""
262
+
263
+ region: Annotated[
264
+ Optional[OutputNewrelicRegion], PlainValidator(validate_open_enum(False))
265
+ ] = OutputNewrelicRegion.US
266
+ r"""Which New Relic region endpoint to use."""
267
+
268
+ log_type: Annotated[Optional[str], pydantic.Field(alias="logType")] = ""
269
+ r"""Name of the logtype to send with events, e.g.: observability, access_log. The event's 'sourcetype' field (if set) will override this value."""
270
+
271
+ message_field: Annotated[Optional[str], pydantic.Field(alias="messageField")] = ""
272
+ r"""Name of field to send as log message value. If not present, event will be serialized and sent as JSON."""
273
+
274
+ metadata: Optional[List[OutputNewrelicMetadatum]] = None
275
+ r"""Fields to add to events from this input"""
276
+
277
+ concurrency: Optional[float] = 5
278
+ r"""Maximum number of ongoing requests before blocking"""
279
+
280
+ max_payload_size_kb: Annotated[
281
+ Optional[float], pydantic.Field(alias="maxPayloadSizeKB")
282
+ ] = 1024
283
+ r"""Maximum size, in KB, of the request body"""
284
+
285
+ max_payload_events: Annotated[
286
+ Optional[float], pydantic.Field(alias="maxPayloadEvents")
287
+ ] = 0
288
+ r"""Maximum number of events to include in the request body. Default is 0 (unlimited)."""
289
+
290
+ compress: Optional[bool] = True
291
+ r"""Compress the payload body before sending"""
292
+
293
+ reject_unauthorized: Annotated[
294
+ Optional[bool], pydantic.Field(alias="rejectUnauthorized")
295
+ ] = True
296
+ r"""Reject certificates not authorized by a CA in the CA certificate path or by another trusted CA (such as the system's).
297
+ Enabled by default. When this setting is also present in TLS Settings (Client Side),
298
+ that value will take precedence.
299
+ """
300
+
301
+ timeout_sec: Annotated[Optional[float], pydantic.Field(alias="timeoutSec")] = 30
302
+ r"""Amount of time, in seconds, to wait for a request to complete before canceling it"""
303
+
304
+ flush_period_sec: Annotated[
305
+ Optional[float], pydantic.Field(alias="flushPeriodSec")
306
+ ] = 1
307
+ r"""Maximum time between requests. Small values could cause the payload size to be smaller than the configured Body size limit."""
308
+
309
+ extra_http_headers: Annotated[
310
+ Optional[List[OutputNewrelicExtraHTTPHeader]],
311
+ pydantic.Field(alias="extraHttpHeaders"),
312
+ ] = None
313
+ r"""Headers to add to all events"""
314
+
315
+ use_round_robin_dns: Annotated[
316
+ Optional[bool], pydantic.Field(alias="useRoundRobinDns")
317
+ ] = False
318
+ 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."""
319
+
320
+ failed_request_logging_mode: Annotated[
321
+ Annotated[
322
+ Optional[OutputNewrelicFailedRequestLoggingMode],
323
+ PlainValidator(validate_open_enum(False)),
324
+ ],
325
+ pydantic.Field(alias="failedRequestLoggingMode"),
326
+ ] = OutputNewrelicFailedRequestLoggingMode.NONE
327
+ r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
328
+
329
+ safe_headers: Annotated[
330
+ Optional[List[str]], pydantic.Field(alias="safeHeaders")
331
+ ] = None
332
+ r"""List of headers that are safe to log in plain text"""
333
+
334
+ response_retry_settings: Annotated[
335
+ Optional[List[OutputNewrelicResponseRetrySetting]],
336
+ pydantic.Field(alias="responseRetrySettings"),
337
+ ] = None
338
+ r"""Automatically retry after unsuccessful response status codes, such as 429 (Too Many Requests) or 503 (Service Unavailable)"""
339
+
340
+ timeout_retry_settings: Annotated[
341
+ Optional[OutputNewrelicTimeoutRetrySettings],
342
+ pydantic.Field(alias="timeoutRetrySettings"),
343
+ ] = None
344
+
345
+ response_honor_retry_after_header: Annotated[
346
+ Optional[bool], pydantic.Field(alias="responseHonorRetryAfterHeader")
347
+ ] = False
348
+ 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."""
349
+
350
+ on_backpressure: Annotated[
351
+ Annotated[
352
+ Optional[OutputNewrelicBackpressureBehavior],
353
+ PlainValidator(validate_open_enum(False)),
354
+ ],
355
+ pydantic.Field(alias="onBackpressure"),
356
+ ] = OutputNewrelicBackpressureBehavior.BLOCK
357
+ r"""How to handle events when all receivers are exerting backpressure"""
358
+
359
+ auth_type: Annotated[
360
+ Annotated[
361
+ Optional[OutputNewrelicAuthenticationMethod],
362
+ PlainValidator(validate_open_enum(False)),
363
+ ],
364
+ pydantic.Field(alias="authType"),
365
+ ] = OutputNewrelicAuthenticationMethod.MANUAL
366
+ r"""Enter API key directly, or select a stored secret"""
367
+
368
+ total_memory_limit_kb: Annotated[
369
+ Optional[float], pydantic.Field(alias="totalMemoryLimitKB")
370
+ ] = None
371
+ r"""Maximum total size of the batches waiting to be sent. If left blank, defaults to 5 times the max body size (if set). If 0, no limit is enforced."""
372
+
373
+ description: Optional[str] = None
374
+
375
+ custom_url: Annotated[Optional[str], pydantic.Field(alias="customUrl")] = None
376
+
377
+ pq_max_file_size: Annotated[
378
+ Optional[str], pydantic.Field(alias="pqMaxFileSize")
379
+ ] = "1 MB"
380
+ r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
381
+
382
+ pq_max_size: Annotated[Optional[str], pydantic.Field(alias="pqMaxSize")] = "5GB"
383
+ 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."""
384
+
385
+ pq_path: Annotated[Optional[str], pydantic.Field(alias="pqPath")] = (
386
+ "$CRIBL_HOME/state/queues"
387
+ )
388
+ r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/<output-id>."""
389
+
390
+ pq_compress: Annotated[
391
+ Annotated[
392
+ Optional[OutputNewrelicCompression],
393
+ PlainValidator(validate_open_enum(False)),
394
+ ],
395
+ pydantic.Field(alias="pqCompress"),
396
+ ] = OutputNewrelicCompression.NONE
397
+ r"""Codec to use to compress the persisted data"""
398
+
399
+ pq_on_backpressure: Annotated[
400
+ Annotated[
401
+ Optional[OutputNewrelicQueueFullBehavior],
402
+ PlainValidator(validate_open_enum(False)),
403
+ ],
404
+ pydantic.Field(alias="pqOnBackpressure"),
405
+ ] = OutputNewrelicQueueFullBehavior.BLOCK
406
+ 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."""
407
+
408
+ pq_mode: Annotated[
409
+ Annotated[
410
+ Optional[OutputNewrelicMode], PlainValidator(validate_open_enum(False))
411
+ ],
412
+ pydantic.Field(alias="pqMode"),
413
+ ] = OutputNewrelicMode.ERROR
414
+ 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."""
415
+
416
+ pq_controls: Annotated[
417
+ Optional[OutputNewrelicPqControls], pydantic.Field(alias="pqControls")
418
+ ] = None
419
+
420
+ api_key: Annotated[Optional[str], pydantic.Field(alias="apiKey")] = None
421
+ r"""New Relic API key. Can be overridden using __newRelic_apiKey field."""
422
+
423
+ text_secret: Annotated[Optional[str], pydantic.Field(alias="textSecret")] = None
424
+ r"""Select or create a stored text secret"""