Class: DatadogAPIClient::V2::ObservabilityPipelineQuotaProcessor

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

Overview

The Quota Processor measures logging traffic for logs that match a specified filter. When the configured daily quota is met, the processor can drop or alert.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



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

def additional_properties
  @additional_properties
end

#drop_events ⇒ Object

If set to true, logs that matched the quota filter and sent after the quota has been met are dropped; only logs that did not match the filter query continue through the pipeline.



25
26
27
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_quota_processor.rb', line 25

def drop_events
  @drop_events
end

#id ⇒ Object

The unique identifier for this component. Used to reference this component in other parts of the pipeline (for example, as the input to downstream components).



28
29
30
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_quota_processor.rb', line 28

def id
  @id
end

#ignore_when_missing_partitions ⇒ Object

If true, the processor skips quota checks when partition fields are missing from the logs.



31
32
33
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_quota_processor.rb', line 31

def ignore_when_missing_partitions
  @ignore_when_missing_partitions
end

#include ⇒ Object

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



34
35
36
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_quota_processor.rb', line 34

def include
  @include
end

#inputs ⇒ Object

A list of component IDs whose output is used as the input for this component.



37
38
39
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_quota_processor.rb', line 37

def inputs
  @inputs
end

#limit ⇒ Object

The maximum amount of data or number of events allowed before the quota is enforced. Can be specified in bytes or events.



40
41
42
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_quota_processor.rb', line 40

def limit
  @limit
end

#name ⇒ Object

Name of the quota.



43
44
45
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_quota_processor.rb', line 43

def name
  @name
end

#overflow_action ⇒ Object

The action to take when the quota is exceeded. Options:

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


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

def overflow_action
  @overflow_action
end

#overrides ⇒ Object

A list of alternate quota rules that apply to specific sets of events, identified by matching field values. Each override can define a custom limit.



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

def overrides
  @overrides
end

#partition_fields ⇒ Object

A list of fields used to segment log traffic for quota enforcement. Quotas are tracked independently by unique combinations of these field values.



56
57
58
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_quota_processor.rb', line 56

def partition_fields
  @partition_fields
end

#type ⇒ Object

The processor type. The value should always be quota.



59
60
61
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_quota_processor.rb', line 59

def type
  @type
end