Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -59823,6 +59823,7 @@ components:
- $ref: "#/components/schemas/ObservabilityPipelineDedupeProcessor"
- $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableProcessor"
- $ref: "#/components/schemas/ObservabilityPipelineGenerateMetricsProcessor"
- $ref: "#/components/schemas/ObservabilityPipelineGenerateMetricsV2Processor"
- $ref: "#/components/schemas/ObservabilityPipelineOcsfMapperProcessor"
- $ref: "#/components/schemas/ObservabilityPipelineParseGrokProcessor"
- $ref: "#/components/schemas/ObservabilityPipelineParseJSONProcessor"
Expand Down Expand Up @@ -60962,6 +60963,50 @@ components:
type: string
x-enum-varnames:
- GENERATE_DATADOG_METRICS
ObservabilityPipelineGenerateMetricsV2Processor:
description: |-
The `generate_metrics` processor creates custom metrics from logs.
Metrics can be counters, gauges, or distributions and optionally grouped by log fields.
The generated metrics must be routed to a metrics destination using the input `<processor-id>.metrics`.

**Supported pipeline types:** logs
properties:
display_name:
$ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
enabled:
description: Indicates whether the processor is enabled.
example: true
type: boolean
id:
description: The unique identifier for this component. Used to reference this component in other parts of the pipeline.
example: generate-metrics-processor
type: string
include:
description: A Datadog search query used to determine which logs this processor targets.
example: "service:my-service"
type: string
metrics:
description: Configuration for generating individual metrics.
items:
$ref: "#/components/schemas/ObservabilityPipelineGeneratedMetric"
type: array
type:
$ref: "#/components/schemas/ObservabilityPipelineGenerateMetricsV2ProcessorType"
required:
- id
- type
- enabled
type: object
x-pipeline-types: [logs]
ObservabilityPipelineGenerateMetricsV2ProcessorType:
default: generate_metrics
description: The processor type. Always `generate_metrics`.
enum:
- generate_metrics
example: generate_metrics
type: string
x-enum-varnames:
- GENERATE_METRICS
ObservabilityPipelineGeneratedMetric:
description: |-
Defines a log-based custom metric, including its name, type, filter, value computation strategy,
Expand Down
14 changes: 14 additions & 0 deletions docs/datadog_api_client.v2.model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25596,6 +25596,20 @@ datadog\_api\_client.v2.model.observability\_pipeline\_generate\_metrics\_proces
:members:
:show-inheritance:

datadog\_api\_client.v2.model.observability\_pipeline\_generate\_metrics\_v2\_processor module
----------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.observability_pipeline_generate_metrics_v2_processor
:members:
:show-inheritance:

