Class: DatadogAPIClient::V2::LogAttributes

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/models/log_attributes.rb

Overview

JSON object containing all log attributes and their associated values.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LogAttributes

Initializes the object

Parameters:

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

    attributes Model attributes in the form of hash



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
128
129
130
131
132
133
134
# File 'lib/datadog_api_client/v2/models/log_attributes.rb', line 90

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

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

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

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

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

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

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

Instance Attribute Details

#attributesObject

JSON object of attributes from your log.



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

def attributes
  @attributes
end

#hostObject

Name of the machine from where the logs are being sent.



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

def host
  @host
end

#messageObject

The message [reserved attribute](docs.datadoghq.com/logs/log_collection/#reserved-attributes) of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. That value is then highlighted and displayed in the Logstream, where it is indexed for full text search.



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

def message
  @message
end

#serviceObject

The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same value when you use both products.



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

def service
  @service
end

#statusObject

Status of the message associated with your log.



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

def status
  @status
end

#tagsObject

Array of tags associated with your log.



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

def tags
  @tags
end

#timestampObject

Timestamp of your log.



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

def timestamp
  @timestamp
end