Class: DatadogAPIClient::V1::LogsGrokParser

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

Overview

Create custom grok rules to parse the full message or [a specific attribute of your raw event](docs.datadoghq.com/logs/log_configuration/parsing/#advanced-settings). For more information, see the [parsing section](docs.datadoghq.com/logs/log_configuration/parsing).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LogsGrokParser

Initializes the object

Parameters:

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

    attributes Model attributes in the form of hash



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
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/datadog_api_client/v1/models/logs_grok_parser.rb', line 83

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::LogsGrokParser` 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::LogsGrokParser`. 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?(:'grok')
    self.grok = attributes[:'grok']
  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?(:'samples')
    if (value = attributes[:'samples']).is_a?(Array)
      self.samples = value
    end
  end

  if attributes.key?(:'source')
    self.source = attributes[:'source']
  else
    self.source = 'message'
  end

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

Instance Attribute Details

#grok ⇒ Object

Returns the value of attribute grok.



26
27
28
 
# File 'lib/datadog_api_client/v1/models/logs_grok_parser.rb', line 26

def grok
  @grok
end

#is_enabled ⇒ Object

Whether or not the processor is enabled.



29
30
31
 
# File 'lib/datadog_api_client/v1/models/logs_grok_parser.rb', line 29

def is_enabled
  @is_enabled
end

#name ⇒ Object

Name of the processor.



32
33
34
 
# File 'lib/datadog_api_client/v1/models/logs_grok_parser.rb', line 32

def name
  @name
end

#samples ⇒ Object

List of sample logs to test this grok parser.



35
36
37
 
# File 'lib/datadog_api_client/v1/models/logs_grok_parser.rb', line 35

def samples
  @samples
end

#source ⇒ Object

Name of the log attribute to parse.



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

def source
  @source
end

#type ⇒ Object

Returns the value of attribute type.



40
41
42
 
# File 'lib/datadog_api_client/v1/models/logs_grok_parser.rb', line 40

def type
  @type
end