Class: DatadogAPIClient::V2::ObservabilityPipelineSplunkHecDestination

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

Overview

The splunk_hec destination forwards logs to Splunk using the HTTP Event Collector (HEC).

Supported pipeline types: logs

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



67
68
69
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_splunk_hec_destination.rb', line 67

def additional_properties
  @additional_properties
end

#auto_extract_timestamp ⇒ Object

If true, Splunk tries to extract timestamps from incoming log events. If false, Splunk assigns the time the event was received. Only applies when endpoint_target is event; cannot be true when endpoint_target is raw.



29
30
31
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_splunk_hec_destination.rb', line 29

def auto_extract_timestamp
  @auto_extract_timestamp
end

#buffer ⇒ Object

Configuration for buffer settings on destination components.



32
33
34
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_splunk_hec_destination.rb', line 32

def buffer
  @buffer
end

#encoding ⇒ Object

Encoding format for log events.



35
36
37
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_splunk_hec_destination.rb', line 35

def encoding
  @encoding
end

#endpoint_target ⇒ Object

The Splunk HEC endpoint to send events to. Use event to send structured events to the /event endpoint, or raw to send the raw message to the /raw endpoint.



38
39
40
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_splunk_hec_destination.rb', line 38

def endpoint_target
  @endpoint_target
end

#endpoint_url_key ⇒ Object

Name of the environment variable or secret that holds the Splunk HEC endpoint URL.



41
42
43
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_splunk_hec_destination.rb', line 41

def endpoint_url_key
  @endpoint_url_key
end

#id ⇒ Object

The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the input to downstream components).



44
45
46
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_splunk_hec_destination.rb', line 44

def id
  @id
end

#index ⇒ Object

Optional name of the Splunk index where logs are written.



47
48
49
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_splunk_hec_destination.rb', line 47

def index
  @index
end

#indexed_fields ⇒ Object

List of log field names to send as indexed fields to Splunk HEC. Available only when encoding is json.



50
51
52
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_splunk_hec_destination.rb', line 50

def indexed_fields
  @indexed_fields
end

#inputs ⇒ Object

A list of component IDs whose output is used as the input for this component.



53
54
55
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_splunk_hec_destination.rb', line 53

def inputs
  @inputs
end

#sourcetype ⇒ Object

The Splunk sourcetype to assign to log events.



56
57
58
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_splunk_hec_destination.rb', line 56

def sourcetype
  @sourcetype
end

#token_key ⇒ Object

Name of the environment variable or secret that holds the Splunk HEC token.



59
60
61
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_splunk_hec_destination.rb', line 59

def token_key
  @token_key
end

#token_strategy ⇒ Object

Controls how the Splunk HEC token is supplied. Use custom to provide a token with token_key, or from_source to forward the token received from an upstream Splunk HEC source.



62
63
64
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_splunk_hec_destination.rb', line 62

def token_strategy
  @token_strategy
end

#type ⇒ Object

The destination type. Always splunk_hec.



65
66
67
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_splunk_hec_destination.rb', line 65

def type
  @type
end