Class: DatadogAPIClient::V1::LogsCategoryProcessor

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v1/models/logs_category_processor.rb

Overview

Use the Category Processor to add a new attribute (without spaces or special characters in the new attribute name) to a log matching a provided search query. Use categories to create groups for an analytical view. For example, URL groups, machine groups, environments, and response time buckets. Notes: - The syntax of the query is the one of Logs Explorer search bar. The query can be done on any log attribute or tag, whether it is a facet or not. Wildcards can also be used inside your query. - Once the log has matched one of the Processor queries, it stops. Make sure they are properly ordered in case a log could match several queries. - The names of the categories must be unique. - Once defined in the Category Processor, you can map categories to log status using the Log Status Remapper.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LogsCategoryProcessor

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    attributes Model attributes in the form of hash



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/datadog_api_client/v1/models/logs_category_processor.rb', line 79

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::LogsCategoryProcessor` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V1::LogsCategoryProcessor`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'categories')
    if (value = attributes[:'categories']).is_a?(Array)
      self.categories = value
    end
  end

  if attributes.key?(:'is_enabled')
    self.is_enabled = attributes[:'is_enabled']
  else
    self.is_enabled = false
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'target')
    self.target = attributes[:'target']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'category-processor'
  end
end

Instance Attribute Details

#categories ⇒ Object

Array of filters to match or not a log and their corresponding ‘name`to assign a custom value to the log.



27
28
29
 
# File 'lib/datadog_api_client/v1/models/logs_category_processor.rb', line 27

def categories
  @categories
end

#is_enabled ⇒ Object

Whether or not the processor is enabled.



30
31
32
 
# File 'lib/datadog_api_client/v1/models/logs_category_processor.rb', line 30

def is_enabled
  @is_enabled
end

#name ⇒ Object

Name of the processor.



33
34
35
 
# File 'lib/datadog_api_client/v1/models/logs_category_processor.rb', line 33

def name
  @name
end

#target ⇒ Object

Name of the target attribute which value is defined by the matching category.



36
37
38
 
# File 'lib/datadog_api_client/v1/models/logs_category_processor.rb', line 36

def target
  @target
end

#type ⇒ Object

Returns the value of attribute type.



38
39
40
 
# File 'lib/datadog_api_client/v1/models/logs_category_processor.rb', line 38

def type
  @type
end