cribl-control-plane 0.1.0b2__py3-none-any.whl → 0.1.1rc1__py3-none-any.whl

cribl_control_plane/models/inputwindowsmetrics.py

@@ -29,14 +29,18 @@ class InputWindowsMetricsConnection(BaseModel):
 class InputWindowsMetricsPqMode(str, Enum, metaclass=utils.OpenEnumMeta):
     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."""
 
+    # Smart
     SMART = "smart"
+    # Always On
     ALWAYS = "always"
 
 
 class InputWindowsMetricsCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -107,18 +111,26 @@ class InputWindowsMetricsPq(BaseModel):
 class InputWindowsMetricsHostMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select level of detail for host metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
 class InputWindowsMetricsSystemMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of details for system metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
@@ -143,9 +155,13 @@ class InputWindowsMetricsSystem(BaseModel):
 class InputWindowsMetricsCPUMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of details for CPU metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
@@ -179,9 +195,13 @@ class InputWindowsMetricsCPU(BaseModel):
 class InputWindowsMetricsMemoryMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of details for memory metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
@@ -206,9 +226,13 @@ class InputWindowsMetricsMemory(BaseModel):
 class InputWindowsMetricsNetworkMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of details for network metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
@@ -245,9 +269,13 @@ class InputWindowsMetricsNetwork(BaseModel):
 class InputWindowsMetricsDiskMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of details for disk metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 

cribl_control_plane/models/inputwineventlogs.py

@@ -29,14 +29,18 @@ class InputWinEventLogsConnection(BaseModel):
 class InputWinEventLogsMode(str, Enum, metaclass=utils.OpenEnumMeta):
     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."""
 
+    # Smart
     SMART = "smart"
+    # Always On
     ALWAYS = "always"
 
 
 class InputWinEventLogsCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -107,14 +111,18 @@ class InputWinEventLogsPq(BaseModel):
 class ReadMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Read all stored and future event logs, or only future events"""
 
+    # Entire log
     OLDEST = "oldest"
+    # From last entry
     NEWEST = "newest"
 
 
 class EventFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format of individual events"""
 
+    # JSON
     JSON = "json"
+    # XML
     XML = "xml"
 
 

cribl_control_plane/models/inputwiz.py

@@ -29,14 +29,18 @@ class InputWizConnection(BaseModel):
 class InputWizMode(str, Enum, metaclass=utils.OpenEnumMeta):
     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."""
 
+    # Smart
     SMART = "smart"
+    # Always On
     ALWAYS = "always"
 
 
 class InputWizCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -137,8 +141,11 @@ class InputWizMetadatum(BaseModel):
 class InputWizRetryType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The algorithm to use when performing HTTP retries"""
 
+    # Disabled
     NONE = "none"
+    # Backoff
     BACKOFF = "backoff"
+    # Static
     STATIC = "static"
 
 

cribl_control_plane/models/inputwizwebhook.py

@@ -29,14 +29,18 @@ class InputWizWebhookConnection(BaseModel):
 class InputWizWebhookMode(str, Enum, metaclass=utils.OpenEnumMeta):
     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."""
 
+    # Smart
     SMART = "smart"
+    # Always On
     ALWAYS = "always"
 
 
 class InputWizWebhookCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 

cribl_control_plane/models/inputzscalerhec.py

@@ -29,14 +29,18 @@ class InputZscalerHecConnection(BaseModel):
 class InputZscalerHecMode(str, Enum, metaclass=utils.OpenEnumMeta):
     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."""
 
+    # Smart
     SMART = "smart"
+    # Always On
     ALWAYS = "always"
 
 
 class InputZscalerHecCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 

cribl_control_plane/models/jobinfo.py

@@ -4,13 +4,14 @@ from __future__ import annotations
 from .jobstatus import JobStatus, JobStatusTypedDict
 from .runnablejob import RunnableJob, RunnableJobTypedDict
 from cribl_control_plane.types import BaseModel
-from typing import Optional
+from typing import Dict, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
 class JobInfoTypedDict(TypedDict):
     args: RunnableJobTypedDict
     id: str
+    stats: Dict[str, float]
     status: JobStatusTypedDict
     keep: NotRequired[bool]
 
@@ -20,6 +21,8 @@ class JobInfo(BaseModel):
 
     id: str
 
+    stats: Dict[str, float]
+
     status: JobStatus
 
     keep: Optional[bool] = None

cribl_control_plane/models/nodeprovidedinfo.py

@@ -5,7 +5,7 @@ from .hbcriblinfo import HBCriblInfo, HBCriblInfoTypedDict
 from .heartbeatmetadata import HeartbeatMetadata, HeartbeatMetadataTypedDict
 from cribl_control_plane.types import BaseModel
 import pydantic
-from typing import List, Optional, Union
+from typing import Dict, List, Optional, Union
 from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
