Add observability pipelines splunk HEC metrics destination

.generator/schemas/v2/openapi.yaml

@@ -54016,6 +54016,7 @@ components:
         - $ref: "#/components/schemas/ObservabilityPipelineSyslogNgDestination"
         - $ref: "#/components/schemas/ObservabilityPipelineDatabricksZerobusDestination"
         - $ref: "#/components/schemas/ObservabilityPipelineDatadogMetricsDestination"
+        - $ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestination"
     ObservabilityPipelineConfigPipelineType:
       default: logs
       description: The type of data being ingested. Defaults to `logs` if not specified.
@@ -58137,6 +58138,79 @@ components:
       type: string
       x-enum-varnames:
         - SPLUNK_HEC
+    ObservabilityPipelineSplunkHecMetricsDestination:
+      description: |-
+        The `splunk_hec_metrics` destination forwards metrics to Splunk using the HTTP Event Collector (HEC).
+
+        **Supported pipeline types:** metrics
+      properties:
+        compression:
+          $ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestinationCompression"
+        default_namespace:
+          description: Optional default namespace for metrics sent to Splunk HEC.
+          example: "custom_namespace"
+          type: string
+        endpoint_url_key:
+          description: Name of the environment variable or secret that holds the Splunk HEC endpoint URL.
+          example: SPLUNK_HEC_ENDPOINT_URL
+          type: string
+        id:
+          description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components).
+          example: splunk-hec-metrics-destination
+          type: string
+        index:
+          description: Optional name of the Splunk index where metrics are written.
+          example: "metrics"
+          type: string
+        inputs:
+          description: A list of component IDs whose output is used as the `input` for this component.
+          example: ["metrics-filter-processor"]
+          items:
+            description: The ID of a component whose output is used as input for this destination.
+            type: string
+          type: array
+        source:
+          description: The Splunk source field value for metric events.
+          example: "observability_pipelines"
+          type: string
+        sourcetype:
+          description: The Splunk sourcetype to assign to metric events.
+          example: "custom_sourcetype"
+          type: string
+        tls:
+          $ref: "#/components/schemas/ObservabilityPipelineTls"
+        token_key:
+          description: Name of the environment variable or secret that holds the Splunk HEC token.
+          example: SPLUNK_HEC_TOKEN
+          type: string
+        type:
+          $ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestinationType"
+      required:
+        - id
+        - type
+        - inputs
+      type: object
+      x-pipeline-types: [metrics]
+    ObservabilityPipelineSplunkHecMetricsDestinationCompression:
+      default: none
+      description: Compression algorithm applied when sending metrics to Splunk HEC.
+      enum:
+        - none
+        - gzip
+      example: none
+      type: string
+      x-enum-varnames:
+        - NONE
+        - GZIP
+    ObservabilityPipelineSplunkHecMetricsDestinationType:
+      default: splunk_hec_metrics
+      description: The destination type. Always `splunk_hec_metrics`.
+      enum:
+        - splunk_hec_metrics
+      example: splunk_hec_metrics
+      type: string
+      x-enum-varnames:
+        - SPLUNK_HEC_METRICS
     ObservabilityPipelineSplunkHecSource:
       description: |-
         The `splunk_hec` source implements the Splunk HTTP Event Collector (HEC) API.

docs/datadog_api_client.v2.model.rst

@@ -24840,6 +24840,27 @@ datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_destination\
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_metrics\_destination module
+-----------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_metrics\_destination\_compression module
+------------------------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_compression
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_metrics\_destination\_type module
+-----------------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.observability\_pipeline\_splunk\_hec\_source module
 ---------------------------------------------------------------------------------
 

src/datadog_api_client/v2/model/observability_pipeline_config.py

@@ -97,6 +97,9 @@
     from datadog_api_client.v2.model.observability_pipeline_datadog_metrics_destination import (
         ObservabilityPipelineDatadogMetricsDestination,
     )
+    from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination import (
+        ObservabilityPipelineSplunkHecMetricsDestination,
+    )
     from datadog_api_client.v2.model.observability_pipeline_datadog_agent_source import (
         ObservabilityPipelineDatadogAgentSource,
     )
