Class: DatadogAPIClient::V2::ObservabilityPipelineGenerateMetricsV2Processor

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v2/models/observability_pipeline_generate_metrics_v2_processor.rb

Overview

The generate_metrics processor creates custom metrics from logs. Metrics can be counters, gauges, or distributions and optionally grouped by log fields.

There must be a destination whose inputs reference this processor with the <processor-id>.metrics suffix to route the generated metrics. All destination types normally supported for metrics pipelines are also supported as metrics destinations in logs pipelines.

Supported pipeline types: logs

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



50
51
52
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_generate_metrics_v2_processor.rb', line 50

def additional_properties
  @additional_properties
end

#display_name ⇒ Object

The display name for a component.



30
31
32
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_generate_metrics_v2_processor.rb', line 30

def display_name
  @display_name
end

#enabled ⇒ Object

Indicates whether the processor is enabled.



33
34
35
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_generate_metrics_v2_processor.rb', line 33

def enabled
  @enabled
end

#enabled_metric_aggregation ⇒ Object

[Recommended] Indicates whether generated metrics are automatically aggregated and enriched with the worker_uuid tag before being sent to the metric destination.



36
37
38
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_generate_metrics_v2_processor.rb', line 36

def enabled_metric_aggregation
  @enabled_metric_aggregation
end

#id ⇒ Object

The unique identifier for this component. Used to reference this component in other parts of the pipeline.



39
40
41
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_generate_metrics_v2_processor.rb', line 39

def id
  @id
end

#include ⇒ Object

A Datadog search query used to determine which logs this processor targets.



42
43
44
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_generate_metrics_v2_processor.rb', line 42

def include
  @include
end

#metrics ⇒ Object

Configuration for generating individual metrics.



45
46
47
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_generate_metrics_v2_processor.rb', line 45

def metrics
  @metrics
end

#type ⇒ Object

The processor type. Always generate_metrics.



48
49
50
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_generate_metrics_v2_processor.rb', line 48

def type
  @type
end