@@ -128,6 +128,7 @@ class NodeProvidedInfoTypedDict(TypedDict):
     architecture: str
     cpus: float
     cribl: HBCriblInfoTypedDict
+    env: Dict[str, str]
     free_disk_space: float
     hostname: str
     node: str
@@ -152,6 +153,8 @@ class NodeProvidedInfo(BaseModel):
 
     cribl: HBCriblInfo
 
+    env: Dict[str, str]
+
     free_disk_space: Annotated[float, pydantic.Field(alias="freeDiskSpace")]
 
     hostname: str

cribl_control_plane/models/output.py

@@ -8,6 +8,7 @@ from .outputazuredataexplorer import (
 )
 from .outputazureeventhub import OutputAzureEventhub, OutputAzureEventhubTypedDict
 from .outputazurelogs import OutputAzureLogs, OutputAzureLogsTypedDict
+from .outputchronicle import OutputChronicle, OutputChronicleTypedDict
 from .outputclickhouse import OutputClickHouse, OutputClickHouseTypedDict
 from .outputcloudwatch import OutputCloudwatch, OutputCloudwatchTypedDict
 from .outputconfluentcloud import OutputConfluentCloud, OutputConfluentCloudTypedDict
@@ -81,8 +82,10 @@ from .outputtcpjson import OutputTcpjson, OutputTcpjsonTypedDict
 from .outputwavefront import OutputWavefront, OutputWavefrontTypedDict
 from .outputwebhook import OutputWebhook, OutputWebhookTypedDict
 from .outputxsiam import OutputXsiam, OutputXsiamTypedDict
+from cribl_control_plane.utils import get_discriminator
+from pydantic import Discriminator, Tag
 from typing import Union