@@ -200,6 +203,7 @@ def __init__(
                 ObservabilityPipelineSyslogNgDestination,
                 ObservabilityPipelineDatabricksZerobusDestination,
                 ObservabilityPipelineDatadogMetricsDestination,
+                ObservabilityPipelineSplunkHecMetricsDestination,
             ]
         ],
         sources: List[

src/datadog_api_client/v2/model/observability_pipeline_config_destination_item.py

@@ -226,6 +226,12 @@ def __init__(self, **kwargs):
 
         :param unity_catalog_endpoint_key: Name of the environment variable or the secret identifier that references your Databricks workspace URL, which is used to communicate with the Unity Catalog API.
         :type unity_catalog_endpoint_key: str, optional
+
+        :param default_namespace: Optional default namespace for metrics sent to Splunk HEC.
+        :type default_namespace: str, optional
+
+        :param source: The Splunk source field value for metric events.
+        :type source: str, optional
         """
         super().__init__(kwargs)
 
@@ -309,6 +315,9 @@ def _composed_schemas(_):
         from datadog_api_client.v2.model.observability_pipeline_datadog_metrics_destination import (
             ObservabilityPipelineDatadogMetricsDestination,
         )
+        from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination import (
+            ObservabilityPipelineSplunkHecMetricsDestination,
+        )
 
         return {
             "oneOf": [
@@ -337,5 +346,6 @@ def _composed_schemas(_):
                 ObservabilityPipelineSyslogNgDestination,
                 ObservabilityPipelineDatabricksZerobusDestination,
                 ObservabilityPipelineDatadogMetricsDestination,
+                ObservabilityPipelineSplunkHecMetricsDestination,
             ],
         }

src/datadog_api_client/v2/model/observability_pipeline_splunk_hec_metrics_destination.py

@@ -0,0 +1,138 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+from typing import List, Union, TYPE_CHECKING
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+    unset,
+    UnsetType,
+)
+
+
+if TYPE_CHECKING:
+    from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_compression import (
+        ObservabilityPipelineSplunkHecMetricsDestinationCompression,
+    )
+    from datadog_api_client.v2.model.observability_pipeline_tls import ObservabilityPipelineTls
+    from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_type import (
+        ObservabilityPipelineSplunkHecMetricsDestinationType,
+    )
+
+
+class ObservabilityPipelineSplunkHecMetricsDestination(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_compression import (
+            ObservabilityPipelineSplunkHecMetricsDestinationCompression,
+        )
+        from datadog_api_client.v2.model.observability_pipeline_tls import ObservabilityPipelineTls
+        from datadog_api_client.v2.model.observability_pipeline_splunk_hec_metrics_destination_type import (
+            ObservabilityPipelineSplunkHecMetricsDestinationType,
+        )
+
+        return {
+            "compression": (ObservabilityPipelineSplunkHecMetricsDestinationCompression,),
+            "default_namespace": (str,),
+            "endpoint_url_key": (str,),
+            "id": (str,),
+            "index": (str,),
+            "inputs": ([str],),
+            "source": (str,),
+            "sourcetype": (str,),
+            "tls": (ObservabilityPipelineTls,),
+            "token_key": (str,),
+            "type": (ObservabilityPipelineSplunkHecMetricsDestinationType,),
+        }
+
+    attribute_map = {
+        "compression": "compression",
+        "default_namespace": "default_namespace",
+        "endpoint_url_key": "endpoint_url_key",
+        "id": "id",
+        "index": "index",
+        "inputs": "inputs",
+        "source": "source",
+        "sourcetype": "sourcetype",
+        "tls": "tls",
+        "token_key": "token_key",
+        "type": "type",
+    }
+
+    def __init__(
+        self_,
+        id: str,
+        inputs: List[str],
+        type: ObservabilityPipelineSplunkHecMetricsDestinationType,
+        compression: Union[ObservabilityPipelineSplunkHecMetricsDestinationCompression, UnsetType] = unset,
+        default_namespace: Union[str, UnsetType] = unset,
+        endpoint_url_key: Union[str, UnsetType] = unset,
+        index: Union[str, UnsetType] = unset,
+        source: Union[str, UnsetType] = unset,
+        sourcetype: Union[str, UnsetType] = unset,
+        tls: Union[ObservabilityPipelineTls, UnsetType] = unset,
+        token_key: Union[str, UnsetType] = unset,
+        **kwargs,
+    ):
+        """
+        The ``splunk_hec_metrics`` destination forwards metrics to Splunk using the HTTP Event Collector (HEC).
+
+        **Supported pipeline types:** metrics
+
+        :param compression: Compression algorithm applied when sending metrics to Splunk HEC.
+        :type compression: ObservabilityPipelineSplunkHecMetricsDestinationCompression, optional
+
+        :param default_namespace: Optional default namespace for metrics sent to Splunk HEC.
+        :type default_namespace: str, optional
+
+        :param endpoint_url_key: Name of the environment variable or secret that holds the Splunk HEC endpoint URL.
+        :type endpoint_url_key: str, optional
+
+        :param id: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the ``input`` to downstream components).
+        :type id: str
+
+        :param index: Optional name of the Splunk index where metrics are written.
+        :type index: str, optional
+
+        :param inputs: A list of component IDs whose output is used as the ``input`` for this component.
+        :type inputs: [str]
+
+        :param source: The Splunk source field value for metric events.
+        :type source: str, optional
+
+        :param sourcetype: The Splunk sourcetype to assign to metric events.
+        :type sourcetype: str, optional
+
+        :param tls: Configuration for enabling TLS encryption between the pipeline component and external services.
+        :type tls: ObservabilityPipelineTls, optional
+
+        :param token_key: Name of the environment variable or secret that holds the Splunk HEC token.
+        :type token_key: str, optional
+
+        :param type: The destination type. Always ``splunk_hec_metrics``.
+        :type type: ObservabilityPipelineSplunkHecMetricsDestinationType
+        """
+        if compression is not unset:
+            kwargs["compression"] = compression
+        if default_namespace is not unset:
+            kwargs["default_namespace"] = default_namespace
+        if endpoint_url_key is not unset:
+            kwargs["endpoint_url_key"] = endpoint_url_key
+        if index is not unset:
+            kwargs["index"] = index
+        if source is not unset:
+            kwargs["source"] = source
+        if sourcetype is not unset:
+            kwargs["sourcetype"] = sourcetype
+        if tls is not unset:
+            kwargs["tls"] = tls
+        if token_key is not unset:
+            kwargs["token_key"] = token_key
+        super().__init__(kwargs)
+
+        self_.id = id
+        self_.inputs = inputs
+        self_.type = type

src/datadog_api_client/v2/model/observability_pipeline_splunk_hec_metrics_destination_compression.py

@@ -0,0 +1,42 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+
+from datadog_api_client.model_utils import (
+    ModelSimple,
+    cached_property,
+)
+
+from typing import ClassVar
+
+
+class ObservabilityPipelineSplunkHecMetricsDestinationCompression(ModelSimple):
+    """
+    Compression algorithm applied when sending metrics to Splunk HEC.
+
+    :param value: If omitted defaults to "none". Must be one of ["none", "gzip"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "none",
+        "gzip",
+    }
+    NONE: ClassVar["ObservabilityPipelineSplunkHecMetricsDestinationCompression"]
+    GZIP: ClassVar["ObservabilityPipelineSplunkHecMetricsDestinationCompression"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+ObservabilityPipelineSplunkHecMetricsDestinationCompression.NONE = (
+    ObservabilityPipelineSplunkHecMetricsDestinationCompression("none")
+)
+ObservabilityPipelineSplunkHecMetricsDestinationCompression.GZIP = (
+    ObservabilityPipelineSplunkHecMetricsDestinationCompression("gzip")
+)

src/datadog_api_client/v2/model/observability_pipeline_splunk_hec_metrics_destination_type.py

@@ -0,0 +1,37 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+
+from datadog_api_client.model_utils import (
+    ModelSimple,
+    cached_property,
+)
+
+from typing import ClassVar
+
+
+class ObservabilityPipelineSplunkHecMetricsDestinationType(ModelSimple):
+    """
+    The destination type. Always `splunk_hec_metrics`.
+
+    :param value: If omitted defaults to "splunk_hec_metrics". Must be one of ["splunk_hec_metrics"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "splunk_hec_metrics",
+    }
+    SPLUNK_HEC_METRICS: ClassVar["ObservabilityPipelineSplunkHecMetricsDestinationType"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+ObservabilityPipelineSplunkHecMetricsDestinationType.SPLUNK_HEC_METRICS = (
+    ObservabilityPipelineSplunkHecMetricsDestinationType("splunk_hec_metrics")
+)