Class: DatadogAPIClient::V2::ObservabilityPipelinePrometheusRemoteWriteDestination

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

Overview

The prometheus_remote_write destination forwards metrics to an endpoint that supports 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.



63
64
65
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_prometheus_remote_write_destination.rb', line 63

def additional_properties
  @additional_properties
end

#auth_strategy ⇒ Object

The authentication strategy to use for outgoing Prometheus Remote Write requests.



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

def auth_strategy
  @auth_strategy
end

#buffer ⇒ Object

Configuration for buffer settings on destination components.



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

def buffer
  @buffer
end

#default_namespace ⇒ Object

The default namespace to add as a prefix to metric names that do not already have one.



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

def default_namespace
  @default_namespace
end

#endpoint_url_key ⇒ Object

Name of the environment variable or secret that holds the Prometheus Remote Write endpoint URL. Defaults to DESTINATION_PROMETHEUS_REMOTE_WRITE_ENDPOINT_URL (prefixed with DD_OP_ at runtime).



37
38
39
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_prometheus_remote_write_destination.rb', line 37

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).



40
41
42
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_prometheus_remote_write_destination.rb', line 40

def id
  @id
end

#inputs ⇒ Object

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



43
44
45
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_prometheus_remote_write_destination.rb', line 43

def inputs
  @inputs
end

#password_key ⇒ Object

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



46
47
48
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_prometheus_remote_write_destination.rb', line 46

def password_key
  @password_key
end

#tenant_id ⇒ Object

The tenant ID to include with outgoing requests. Used by multi-tenant Prometheus Remote Write receivers.



49
50
51
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_prometheus_remote_write_destination.rb', line 49

def tenant_id
  @tenant_id
end

#tls ⇒ Object

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



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

def tls
  @tls
end

#token_key ⇒ Object

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



55
56
57
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_prometheus_remote_write_destination.rb', line 55

def token_key
  @token_key
end

#type ⇒ Object

The destination type. The value should always be prometheus_remote_write.



58
59
60
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_prometheus_remote_write_destination.rb', line 58

def type
  @type
end

#username_key ⇒ Object

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



61
62
63
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_prometheus_remote_write_destination.rb', line 61

def username_key
  @username_key
end