-from typing_extensions import TypeAliasType
+from typing_extensions import Annotated, TypeAliasType
 
 
 OutputTypedDict = TypeAliasType(
@@ -131,6 +134,7 @@ OutputTypedDict = TypeAliasType(
         OutputSplunkHecTypedDict,
         OutputDynatraceHTTPTypedDict,
         OutputServiceNowTypedDict,
+        OutputChronicleTypedDict,
         OutputDynatraceOtlpTypedDict,
         OutputGoogleChronicleTypedDict,
         OutputElasticTypedDict,
@@ -157,73 +161,74 @@ OutputTypedDict = TypeAliasType(
 )
 
 
-Output = TypeAliasType(
-    "Output",
+Output = Annotated[
     Union[
-        OutputDevnull,
-        OutputDefault,
-        OutputRouter,
-        OutputNetflow,
-        OutputSnmp,
-        OutputDiskSpool,
-        OutputRing,
-        OutputGraphite,
-        OutputStatsdExt,
-        OutputStatsd,
-        OutputGooglePubsub,
-        OutputSplunk,
-        OutputCriblTCP,
-        OutputSns,
-        OutputCloudwatch,
-        OutputAzureEventhub,
-        OutputSignalfx,
-        OutputWavefront,
-        OutputHoneycomb,
-        OutputHumioHec,
-        OutputTcpjson,
-        OutputSumoLogic,
-        OutputCrowdstrikeNextGenSiem,
-        OutputElasticCloud,
-        OutputExabeam,
-        OutputKafka,
-        OutputConfluentCloud,
-        OutputKinesis,
-        OutputDatabricks,
-        OutputNewrelicEvents,
-        OutputAzureLogs,
-        OutputSplunkLb,
-        OutputSyslog,
-        OutputSqs,
-        OutputNewrelic,
-        OutputCriblHTTP,
-        OutputXsiam,
-        OutputFilesystem,
-        OutputDataset,
-        OutputLoki,
-        OutputSplunkHec,
-        OutputDynatraceHTTP,
-        OutputServiceNow,
-        OutputDynatraceOtlp,
-        OutputGoogleChronicle,
-        OutputElastic,
-        OutputDatadog,
-        OutputCriblLake,
-        OutputPrometheus,
-        OutputMsk,
-        OutputSentinelOneAiSiem,
-        OutputSentinel,
-        OutputInfluxdb,
-        OutputGoogleCloudStorage,
-        OutputAzureBlob,
-        OutputOpenTelemetry,
-        OutputMinio,
-        OutputClickHouse,
-        OutputSecurityLake,
-        OutputDlS3,
-        OutputS3,
-        OutputWebhook,
-        OutputAzureDataExplorer,
-        OutputGoogleCloudLogging,
-        OutputGrafanaCloud,
+        Annotated[OutputDefault, Tag("default")],
+        Annotated[OutputWebhook, Tag("webhook")],
+        Annotated[OutputSentinel, Tag("sentinel")],
+        Annotated[OutputDevnull, Tag("devnull")],
+        Annotated[OutputSyslog, Tag("syslog")],
+        Annotated[OutputSplunk, Tag("splunk")],
+        Annotated[OutputSplunkLb, Tag("splunk_lb")],
+        Annotated[OutputSplunkHec, Tag("splunk_hec")],
+        Annotated[OutputTcpjson, Tag("tcpjson")],
+        Annotated[OutputWavefront, Tag("wavefront")],
+        Annotated[OutputSignalfx, Tag("signalfx")],
+        Annotated[OutputFilesystem, Tag("filesystem")],
+        Annotated[OutputS3, Tag("s3")],
+        Annotated[OutputAzureBlob, Tag("azure_blob")],
+        Annotated[OutputAzureDataExplorer, Tag("azure_data_explorer")],
+        Annotated[OutputAzureLogs, Tag("azure_logs")],
+        Annotated[OutputKinesis, Tag("kinesis")],
+        Annotated[OutputHoneycomb, Tag("honeycomb")],
+        Annotated[OutputAzureEventhub, Tag("azure_eventhub")],
+        Annotated[OutputGoogleChronicle, Tag("google_chronicle")],
+        Annotated[OutputGoogleCloudStorage, Tag("google_cloud_storage")],
+        Annotated[OutputGoogleCloudLogging, Tag("google_cloud_logging")],
+        Annotated[OutputGooglePubsub, Tag("google_pubsub")],
+        Annotated[OutputExabeam, Tag("exabeam")],
+        Annotated[OutputKafka, Tag("kafka")],
+        Annotated[OutputConfluentCloud, Tag("confluent_cloud")],
+        Annotated[OutputMsk, Tag("msk")],
+        Annotated[OutputElastic, Tag("elastic")],
+        Annotated[OutputElasticCloud, Tag("elastic_cloud")],
+        Annotated[OutputNewrelic, Tag("newrelic")],
+        Annotated[OutputNewrelicEvents, Tag("newrelic_events")],
+        Annotated[OutputInfluxdb, Tag("influxdb")],
+        Annotated[OutputCloudwatch, Tag("cloudwatch")],
+        Annotated[OutputMinio, Tag("minio")],
+        Annotated[OutputStatsd, Tag("statsd")],
+        Annotated[OutputStatsdExt, Tag("statsd_ext")],
+        Annotated[OutputGraphite, Tag("graphite")],
+        Annotated[OutputRouter, Tag("router")],
+        Annotated[OutputSns, Tag("sns")],
+        Annotated[OutputSqs, Tag("sqs")],
+        Annotated[OutputSnmp, Tag("snmp")],
+        Annotated[OutputSumoLogic, Tag("sumo_logic")],
+        Annotated[OutputDatadog, Tag("datadog")],
+        Annotated[OutputGrafanaCloud, Tag("grafana_cloud")],
+        Annotated[OutputLoki, Tag("loki")],
+        Annotated[OutputPrometheus, Tag("prometheus")],
+        Annotated[OutputRing, Tag("ring")],
+        Annotated[OutputOpenTelemetry, Tag("open_telemetry")],
+        Annotated[OutputServiceNow, Tag("service_now")],
+        Annotated[OutputDataset, Tag("dataset")],
+        Annotated[OutputCriblTCP, Tag("cribl_tcp")],
+        Annotated[OutputCriblHTTP, Tag("cribl_http")],
+        Annotated[OutputHumioHec, Tag("humio_hec")],
+        Annotated[OutputCrowdstrikeNextGenSiem, Tag("crowdstrike_next_gen_siem")],
+        Annotated[OutputDlS3, Tag("dl_s3")],
+        Annotated[OutputSecurityLake, Tag("security_lake")],
+        Annotated[OutputCriblLake, Tag("cribl_lake")],
+        Annotated[OutputDiskSpool, Tag("disk_spool")],
+        Annotated[OutputClickHouse, Tag("click_house")],
+        Annotated[OutputXsiam, Tag("xsiam")],
+        Annotated[OutputNetflow, Tag("netflow")],
+        Annotated[OutputDynatraceHTTP, Tag("dynatrace_http")],
+        Annotated[OutputDynatraceOtlp, Tag("dynatrace_otlp")],
+        Annotated[OutputSentinelOneAiSiem, Tag("sentinel_one_ai_siem")],
+        Annotated[OutputChronicle, Tag("chronicle")],
+        Annotated[OutputDatabricks, Tag("databricks")],
     ],
-)
+    Discriminator(lambda m: get_discriminator(m, "type", "type")),
+]

cribl_control_plane/models/outputazureblob.py

@@ -18,22 +18,29 @@ class OutputAzureBlobType(str, Enum):
 class OutputAzureBlobDataFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format of the output data"""
 
+    # JSON
     JSON = "json"
+    # Raw
     RAW = "raw"
+    # Parquet
     PARQUET = "parquet"
 
 
 class OutputAzureBlobBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
 
 
 class OutputAzureBlobDiskSpaceProtection(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when disk space is below the global 'Min free disk space' limit"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
 
 
@@ -45,10 +52,15 @@ class OutputAzureBlobAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMet
 
 
 class BlobAccessTier(str, Enum, metaclass=utils.OpenEnumMeta):
+    # Default account access tier
     INFERRED = "Inferred"
+    # Hot tier
     HOT = "Hot"
+    # Cool tier
     COOL = "Cool"
+    # Cold tier
     COLD = "Cold"
+    # Archive tier
     ARCHIVE = "Archive"
 
 
@@ -62,23 +74,31 @@ class OutputAzureBlobCompression(str, Enum, metaclass=utils.OpenEnumMeta):
 class OutputAzureBlobCompressionLevel(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Compression level to apply before moving files to final destination"""
 
+    # Best Speed
     BEST_SPEED = "best_speed"
+    # Normal
     NORMAL = "normal"
+    # Best Compression
     BEST_COMPRESSION = "best_compression"
 
 
 class OutputAzureBlobParquetVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Determines which data types are supported and how they are represented"""
 
+    # 1.0
     PARQUET_1_0 = "PARQUET_1_0"
+    # 2.4
     PARQUET_2_4 = "PARQUET_2_4"
+    # 2.6
     PARQUET_2_6 = "PARQUET_2_6"
 
 
 class OutputAzureBlobDataPageVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Serialization format of data pages. Note that some reader implementations use Data page V2's attributes to work more efficiently, while others ignore it."""
 
+    # V1
     DATA_PAGE_V1 = "DATA_PAGE_V1"
+    # V2
     DATA_PAGE_V2 = "DATA_PAGE_V2"
 
 

cribl_control_plane/models/outputazuredataexplorer.py

@@ -16,7 +16,9 @@ class OutputAzureDataExplorerType(str, Enum):
 
 
 class IngestionMode(str, Enum, metaclass=utils.OpenEnumMeta):
+    # Batching
     BATCHING = "batching"
+    # Streaming
     STREAMING = "streaming"
 
 
@@ -33,8 +35,11 @@ class OutputAzureDataExplorerAuthenticationMethod(
 ):
     r"""The type of OAuth 2.0 client credentials grant flow to use"""
 
+    # Client secret
     CLIENT_SECRET = "clientSecret"
+    # Client secret (text secret)
     CLIENT_TEXT_SECRET = "clientTextSecret"
+    # Certificate
     CERTIFICATE = "certificate"
 
 
@@ -55,16 +60,22 @@ class OutputAzureDataExplorerBackpressureBehavior(
 ):
     r"""How to handle events when all receivers are exerting backpressure"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
+    # Persistent Queue
     QUEUE = "queue"
 
 
 class OutputAzureDataExplorerDataFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format of the output data"""
 
+    # JSON
     JSON = "json"
+    # Raw
     RAW = "raw"
+    # Parquet
     PARQUET = "parquet"
 
 
@@ -73,12 +84,16 @@ class OutputAzureDataExplorerDiskSpaceProtection(
 ):
     r"""How to handle events when disk space is below the global 'Min free disk space' limit"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
 
 
 class PrefixOptional(str, Enum, metaclass=utils.OpenEnumMeta):
+    # drop-by
     DROP_BY = "dropBy"
+    # ingest-by
     INGEST_BY = "ingestBy"
 
 
@@ -106,16 +121,22 @@ class IngestIfNotExist(BaseModel):
 class ReportLevel(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Level of ingestion status reporting. Defaults to FailuresOnly."""
 
+    # FailuresOnly
     FAILURES_ONLY = "failuresOnly"
+    # DoNotReport
     DO_NOT_REPORT = "doNotReport"
+    # FailuresAndSuccesses
     FAILURES_AND_SUCCESSES = "failuresAndSuccesses"
 
 
 class ReportMethod(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Target of the ingestion status reporting. Defaults to Queue."""
 
+    # Queue
     QUEUE = "queue"
+    # Table
     TABLE = "table"
+    # QueueAndTable
     QUEUE_AND_TABLE = "queueAndTable"
 
 
@@ -198,22 +219,29 @@ class OutputAzureDataExplorerPqCompressCompression(
 ):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
 class OutputAzureDataExplorerQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     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."""
 
+    # Block
     BLOCK = "block"
+    # Drop new data
     DROP = "drop"
 
 
 class OutputAzureDataExplorerMode(str, Enum, metaclass=utils.OpenEnumMeta):
     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."""
 
+    # Error
     ERROR = "error"
+    # Backpressure
     BACKPRESSURE = "backpressure"
+    # Always On
     ALWAYS = "always"