Class: DatadogAPIClient::V2::ObservabilityPipelinePrometheusRemoteWriteSource

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

Overview

The prometheus_remote_write source ingests metrics pushed over the Prometheus Remote Write protocol.

Supported pipeline types: metrics

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



54
55
56
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_prometheus_remote_write_source.rb', line 54

def additional_properties
  @additional_properties
end

#address_key ⇒ Object

Name of the environment variable or secret that holds the listen address for the Prometheus Remote Write endpoint.



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

def address_key
  @address_key
end

#auth_strategy ⇒ Object

HTTP authentication method.



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

def auth_strategy
  @auth_strategy
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).



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

def id
  @id
end

#password_key ⇒ Object

Name of the environment variable or secret that holds the password (used when auth_strategy is plain).



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

def password_key
  @password_key
end

#path ⇒ Object

The HTTP path on which the source listens for incoming Prometheus Remote Write requests.



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

def path
  @path
end

#tls ⇒ Object

Configuration for enabling TLS encryption between the pipeline component and external connecting clients.



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

def tls
  @tls
end

#type ⇒ Object

The source type. The value should always be prometheus_remote_write.



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

def type
  @type
end

#username_key ⇒ Object

Name of the environment variable or secret that holds the username (used when auth_strategy is plain).



48
49
50
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_prometheus_remote_write_source.rb', line 48

def username_key
  @username_key
end

#valid_tokens ⇒ Object

A list of tokens that are accepted for authenticating incoming requests. When set, the source rejects any request whose token does not match an enabled entry in this list.



52
53
54
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_prometheus_remote_write_source.rb', line 52

def valid_tokens
  @valid_tokens
end