Class: SmplkitGeneratedClient::Logging::Logger

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb

Overview

A logger configured for the account. Loggers are organized by dot-separated key (for example, ‘sqlalchemy.engine`), matching the hierarchical naming convention used by most logging frameworks. A managed logger applies the configured level to every runtime where the logger appears; unmanaged loggers are tracked only as observations from SDKs.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ Logger

Initializes the object

Parameters:

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

    Model attributes in the form of hash



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 124

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

When the logger was first created or discovered.



41
42
43
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 41

def created_at
  @created_at
end

#effective_levels ⇒ Object

Per-environment summary of what runtimes are reporting for this logger. Keyed by environment name; each entry is one of ‘"none"`, `"agrees", "level": "<LEVEL>"`, or `"varies"`. `agrees` means every observed source in that environment reports the same resolved level; `varies` means at least two sources disagree.



38
39
40
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 38

def effective_levels
  @effective_levels
end

#environments ⇒ Object

Per-environment level overrides keyed by environment name. Each value is an object with an optional ‘level` field, e.g. `{"level": "WARN"}`. An environment may be present with no `level` to record that the logger applies there without changing the resolved level.



35
36
37
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 35

def environments
  @environments
end

#group ⇒ Object

Key of the log group this logger belongs to, or ‘null` if the logger is not grouped. Assigning a logger to a group promotes it to managed; assigning a group cascades to unmanaged descendants by clearing their group reference.



26
27
28
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 26

def group
  @group
end

#level ⇒ Object

Account-wide log level applied to this logger. ‘null` means no override at the logger level — the level is inherited from the logger’s group or the framework default.



23
24
25
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 23

def level
  @level
end

#managed ⇒ Object

When ‘true`, the logger is part of the account’s managed configuration and counts toward the managed-loggers usage counter. Setting ‘level`, `group`, or `environments` on an unmanaged logger promotes it to managed automatically.



29
30
31
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 29

def managed
  @managed
end

#name ⇒ Object

Human-readable label for the logger.



20
21
22
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 20

def name
  @name
end

#sources ⇒ Object

Service / environment observations reported by SDKs for this logger. Each entry carries the service name, environment, the level the SDK saw, the resolved level after framework inheritance, and timestamps for the first and most recent sighting.



32
33
34
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 32

def sources
  @sources
end

#updated_at ⇒ Object

When the logger was last modified.



44
45
46
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 44

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



84
85
86
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 84

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 89

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 69

def self.attribute_map
  {
    :'name' => :'name',
    :'level' => :'level',
    :'group' => :'group',
    :'managed' => :'managed',
    :'sources' => :'sources',
    :'environments' => :'environments',
    :'effective_levels' => :'effective_levels',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 265

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 109

def self.openapi_nullable
  Set.new([
    :'level',
    :'group',
    :'managed',
    :'sources',
    :'environments',
    :'effective_levels',
    :'created_at',
    :'updated_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 94

def self.openapi_types
  {
    :'name' => :'String',
    :'level' => :'String',
    :'group' => :'String',
    :'managed' => :'Boolean',
    :'sources' => :'Array<Hash<String, Object>>',
    :'environments' => :'Hash<String, Object>',
    :'effective_levels' => :'Hash<String, Object>',
    :'created_at' => :'Time',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 236

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      level == o.level &&
      group == o.group &&
      managed == o.managed &&
      sources == o.sources &&
      environments == o.environments &&
      effective_levels == o.effective_levels &&
      created_at == o.created_at &&
      updated_at == o.updated_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


252
253
254
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 252

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



258
259
260
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 258

def hash
  [name, level, group, managed, sources, environments, effective_levels, created_at, updated_at].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 185

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length > 255
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 287

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



201
202
203
204
205
206
207
208
 
# File 'lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger.rb', line 201

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length > 255
  level_validator = EnumAttributeValidator.new('String', ["TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL", "SILENT"])
  return false unless level_validator.valid?(@level)
  true
end