Class: DatadogAPIClient::V2::ObservabilityPipelineSpikeProtectionProcessor

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

Overview

The spike_protection processor learns the normal ingestion volume for the logs that match a specified filter and takes action when the volume spikes unexpectedly.

Supported pipeline types: logs

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#action_when_missing_partitions ⇒ Object

How to handle logs that are missing one of the partition_fields. Options:

  • ignore: Forward the event without applying spike protection.
  • default_bucket: Assign the event to a default partition.


29
30
31
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_spike_protection_processor.rb', line 29

def action_when_missing_partitions
  @action_when_missing_partitions
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



69
70
71
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_spike_protection_processor.rb', line 69

def additional_properties
  @additional_properties
end

#display_name ⇒ Object

The display name for a component.



32
33
34
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_spike_protection_processor.rb', line 32

def display_name
  @display_name
end

#enabled ⇒ Object

Indicates whether the processor is enabled.



35
36
37
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_spike_protection_processor.rb', line 35

def enabled
  @enabled
end

#id ⇒ Object

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).



38
39
40
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_spike_protection_processor.rb', line 38

def id
  @id
end

#include ⇒ Object

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



41
42
43
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_spike_protection_processor.rb', line 41

def include
  @include
end

#minimal_threshold ⇒ Object

The minimum volume, in bytes, that must be observed within 24 hours before spike protection can activate. Defaults to 100 GiB.



44
45
46
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_spike_protection_processor.rb', line 44

def minimal_threshold
  @minimal_threshold
end

#minimal_threshold_overrides ⇒ Object

A list of per-partition overrides for the minimal threshold, identified by matching field values. Requires partition_fields to be set.



47
48
49
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_spike_protection_processor.rb', line 47

def minimal_threshold_overrides
  @minimal_threshold_overrides
end

#name ⇒ Object

Name of the spike protection rule.



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

def name
  @name
end

#partition_fields ⇒ Object

A list of fields used to segment log traffic. Volume is learned and evaluated independently for each unique combination of these field values. A maximum of five fields is supported.



53
54
55
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_spike_protection_processor.rb', line 53

def partition_fields
  @partition_fields
end

#spike_action ⇒ Object

The action to take with matching logs while spike protection is active. Options:

  • drop: Drop the event.
  • no_action: Let the event pass through.
  • overflow_routing: Route to an overflow destination.

When overflow_routing is used, there must be a destination whose inputs reference this processor with the <processor-id>.overflow_events suffix to route the overflowing events.



61
62
63
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_spike_protection_processor.rb', line 61

def spike_action
  @spike_action
end

#spike_threshold ⇒ Object

The number of standard deviations above the learned mean volume that must be exceeded before a spike is detected. Defaults to 5.



64
65
66
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_spike_protection_processor.rb', line 64

def spike_threshold
  @spike_threshold
end

#type ⇒ Object

The processor type. The value should always be spike_protection.



67
68
69
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_spike_protection_processor.rb', line 67

def type
  @type
end