Class: DatadogAPIClient::V2::ObservabilityPipelineThrottleProcessor

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

Overview

The throttle processor limits the number of events that pass through over a given time window.

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_throttle_processor.rb', line 50

def additional_properties
  @additional_properties
end

#display_name ⇒ Object

The display name for a component.



27
28
29
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_throttle_processor.rb', line 27

def display_name
  @display_name
end

#enabled ⇒ Object

Indicates whether the processor is enabled.



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

def enabled
  @enabled
end

#group_by ⇒ Object

Optional list of fields used to group events before the threshold has been reached.



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

def group_by
  @group_by
end

#id ⇒ Object

The unique identifier for this processor.



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

def id
  @id
end

#include ⇒ Object

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



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

def include
  @include
end

#threshold ⇒ Object

the number of events allowed in a given time window. Events sent after the threshold has been reached, are dropped.



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

def threshold
  @threshold
end

#type ⇒ Object

The processor type. The value should always be throttle.



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

def type
  @type
end

#window ⇒ Object

The time window in seconds over which the threshold applies.



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

def window
  @window
end