Class: DatadogAPIClient::V1::LogsSchemaCategoryMapper

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

Overview

Use the Schema Category Mapper to categorize log event into enum fields. In the case of OCSF, they can be used to map sibling fields which are composed of an ID and a name.

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.
  • Categories are executed in order and processing stops at the first match. Make sure categories are properly ordered in case a log could match multiple queries.
  • Sibling fields always have a numerical ID field and a human-readable string name.
  • A fallback section handles cases where the name or ID value matches a specific value. If the name matches "Other" or the ID matches 99, the value of the sibling name field will be pulled from a source field from the original log.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



52
53
54
 
# File 'lib/datadog_api_client/v1/models/logs_schema_category_mapper.rb', line 52

def additional_properties
  @additional_properties
end

#categories ⇒ Object

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



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

def categories
  @categories
end

#fallback ⇒ Object

Used to override hardcoded category values with a value pulled from a source attribute on the log.



41
42
43
 
# File 'lib/datadog_api_client/v1/models/logs_schema_category_mapper.rb', line 41

def fallback
  @fallback
end

#name ⇒ Object

Name of the logs schema category mapper.



44
45
46
 
# File 'lib/datadog_api_client/v1/models/logs_schema_category_mapper.rb', line 44

def name
  @name
end

#targets ⇒ Object

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



47
48
49
 
# File 'lib/datadog_api_client/v1/models/logs_schema_category_mapper.rb', line 47

def targets
  @targets
end

#type ⇒ Object

Type of logs schema category mapper.



50
51
52
 
# File 'lib/datadog_api_client/v1/models/logs_schema_category_mapper.rb', line 50

def type
  @type
end