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,486 @@
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 OutputDynatraceOtlpType(str, Enum, metaclass=utils.OpenEnumMeta):
15
+ DYNATRACE_OTLP = "dynatrace_otlp"
16
+
17
+
18
+ class OutputDynatraceOtlpProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
19
+ r"""Select a transport option for Dynatrace"""
20
+
21
+ HTTP = "http"
22
+
23
+
24
+ class OutputDynatraceOTLPOTLPVersion(str, Enum, metaclass=utils.OpenEnumMeta):
25
+ r"""The version of OTLP Protobuf definitions to use when structuring data to send"""
26
+
27
+ ONE_DOT_3_DOT_1 = "1.3.1"
28
+
29
+
30
+ class OutputDynatraceOtlpCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
31
+ r"""Type of compression to apply to messages sent to the OpenTelemetry endpoint"""
32
+
33
+ NONE = "none"
34
+ DEFLATE = "deflate"
35
+ GZIP = "gzip"
36
+
37
+
38
+ class OutputDynatraceOtlpHTTPCompressCompression(
39
+ str, Enum, metaclass=utils.OpenEnumMeta
40
+ ):
41
+ r"""Type of compression to apply to messages sent to the OpenTelemetry endpoint"""
42
+
43
+ NONE = "none"
44
+ GZIP = "gzip"
45
+
46
+
47
+ class OutputDynatraceOtlpMetadatumTypedDict(TypedDict):
48
+ value: str
49
+ key: NotRequired[str]
50
+
51
+
52
+ class OutputDynatraceOtlpMetadatum(BaseModel):
53
+ value: str
54
+
55
+ key: Optional[str] = ""
56
+
57
+
58
+ class OutputDynatraceOtlpFailedRequestLoggingMode(
59
+ str, Enum, metaclass=utils.OpenEnumMeta
60
+ ):
61
+ r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
62
+
63
+ PAYLOAD = "payload"
64
+ PAYLOAD_AND_HEADERS = "payloadAndHeaders"
65
+ NONE = "none"
66
+
67
+
68
+ class EndpointType(str, Enum, metaclass=utils.OpenEnumMeta):
69
+ r"""Select the type of Dynatrace endpoint configured"""
70
+
71
+ SAAS = "saas"
72
+ AG = "ag"
73
+
74
+
75
+ class OutputDynatraceOtlpBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
76
+ r"""How to handle events when all receivers are exerting backpressure"""
77
+
78
+ BLOCK = "block"
79
+ DROP = "drop"
80
+ QUEUE = "queue"
81
+
82
+
83
+ class OutputDynatraceOtlpExtraHTTPHeaderTypedDict(TypedDict):
84
+ value: str
85
+ name: NotRequired[str]
86
+
87
+
88
+ class OutputDynatraceOtlpExtraHTTPHeader(BaseModel):
89
+ value: str
90
+
91
+ name: Optional[str] = None
92
+
93
+
94
+ class OutputDynatraceOtlpResponseRetrySettingTypedDict(TypedDict):
95
+ http_status: float
96
+ r"""The HTTP response status code that will trigger retries"""
97
+ initial_backoff: NotRequired[float]
98
+ r"""How long, in milliseconds, Cribl Stream should wait before initiating backoff. Maximum interval is 600,000 ms (10 minutes)."""
99
+ backoff_rate: NotRequired[float]
100
+ 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."""
101
+ max_backoff: NotRequired[float]
102
+ 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)."""
103
+
104
+
105
+ class OutputDynatraceOtlpResponseRetrySetting(BaseModel):
106
+ http_status: Annotated[float, pydantic.Field(alias="httpStatus")]
107
+ r"""The HTTP response status code that will trigger retries"""
108
+
109
+ initial_backoff: Annotated[
110
+ Optional[float], pydantic.Field(alias="initialBackoff")
111
+ ] = 1000
112
+ r"""How long, in milliseconds, Cribl Stream should wait before initiating backoff. Maximum interval is 600,000 ms (10 minutes)."""
113
+
114
+ backoff_rate: Annotated[Optional[float], pydantic.Field(alias="backoffRate")] = 2
115
+ 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."""
116
+
117
+ max_backoff: Annotated[Optional[float], pydantic.Field(alias="maxBackoff")] = 10000
118
+ 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)."""
119
+
120
+
121
+ class OutputDynatraceOtlpTimeoutRetrySettingsTypedDict(TypedDict):
122
+ timeout_retry: NotRequired[bool]
123
+ initial_backoff: NotRequired[float]
124
+ r"""How long, in milliseconds, Cribl Stream should wait before initiating backoff. Maximum interval is 600,000 ms (10 minutes)."""
125
+ backoff_rate: NotRequired[float]
126
+ 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."""
127
+ max_backoff: NotRequired[float]
128
+ 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)."""
129
+
130
+
131
+ class OutputDynatraceOtlpTimeoutRetrySettings(BaseModel):
132
+ timeout_retry: Annotated[Optional[bool], pydantic.Field(alias="timeoutRetry")] = (
133
+ False
134
+ )
135
+
136
+ initial_backoff: Annotated[
137
+ Optional[float], pydantic.Field(alias="initialBackoff")
138
+ ] = 1000
139
+ r"""How long, in milliseconds, Cribl Stream should wait before initiating backoff. Maximum interval is 600,000 ms (10 minutes)."""
140
+
141
+ backoff_rate: Annotated[Optional[float], pydantic.Field(alias="backoffRate")] = 2
142
+ 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."""
143
+
144
+ max_backoff: Annotated[Optional[float], pydantic.Field(alias="maxBackoff")] = 10000
145
+ 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)."""
146
+
147
+
148
+ class OutputDynatraceOtlpPqCompressCompression(str, Enum, metaclass=utils.OpenEnumMeta):
149
+ r"""Codec to use to compress the persisted data"""
150
+
151
+ NONE = "none"
152
+ GZIP = "gzip"
153
+
154
+
155
+ class OutputDynatraceOtlpQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
156
+ 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."""
157
+
158
+ BLOCK = "block"
159
+ DROP = "drop"
160
+
161
+
162
+ class OutputDynatraceOtlpMode(str, Enum, metaclass=utils.OpenEnumMeta):
163
+ 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."""
164
+
165
+ ERROR = "error"
166
+ BACKPRESSURE = "backpressure"
167
+ ALWAYS = "always"
168
+
169
+
170
+ class OutputDynatraceOtlpPqControlsTypedDict(TypedDict):
171
+ pass
172
+
173
+
174
+ class OutputDynatraceOtlpPqControls(BaseModel):
175
+ pass
176
+
177
+
178
+ class OutputDynatraceOtlpTypedDict(TypedDict):
179
+ token_secret: str
180
+ r"""Select or create a stored text secret"""
181
+ id: NotRequired[str]
182
+ r"""Unique ID for this output"""
183
+ type: NotRequired[OutputDynatraceOtlpType]
184
+ pipeline: NotRequired[str]
185
+ r"""Pipeline to process data before sending out to this output"""
186
+ system_fields: NotRequired[List[str]]
187
+ r"""Fields to automatically add to events, such as cribl_pipe. Supports wildcards."""
188
+ environment: NotRequired[str]
189
+ r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
190
+ streamtags: NotRequired[List[str]]
191
+ r"""Tags for filtering and grouping in @{product}"""
192
+ protocol: NotRequired[OutputDynatraceOtlpProtocol]
193
+ r"""Select a transport option for Dynatrace"""
194
+ endpoint: NotRequired[str]
195
+ r"""The endpoint where Dynatrace events will be sent. Enter any valid URL or an IP address (IPv4 or IPv6; enclose IPv6 addresses in square brackets)"""
196
+ otlp_version: NotRequired[OutputDynatraceOTLPOTLPVersion]
197
+ r"""The version of OTLP Protobuf definitions to use when structuring data to send"""
198
+ compress: NotRequired[OutputDynatraceOtlpCompressCompression]
199
+ r"""Type of compression to apply to messages sent to the OpenTelemetry endpoint"""
200
+ http_compress: NotRequired[OutputDynatraceOtlpHTTPCompressCompression]
201
+ r"""Type of compression to apply to messages sent to the OpenTelemetry endpoint"""
202
+ http_traces_endpoint_override: NotRequired[str]
203
+ r"""If you want to send traces to the default `{endpoint}/v1/traces` endpoint, leave this field empty; otherwise, specify the desired endpoint"""
204
+ http_metrics_endpoint_override: NotRequired[str]
205
+ r"""If you want to send metrics to the default `{endpoint}/v1/metrics` endpoint, leave this field empty; otherwise, specify the desired endpoint"""
206
+ http_logs_endpoint_override: NotRequired[str]
207
+ r"""If you want to send logs to the default `{endpoint}/v1/logs` endpoint, leave this field empty; otherwise, specify the desired endpoint"""
208
+ metadata: NotRequired[List[OutputDynatraceOtlpMetadatumTypedDict]]
209
+ r"""List of key-value pairs to send with each gRPC request. Value supports JavaScript expressions that are evaluated just once, when the destination gets started. To pass credentials as metadata, use 'C.Secret'."""
210
+ concurrency: NotRequired[float]
211
+ r"""Maximum number of ongoing requests before blocking"""
212
+ max_payload_size_kb: NotRequired[float]
213
+ r"""Maximum size (in KB) of the request body. The maximum payload size is 4 MB. If this limit is exceeded, the entire OTLP message is dropped"""
214
+ timeout_sec: NotRequired[float]
215
+ r"""Amount of time, in seconds, to wait for a request to complete before canceling it"""
216
+ flush_period_sec: NotRequired[float]
217
+ r"""Maximum time between requests. Small values could cause the payload size to be smaller than the configured Body size limit."""
218
+ failed_request_logging_mode: NotRequired[
219
+ OutputDynatraceOtlpFailedRequestLoggingMode
220
+ ]
221
+ r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
222
+ connection_timeout: NotRequired[float]
223
+ r"""Amount of time (milliseconds) to wait for the connection to establish before retrying"""
224
+ keep_alive_time: NotRequired[float]
225
+ r"""How often the sender should ping the peer to keep the connection open"""
226
+ keep_alive: NotRequired[bool]
227
+ r"""Disable to close the connection immediately after sending the outgoing request"""
228
+ endpoint_type: NotRequired[EndpointType]
229
+ r"""Select the type of Dynatrace endpoint configured"""
230
+ auth_token_name: NotRequired[str]
231
+ on_backpressure: NotRequired[OutputDynatraceOtlpBackpressureBehavior]
232
+ r"""How to handle events when all receivers are exerting backpressure"""
233
+ description: NotRequired[str]
234
+ reject_unauthorized: NotRequired[bool]
235
+ r"""Reject certificates not authorized by a CA in the CA certificate path or by another trusted CA (such as the system's).
236
+ Enabled by default. When this setting is also present in TLS Settings (Client Side),
237
+ that value will take precedence.
238
+ """
239
+ use_round_robin_dns: NotRequired[bool]
240
+ 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."""
241
+ extra_http_headers: NotRequired[List[OutputDynatraceOtlpExtraHTTPHeaderTypedDict]]
242
+ r"""Headers to add to all events"""
243
+ safe_headers: NotRequired[List[str]]
244
+ r"""List of headers that are safe to log in plain text"""
245
+ response_retry_settings: NotRequired[
246
+ List[OutputDynatraceOtlpResponseRetrySettingTypedDict]
247
+ ]
248
+ r"""Automatically retry after unsuccessful response status codes, such as 429 (Too Many Requests) or 503 (Service Unavailable)"""
249
+ timeout_retry_settings: NotRequired[
250
+ OutputDynatraceOtlpTimeoutRetrySettingsTypedDict
251
+ ]
252
+ response_honor_retry_after_header: NotRequired[bool]
253
+ 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."""
254
+ pq_max_file_size: NotRequired[str]
255
+ r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
256
+ pq_max_size: NotRequired[str]
257
+ 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."""
258
+ pq_path: NotRequired[str]
259
+ r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/<output-id>."""
260
+ pq_compress: NotRequired[OutputDynatraceOtlpPqCompressCompression]
261
+ r"""Codec to use to compress the persisted data"""
262
+ pq_on_backpressure: NotRequired[OutputDynatraceOtlpQueueFullBehavior]
263
+ 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."""
264
+ pq_mode: NotRequired[OutputDynatraceOtlpMode]
265
+ 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."""
266
+ pq_controls: NotRequired[OutputDynatraceOtlpPqControlsTypedDict]
267
+
268
+
269
+ class OutputDynatraceOtlp(BaseModel):
270
+ token_secret: Annotated[str, pydantic.Field(alias="tokenSecret")]
271
+ r"""Select or create a stored text secret"""
272
+
273
+ id: Optional[str] = None
274
+ r"""Unique ID for this output"""
275
+
276
+ type: Annotated[
277
+ Optional[OutputDynatraceOtlpType], PlainValidator(validate_open_enum(False))
278
+ ] = None
279
+
280
+ pipeline: Optional[str] = None
281
+ r"""Pipeline to process data before sending out to this output"""
282
+
283
+ system_fields: Annotated[
284
+ Optional[List[str]], pydantic.Field(alias="systemFields")
285
+ ] = None
286
+ r"""Fields to automatically add to events, such as cribl_pipe. Supports wildcards."""
287
+
288
+ environment: Optional[str] = None
289
+ r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
290
+
291
+ streamtags: Optional[List[str]] = None
292
+ r"""Tags for filtering and grouping in @{product}"""
293
+
294
+ protocol: Annotated[
295
+ Optional[OutputDynatraceOtlpProtocol], PlainValidator(validate_open_enum(False))
296
+ ] = OutputDynatraceOtlpProtocol.HTTP
297
+ r"""Select a transport option for Dynatrace"""
298
+
299
+ endpoint: Optional[str] = (
300
+ "https://{your-environment-id}.live.dynatrace.com/api/v2/otlp"
301
+ )
302
+ r"""The endpoint where Dynatrace events will be sent. Enter any valid URL or an IP address (IPv4 or IPv6; enclose IPv6 addresses in square brackets)"""
303
+
304
+ otlp_version: Annotated[
305
+ Annotated[
306
+ Optional[OutputDynatraceOTLPOTLPVersion],
307
+ PlainValidator(validate_open_enum(False)),
308
+ ],
309
+ pydantic.Field(alias="otlpVersion"),
310
+ ] = OutputDynatraceOTLPOTLPVersion.ONE_DOT_3_DOT_1
311
+ r"""The version of OTLP Protobuf definitions to use when structuring data to send"""
312
+
313
+ compress: Annotated[
314
+ Optional[OutputDynatraceOtlpCompressCompression],
315
+ PlainValidator(validate_open_enum(False)),
316
+ ] = OutputDynatraceOtlpCompressCompression.GZIP
317
+ r"""Type of compression to apply to messages sent to the OpenTelemetry endpoint"""
318
+
319
+ http_compress: Annotated[
320
+ Annotated[
321
+ Optional[OutputDynatraceOtlpHTTPCompressCompression],
322
+ PlainValidator(validate_open_enum(False)),
323
+ ],
324
+ pydantic.Field(alias="httpCompress"),
325
+ ] = OutputDynatraceOtlpHTTPCompressCompression.GZIP
326
+ r"""Type of compression to apply to messages sent to the OpenTelemetry endpoint"""
327
+
328
+ http_traces_endpoint_override: Annotated[
329
+ Optional[str], pydantic.Field(alias="httpTracesEndpointOverride")
330
+ ] = None
331
+ r"""If you want to send traces to the default `{endpoint}/v1/traces` endpoint, leave this field empty; otherwise, specify the desired endpoint"""
332
+
333
+ http_metrics_endpoint_override: Annotated[
334
+ Optional[str], pydantic.Field(alias="httpMetricsEndpointOverride")
335
+ ] = None
336
+ r"""If you want to send metrics to the default `{endpoint}/v1/metrics` endpoint, leave this field empty; otherwise, specify the desired endpoint"""
337
+
338
+ http_logs_endpoint_override: Annotated[
339
+ Optional[str], pydantic.Field(alias="httpLogsEndpointOverride")
340
+ ] = None
341
+ r"""If you want to send logs to the default `{endpoint}/v1/logs` endpoint, leave this field empty; otherwise, specify the desired endpoint"""
342
+
343
+ metadata: Optional[List[OutputDynatraceOtlpMetadatum]] = None
344
+ r"""List of key-value pairs to send with each gRPC request. Value supports JavaScript expressions that are evaluated just once, when the destination gets started. To pass credentials as metadata, use 'C.Secret'."""
345
+
346
+ concurrency: Optional[float] = 5
347
+ r"""Maximum number of ongoing requests before blocking"""
348
+
349
+ max_payload_size_kb: Annotated[
350
+ Optional[float], pydantic.Field(alias="maxPayloadSizeKB")
351
+ ] = 2048
352
+ r"""Maximum size (in KB) of the request body. The maximum payload size is 4 MB. If this limit is exceeded, the entire OTLP message is dropped"""
353
+
354
+ timeout_sec: Annotated[Optional[float], pydantic.Field(alias="timeoutSec")] = 30
355
+ r"""Amount of time, in seconds, to wait for a request to complete before canceling it"""
356
+
357
+ flush_period_sec: Annotated[
358
+ Optional[float], pydantic.Field(alias="flushPeriodSec")
359
+ ] = 1
360
+ r"""Maximum time between requests. Small values could cause the payload size to be smaller than the configured Body size limit."""
361
+
362
+ failed_request_logging_mode: Annotated[
363
+ Annotated[
364
+ Optional[OutputDynatraceOtlpFailedRequestLoggingMode],
365
+ PlainValidator(validate_open_enum(False)),
366
+ ],
367
+ pydantic.Field(alias="failedRequestLoggingMode"),
368
+ ] = OutputDynatraceOtlpFailedRequestLoggingMode.NONE
369
+ r"""Data to log when a request fails. All headers are redacted by default, unless listed as safe headers below."""
370
+
371
+ connection_timeout: Annotated[
372
+ Optional[float], pydantic.Field(alias="connectionTimeout")
373
+ ] = 10000
374
+ r"""Amount of time (milliseconds) to wait for the connection to establish before retrying"""
375
+
376
+ keep_alive_time: Annotated[
377
+ Optional[float], pydantic.Field(alias="keepAliveTime")
378
+ ] = 30
379
+ r"""How often the sender should ping the peer to keep the connection open"""
380
+
381
+ keep_alive: Annotated[Optional[bool], pydantic.Field(alias="keepAlive")] = True
382
+ r"""Disable to close the connection immediately after sending the outgoing request"""
383
+
384
+ endpoint_type: Annotated[
385
+ Annotated[Optional[EndpointType], PlainValidator(validate_open_enum(False))],
386
+ pydantic.Field(alias="endpointType"),
387
+ ] = EndpointType.SAAS
388
+ r"""Select the type of Dynatrace endpoint configured"""
389
+
390
+ auth_token_name: Annotated[Optional[str], pydantic.Field(alias="authTokenName")] = (
391
+ "Authorization"
392
+ )
393
+
394
+ on_backpressure: Annotated[
395
+ Annotated[
396
+ Optional[OutputDynatraceOtlpBackpressureBehavior],
397
+ PlainValidator(validate_open_enum(False)),
398
+ ],
399
+ pydantic.Field(alias="onBackpressure"),
400
+ ] = OutputDynatraceOtlpBackpressureBehavior.BLOCK
401
+ r"""How to handle events when all receivers are exerting backpressure"""
402
+
403
+ description: Optional[str] = None
404
+
405
+ reject_unauthorized: Annotated[
406
+ Optional[bool], pydantic.Field(alias="rejectUnauthorized")
407
+ ] = True
408
+ r"""Reject certificates not authorized by a CA in the CA certificate path or by another trusted CA (such as the system's).
409
+ Enabled by default. When this setting is also present in TLS Settings (Client Side),
410
+ that value will take precedence.
411
+ """
412
+
413
+ use_round_robin_dns: Annotated[
414
+ Optional[bool], pydantic.Field(alias="useRoundRobinDns")
415
+ ] = False
416
+ 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."""
417
+
418
+ extra_http_headers: Annotated[
419
+ Optional[List[OutputDynatraceOtlpExtraHTTPHeader]],
420
+ pydantic.Field(alias="extraHttpHeaders"),
421
+ ] = None
422
+ r"""Headers to add to all events"""
423
+
424
+ safe_headers: Annotated[
425
+ Optional[List[str]], pydantic.Field(alias="safeHeaders")
426
+ ] = None
427
+ r"""List of headers that are safe to log in plain text"""
428
+
429
+ response_retry_settings: Annotated[
430
+ Optional[List[OutputDynatraceOtlpResponseRetrySetting]],
431
+ pydantic.Field(alias="responseRetrySettings"),
432
+ ] = None
433
+ r"""Automatically retry after unsuccessful response status codes, such as 429 (Too Many Requests) or 503 (Service Unavailable)"""
434
+
435
+ timeout_retry_settings: Annotated[
436
+ Optional[OutputDynatraceOtlpTimeoutRetrySettings],
437
+ pydantic.Field(alias="timeoutRetrySettings"),
438
+ ] = None
439
+
440
+ response_honor_retry_after_header: Annotated[
441
+ Optional[bool], pydantic.Field(alias="responseHonorRetryAfterHeader")
442
+ ] = False
443
+ 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."""
444
+
445
+ pq_max_file_size: Annotated[
446
+ Optional[str], pydantic.Field(alias="pqMaxFileSize")
447
+ ] = "1 MB"
448
+ r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
449
+
450
+ pq_max_size: Annotated[Optional[str], pydantic.Field(alias="pqMaxSize")] = "5GB"
451
+ 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."""
452
+
453
+ pq_path: Annotated[Optional[str], pydantic.Field(alias="pqPath")] = (
454
+ "$CRIBL_HOME/state/queues"
455
+ )
456
+ r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/<output-id>."""
457
+
458
+ pq_compress: Annotated[
459
+ Annotated[
460
+ Optional[OutputDynatraceOtlpPqCompressCompression],
461
+ PlainValidator(validate_open_enum(False)),
462
+ ],
463
+ pydantic.Field(alias="pqCompress"),
464
+ ] = OutputDynatraceOtlpPqCompressCompression.NONE
465
+ r"""Codec to use to compress the persisted data"""
466
+
467
+ pq_on_backpressure: Annotated[
468
+ Annotated[
469
+ Optional[OutputDynatraceOtlpQueueFullBehavior],
470
+ PlainValidator(validate_open_enum(False)),
471
+ ],
472
+ pydantic.Field(alias="pqOnBackpressure"),
473
+ ] = OutputDynatraceOtlpQueueFullBehavior.BLOCK
474
+ 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."""
475
+
476
+ pq_mode: Annotated[
477
+ Annotated[
478
+ Optional[OutputDynatraceOtlpMode], PlainValidator(validate_open_enum(False))
479
+ ],
480
+ pydantic.Field(alias="pqMode"),
481
+ ] = OutputDynatraceOtlpMode.ERROR
482
+ 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."""
483
+
484
+ pq_controls: Annotated[
485
+ Optional[OutputDynatraceOtlpPqControls], pydantic.Field(alias="pqControls")
486
+ ] = None