datadog\_api\_client.v2.model.observability\_pipeline\_generate\_metrics\_v2\_processor\_type module
----------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.observability_pipeline_generate_metrics_v2_processor_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.observability\_pipeline\_generated\_metric module
-------------------------------------------------------------------------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@
from datadog_api_client.v2.model.observability_pipeline_generate_metrics_processor import (
ObservabilityPipelineGenerateMetricsProcessor,
)
from datadog_api_client.v2.model.observability_pipeline_generate_metrics_v2_processor import (
ObservabilityPipelineGenerateMetricsV2Processor,
)
from datadog_api_client.v2.model.observability_pipeline_ocsf_mapper_processor import (
ObservabilityPipelineOcsfMapperProcessor,
)
Expand Down Expand Up @@ -128,6 +131,7 @@ def __init__(
ObservabilityPipelineDedupeProcessor,
ObservabilityPipelineEnrichmentTableProcessor,
ObservabilityPipelineGenerateMetricsProcessor,
ObservabilityPipelineGenerateMetricsV2Processor,
ObservabilityPipelineOcsfMapperProcessor,
ObservabilityPipelineParseGrokProcessor,
ObservabilityPipelineParseJSONProcessor,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,9 @@ def _composed_schemas(_):
from datadog_api_client.v2.model.observability_pipeline_generate_metrics_processor import (
ObservabilityPipelineGenerateMetricsProcessor,
)
from datadog_api_client.v2.model.observability_pipeline_generate_metrics_v2_processor import (
ObservabilityPipelineGenerateMetricsV2Processor,
)
from datadog_api_client.v2.model.observability_pipeline_ocsf_mapper_processor import (
ObservabilityPipelineOcsfMapperProcessor,
)
Expand Down Expand Up @@ -266,6 +269,7 @@ def _composed_schemas(_):
ObservabilityPipelineDedupeProcessor,
ObservabilityPipelineEnrichmentTableProcessor,
ObservabilityPipelineGenerateMetricsProcessor,
ObservabilityPipelineGenerateMetricsV2Processor,
ObservabilityPipelineOcsfMapperProcessor,
ObservabilityPipelineParseGrokProcessor,
ObservabilityPipelineParseJSONProcessor,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
# 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_generated_metric import ObservabilityPipelineGeneratedMetric
from datadog_api_client.v2.model.observability_pipeline_generate_metrics_v2_processor_type import (
ObservabilityPipelineGenerateMetricsV2ProcessorType,
)


class ObservabilityPipelineGenerateMetricsV2Processor(ModelNormal):
@cached_property
def openapi_types(_):
from datadog_api_client.v2.model.observability_pipeline_generated_metric import (
ObservabilityPipelineGeneratedMetric,
)
from datadog_api_client.v2.model.observability_pipeline_generate_metrics_v2_processor_type import (
ObservabilityPipelineGenerateMetricsV2ProcessorType,
)

return {
"display_name": (str,),
"enabled": (bool,),
"id": (str,),
"include": (str,),
"metrics": ([ObservabilityPipelineGeneratedMetric],),
"type": (ObservabilityPipelineGenerateMetricsV2ProcessorType,),
}

attribute_map = {
"display_name": "display_name",
"enabled": "enabled",
"id": "id",
"include": "include",
"metrics": "metrics",
"type": "type",
}

def __init__(
self_,
enabled: bool,
id: str,
type: ObservabilityPipelineGenerateMetricsV2ProcessorType,
display_name: Union[str, UnsetType] = unset,
include: Union[str, UnsetType] = unset,
metrics: Union[List[ObservabilityPipelineGeneratedMetric], UnsetType] = unset,
**kwargs,
):
"""
The ``generate_metrics`` processor creates custom metrics from logs.
Metrics can be counters, gauges, or distributions and optionally grouped by log fields.
The generated metrics must be routed to a metrics destination using the input ``<processor-id>.metrics``.

**Supported pipeline types:** logs

:param display_name: The display name for a component.
:type display_name: str, optional

:param enabled: Indicates whether the processor is enabled.
:type enabled: bool

:param id: The unique identifier for this component. Used to reference this component in other parts of the pipeline.
:type id: str

:param include: A Datadog search query used to determine which logs this processor targets.
:type include: str, optional

:param metrics: Configuration for generating individual metrics.
:type metrics: [ObservabilityPipelineGeneratedMetric], optional

:param type: The processor type. Always ``generate_metrics``.
:type type: ObservabilityPipelineGenerateMetricsV2ProcessorType
"""
if display_name is not unset:
kwargs["display_name"] = display_name
if include is not unset:
kwargs["include"] = include
if metrics is not unset:
kwargs["metrics"] = metrics
super().__init__(kwargs)

self_.enabled = enabled
self_.id = id
self_.type = type
Original file line number Diff line number Diff line change
@@ -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 ObservabilityPipelineGenerateMetricsV2ProcessorType(ModelSimple):
"""
The processor type. Always `generate_metrics`.

:param value: If omitted defaults to "generate_metrics". Must be one of ["generate_metrics"].
:type value: str
"""

allowed_values = {
"generate_metrics",
}
GENERATE_METRICS: ClassVar["ObservabilityPipelineGenerateMetricsV2ProcessorType"]

@cached_property
def openapi_types(_):
return {
"value": (str,),
}


ObservabilityPipelineGenerateMetricsV2ProcessorType.GENERATE_METRICS = (
ObservabilityPipelineGenerateMetricsV2ProcessorType("generate_metrics")
)
8 changes: 8 additions & 0 deletions src/datadog_api_client/v2/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4955,6 +4955,12 @@
from datadog_api_client.v2.model.observability_pipeline_generate_metrics_processor_type import (
ObservabilityPipelineGenerateMetricsProcessorType,
)
from datadog_api_client.v2.model.observability_pipeline_generate_metrics_v2_processor import (
ObservabilityPipelineGenerateMetricsV2Processor,
)
from datadog_api_client.v2.model.observability_pipeline_generate_metrics_v2_processor_type import (
ObservabilityPipelineGenerateMetricsV2ProcessorType,
)
from datadog_api_client.v2.model.observability_pipeline_generated_metric import ObservabilityPipelineGeneratedMetric
from datadog_api_client.v2.model.observability_pipeline_generated_metric_increment_by_field import (
ObservabilityPipelineGeneratedMetricIncrementByField,
Expand Down Expand Up @@ -12611,6 +12617,8 @@
"ObservabilityPipelineGcpAuth",
"ObservabilityPipelineGenerateMetricsProcessor",
"ObservabilityPipelineGenerateMetricsProcessorType",
"ObservabilityPipelineGenerateMetricsV2Processor",
"ObservabilityPipelineGenerateMetricsV2ProcessorType",
"ObservabilityPipelineGeneratedMetric",
"ObservabilityPipelineGeneratedMetricIncrementByField",
"ObservabilityPipelineGeneratedMetricIncrementByFieldStrategy",
Expand Down
Loading