cribl-control-plane 0.0.13__py3-none-any.whl

cribl_control_plane/models/inputprometheus.py

@@ -0,0 +1,464 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane import utils
+from cribl_control_plane.types import BaseModel
+from cribl_control_plane.utils import validate_open_enum
+from enum import Enum
+import pydantic
+from pydantic.functional_validators import PlainValidator
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class InputPrometheusType(str, Enum, metaclass=utils.OpenEnumMeta):
+    PROMETHEUS = "prometheus"
+
+
+class InputPrometheusConnectionTypedDict(TypedDict):
+    output: str
+    pipeline: NotRequired[str]
+
+
+class InputPrometheusConnection(BaseModel):
+    output: str
+
+    pipeline: Optional[str] = None
+
+
+class InputPrometheusMode(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"
+    ALWAYS = "always"
+
+
+class InputPrometheusCompression(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Codec to use to compress the persisted data"""
+
+    NONE = "none"
+    GZIP = "gzip"
+
+
+class InputPrometheusPqTypedDict(TypedDict):
+    mode: NotRequired[InputPrometheusMode]
+    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."""
+    max_buffer_size: NotRequired[float]
+    r"""The maximum number of events to hold in memory before writing the events to disk"""
+    commit_frequency: NotRequired[float]
+    r"""The number of events to send downstream before committing that Stream has read them"""
+    max_file_size: NotRequired[str]
+    r"""The maximum size to store in each queue file before closing and optionally compressing. Enter a numeral with units of KB, MB, etc."""
+    max_size: NotRequired[str]
+    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."""
+    path: NotRequired[str]
+    r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
+    compress: NotRequired[InputPrometheusCompression]
+    r"""Codec to use to compress the persisted data"""
+
+
+class InputPrometheusPq(BaseModel):
+    mode: Annotated[
+        Optional[InputPrometheusMode], PlainValidator(validate_open_enum(False))
+    ] = InputPrometheusMode.ALWAYS
+    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."""
+
+    max_buffer_size: Annotated[
+        Optional[float], pydantic.Field(alias="maxBufferSize")
+    ] = 1000
+    r"""The maximum number of events to hold in memory before writing the events to disk"""
+
+    commit_frequency: Annotated[
+        Optional[float], pydantic.Field(alias="commitFrequency")
+    ] = 42
+    r"""The number of events to send downstream before committing that Stream has read them"""
+
+    max_file_size: Annotated[Optional[str], pydantic.Field(alias="maxFileSize")] = (
+        "1 MB"
+    )
+    r"""The maximum size to store in each queue file before closing and optionally compressing. Enter a numeral with units of KB, MB, etc."""
+
+    max_size: Annotated[Optional[str], pydantic.Field(alias="maxSize")] = "5GB"
+    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."""
+
+    path: Optional[str] = "$CRIBL_HOME/state/queues"
+    r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
+
+    compress: Annotated[
+        Optional[InputPrometheusCompression], PlainValidator(validate_open_enum(False))
+    ] = InputPrometheusCompression.NONE
+    r"""Codec to use to compress the persisted data"""
+
+
+class InputPrometheusDiscoveryType(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Target discovery mechanism. Use static to manually enter a list of targets."""
+
+    STATIC = "static"
+    DNS = "dns"
+    EC2 = "ec2"
+
+
+class InputPrometheusLogLevel(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Collector runtime Log Level"""
+
+    ERROR = "error"
+    WARN = "warn"
+    INFO = "info"
+    DEBUG = "debug"
+
+
+class InputPrometheusMetadatumTypedDict(TypedDict):
+    name: str
+    value: str
+    r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
+
+
+class InputPrometheusMetadatum(BaseModel):
+    name: str
+
+    value: str
+    r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
+
+
+class InputPrometheusAuthTypeAuthenticationMethod(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
+    r"""Enter credentials directly, or select a stored secret"""
+
+    MANUAL = "manual"
+    SECRET = "secret"
+
+
+class InputPrometheusRecordType(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""DNS Record type to resolve"""
+
+    SRV = "SRV"
+    A = "A"
+    AAAA = "AAAA"
+
+
+class MetricsProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Protocol to use when collecting metrics"""
+
+    HTTP = "http"
+    HTTPS = "https"
+
+
+class InputPrometheusSearchFilterTypedDict(TypedDict):
+    name: str
+    r"""Search filter attribute name, see: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html for more information. Attributes can be manually entered if not present in the drop down list"""
+    values: List[str]
+    r"""Search Filter Values, if empty only \"running\" EC2 instances will be returned"""
+
+
+class InputPrometheusSearchFilter(BaseModel):
+    name: Annotated[str, pydantic.Field(alias="Name")]
+    r"""Search filter attribute name, see: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html for more information. Attributes can be manually entered if not present in the drop down list"""
+
+    values: Annotated[List[str], pydantic.Field(alias="Values")]
+    r"""Search Filter Values, if empty only \"running\" EC2 instances will be returned"""
+
+
+class InputPrometheusAwsAuthenticationMethodAuthenticationMethod(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
+    r"""AWS authentication method. Choose Auto to use IAM roles."""
+
+    AUTO = "auto"
+    MANUAL = "manual"
+    SECRET = "secret"
+
+
+class InputPrometheusSignatureVersion(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Signature version to use for signing EC2 requests"""
+
+    V2 = "v2"
+    V4 = "v4"
+
+
+class InputPrometheusTypedDict(TypedDict):
+    type: InputPrometheusType
+    id: NotRequired[str]
+    r"""Unique ID for this input"""
+    disabled: NotRequired[bool]
+    pipeline: NotRequired[str]
+    r"""Pipeline to process data from this Source before sending it through the Routes"""
+    send_to_routes: NotRequired[bool]
+    r"""Select whether to send data to Routes, or directly to Destinations."""
+    environment: NotRequired[str]
+    r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
+    pq_enabled: NotRequired[bool]
+    r"""Use a disk queue to minimize data loss when connected services block. See [Cribl Docs](https://docs.cribl.io/stream/persistent-queues) for PQ defaults (Cribl-managed Cloud Workers) and configuration options (on-prem and hybrid Workers)."""
+    streamtags: NotRequired[List[str]]
+    r"""Tags for filtering and grouping in @{product}"""
+    connections: NotRequired[List[InputPrometheusConnectionTypedDict]]
+    r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
+    pq: NotRequired[InputPrometheusPqTypedDict]
+    dimension_list: NotRequired[List[str]]
+    r"""Other dimensions to include in events"""
+    discovery_type: NotRequired[InputPrometheusDiscoveryType]
+    r"""Target discovery mechanism. Use static to manually enter a list of targets."""
+    interval: NotRequired[float]
+    r"""How often in minutes to scrape targets for metrics, 60 must be evenly divisible by the value or save will fail."""
+    log_level: NotRequired[InputPrometheusLogLevel]
+    r"""Collector runtime Log Level"""
+    reject_unauthorized: NotRequired[bool]
+    r"""Reject certificates that cannot be verified against a valid CA, such as self-signed certificates"""
+    keep_alive_time: NotRequired[float]
+    r"""How often workers should check in with the scheduler to keep job subscription alive"""
+    job_timeout: NotRequired[str]
+    r"""Maximum time the job is allowed to run (e.g., 30, 45s or 15m). Units are seconds, if not specified. Enter 0 for unlimited time."""
+    max_missed_keep_alives: NotRequired[float]
+    r"""The number of Keep Alive Time periods before an inactive worker will have its job subscription revoked."""
+    ttl: NotRequired[str]
+    r"""Time to keep the job's artifacts on disk after job completion. This also affects how long a job is listed in the Job Inspector."""
+    ignore_group_jobs_limit: NotRequired[bool]
+    r"""When enabled, this job's artifacts are not counted toward the Worker Group's finished job artifacts limit. Artifacts will be removed only after the Collector's configured time to live."""
+    metadata: NotRequired[List[InputPrometheusMetadatumTypedDict]]
+    r"""Fields to add to events from this input"""
+    auth_type: NotRequired[InputPrometheusAuthTypeAuthenticationMethod]
+    r"""Enter credentials directly, or select a stored secret"""
+    description: NotRequired[str]
+    target_list: NotRequired[List[str]]
+    r"""List of Prometheus targets to pull metrics from. Values can be in URL or host[:port] format. For example: http://localhost:9090/metrics, localhost:9090, or localhost. In cases where just host[:port] is specified, the endpoint will resolve to 'http://host[:port]/metrics'."""
+    name_list: NotRequired[List[str]]
+    r"""List of DNS names to resolve"""
+    record_type: NotRequired[InputPrometheusRecordType]
+    r"""DNS Record type to resolve"""
+    scrape_protocol: NotRequired[MetricsProtocol]
+    r"""Protocol to use when collecting metrics"""
+    scrape_path: NotRequired[str]
+    r"""Path to use when collecting metrics from discovered targets"""
+    use_public_ip: NotRequired[bool]
+    r"""Use public IP address for discovered targets. Set to false if the private IP address should be used."""
+    scrape_port: NotRequired[float]
+    r"""The port number in the metrics URL for discovered targets."""
+    search_filter: NotRequired[List[InputPrometheusSearchFilterTypedDict]]
+    r"""EC2 Instance Search Filter"""
+    aws_authentication_method: NotRequired[
+        InputPrometheusAwsAuthenticationMethodAuthenticationMethod
+    ]
+    r"""AWS authentication method. Choose Auto to use IAM roles."""
+    aws_secret_key: NotRequired[str]
+    region: NotRequired[str]
+    r"""Region where the EC2 is located"""
+    endpoint: NotRequired[str]
+    r"""EC2 service endpoint. If empty, defaults to the AWS Region-specific endpoint. Otherwise, it must point to EC2-compatible endpoint."""
+    signature_version: NotRequired[InputPrometheusSignatureVersion]
+    r"""Signature version to use for signing EC2 requests"""
+    reuse_connections: NotRequired[bool]
+    r"""Reuse connections between requests, which can improve performance"""
+    enable_assume_role: NotRequired[bool]
+    r"""Use Assume Role credentials to access EC2"""
+    assume_role_arn: NotRequired[str]
+    r"""Amazon Resource Name (ARN) of the role to assume"""
+    assume_role_external_id: NotRequired[str]
+    r"""External ID to use when assuming role"""
+    duration_seconds: NotRequired[float]
+    r"""Duration of the assumed role's session, in seconds. Minimum is 900 (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12 hours)."""
+    username: NotRequired[str]
+    r"""Username for Prometheus Basic authentication"""
+    password: NotRequired[str]
+    r"""Password for Prometheus Basic authentication"""
+    credentials_secret: NotRequired[str]
+    r"""Select or create a secret that references your credentials"""
+
+
+class InputPrometheus(BaseModel):
+    type: Annotated[InputPrometheusType, PlainValidator(validate_open_enum(False))]
+
+    id: Optional[str] = None
+    r"""Unique ID for this input"""
+
+    disabled: Optional[bool] = False
+
+    pipeline: Optional[str] = None
+    r"""Pipeline to process data from this Source before sending it through the Routes"""
+
+    send_to_routes: Annotated[Optional[bool], pydantic.Field(alias="sendToRoutes")] = (
+        True
+    )
+    r"""Select whether to send data to Routes, or directly to Destinations."""
+
+    environment: Optional[str] = None
+    r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
+
+    pq_enabled: Annotated[Optional[bool], pydantic.Field(alias="pqEnabled")] = False
+    r"""Use a disk queue to minimize data loss when connected services block. See [Cribl Docs](https://docs.cribl.io/stream/persistent-queues) for PQ defaults (Cribl-managed Cloud Workers) and configuration options (on-prem and hybrid Workers)."""
+
+    streamtags: Optional[List[str]] = None
+    r"""Tags for filtering and grouping in @{product}"""
+
+    connections: Optional[List[InputPrometheusConnection]] = None
+    r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
+
+    pq: Optional[InputPrometheusPq] = None
+
+    dimension_list: Annotated[
+        Optional[List[str]], pydantic.Field(alias="dimensionList")
+    ] = None
+    r"""Other dimensions to include in events"""
+
+    discovery_type: Annotated[
+        Annotated[
+            Optional[InputPrometheusDiscoveryType],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="discoveryType"),
+    ] = InputPrometheusDiscoveryType.STATIC
+    r"""Target discovery mechanism. Use static to manually enter a list of targets."""
+
+    interval: Optional[float] = 15
+    r"""How often in minutes to scrape targets for metrics, 60 must be evenly divisible by the value or save will fail."""
+
+    log_level: Annotated[
+        Annotated[
+            Optional[InputPrometheusLogLevel], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="logLevel"),
+    ] = InputPrometheusLogLevel.INFO
+    r"""Collector runtime Log Level"""
+
+    reject_unauthorized: Annotated[
+        Optional[bool], pydantic.Field(alias="rejectUnauthorized")
+    ] = True
+    r"""Reject certificates that cannot be verified against a valid CA, such as self-signed certificates"""
+
+    keep_alive_time: Annotated[
+        Optional[float], pydantic.Field(alias="keepAliveTime")
+    ] = 30
+    r"""How often workers should check in with the scheduler to keep job subscription alive"""
+
+    job_timeout: Annotated[Optional[str], pydantic.Field(alias="jobTimeout")] = "0"
+    r"""Maximum time the job is allowed to run (e.g., 30, 45s or 15m). Units are seconds, if not specified. Enter 0 for unlimited time."""
+
+    max_missed_keep_alives: Annotated[
+        Optional[float], pydantic.Field(alias="maxMissedKeepAlives")
+    ] = 3
+    r"""The number of Keep Alive Time periods before an inactive worker will have its job subscription revoked."""
+
+    ttl: Optional[str] = "4h"
+    r"""Time to keep the job's artifacts on disk after job completion. This also affects how long a job is listed in the Job Inspector."""
+
+    ignore_group_jobs_limit: Annotated[
+        Optional[bool], pydantic.Field(alias="ignoreGroupJobsLimit")
+    ] = False
+    r"""When enabled, this job's artifacts are not counted toward the Worker Group's finished job artifacts limit. Artifacts will be removed only after the Collector's configured time to live."""
+
+    metadata: Optional[List[InputPrometheusMetadatum]] = None
+    r"""Fields to add to events from this input"""
+
+    auth_type: Annotated[
+        Annotated[
+            Optional[InputPrometheusAuthTypeAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
+    ] = InputPrometheusAuthTypeAuthenticationMethod.MANUAL
+    r"""Enter credentials directly, or select a stored secret"""
+
+    description: Optional[str] = None
+
+    target_list: Annotated[Optional[List[str]], pydantic.Field(alias="targetList")] = (
+        None
+    )
+    r"""List of Prometheus targets to pull metrics from. Values can be in URL or host[:port] format. For example: http://localhost:9090/metrics, localhost:9090, or localhost. In cases where just host[:port] is specified, the endpoint will resolve to 'http://host[:port]/metrics'."""
+
+    name_list: Annotated[Optional[List[str]], pydantic.Field(alias="nameList")] = None
+    r"""List of DNS names to resolve"""
+
+    record_type: Annotated[
+        Annotated[
+            Optional[InputPrometheusRecordType],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="recordType"),
+    ] = InputPrometheusRecordType.SRV
+    r"""DNS Record type to resolve"""
+
+    scrape_protocol: Annotated[
+        Annotated[Optional[MetricsProtocol], PlainValidator(validate_open_enum(False))],
+        pydantic.Field(alias="scrapeProtocol"),
+    ] = MetricsProtocol.HTTP
+    r"""Protocol to use when collecting metrics"""
+
+    scrape_path: Annotated[Optional[str], pydantic.Field(alias="scrapePath")] = (
+        "/metrics"
+    )
+    r"""Path to use when collecting metrics from discovered targets"""
+
+    use_public_ip: Annotated[Optional[bool], pydantic.Field(alias="usePublicIp")] = True
+    r"""Use public IP address for discovered targets. Set to false if the private IP address should be used."""
+
+    scrape_port: Annotated[Optional[float], pydantic.Field(alias="scrapePort")] = 9090
+    r"""The port number in the metrics URL for discovered targets."""
+
+    search_filter: Annotated[
+        Optional[List[InputPrometheusSearchFilter]],
+        pydantic.Field(alias="searchFilter"),
+    ] = None
+    r"""EC2 Instance Search Filter"""
+
+    aws_authentication_method: Annotated[
+        Annotated[
+            Optional[InputPrometheusAwsAuthenticationMethodAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="awsAuthenticationMethod"),
+    ] = InputPrometheusAwsAuthenticationMethodAuthenticationMethod.AUTO
+    r"""AWS authentication method. Choose Auto to use IAM roles."""
+
+    aws_secret_key: Annotated[Optional[str], pydantic.Field(alias="awsSecretKey")] = (
+        None
+    )
+
+    region: Optional[str] = None
+    r"""Region where the EC2 is located"""
+
+    endpoint: Optional[str] = None
+    r"""EC2 service endpoint. If empty, defaults to the AWS Region-specific endpoint. Otherwise, it must point to EC2-compatible endpoint."""
+
+    signature_version: Annotated[
+        Annotated[
+            Optional[InputPrometheusSignatureVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="signatureVersion"),
+    ] = InputPrometheusSignatureVersion.V4
+    r"""Signature version to use for signing EC2 requests"""
+
+    reuse_connections: Annotated[
+        Optional[bool], pydantic.Field(alias="reuseConnections")
+    ] = True
+    r"""Reuse connections between requests, which can improve performance"""
+
+    enable_assume_role: Annotated[
+        Optional[bool], pydantic.Field(alias="enableAssumeRole")
+    ] = False
+    r"""Use Assume Role credentials to access EC2"""
+
+    assume_role_arn: Annotated[Optional[str], pydantic.Field(alias="assumeRoleArn")] = (
+        None
+    )
+    r"""Amazon Resource Name (ARN) of the role to assume"""
+
+    assume_role_external_id: Annotated[
+        Optional[str], pydantic.Field(alias="assumeRoleExternalId")
+    ] = None
+    r"""External ID to use when assuming role"""
+
+    duration_seconds: Annotated[
+        Optional[float], pydantic.Field(alias="durationSeconds")
+    ] = 3600
+    r"""Duration of the assumed role's session, in seconds. Minimum is 900 (15 minutes), default is 3600 (1 hour), and maximum is 43200 (12 hours)."""
+
+    username: Optional[str] = None
+    r"""Username for Prometheus Basic authentication"""
+
+    password: Optional[str] = None
+    r"""Password for Prometheus Basic authentication"""
+
+    credentials_secret: Annotated[
+        Optional[str], pydantic.Field(alias="credentialsSecret")
+    ] = None
+    r"""Select or create a secret that references your credentials"""