PrometheusEmitterDataSource

class oci.management_agent.models.PrometheusEmitterDataSource(**kwargs)

Bases: DataSource

A Prometheus data source.

Attributes:

STATE_ACTIVE

A constant which can be used with the state property of a DataSource.

STATE_CREATING

A constant which can be used with the state property of a DataSource.

STATE_DELETED

A constant which can be used with the state property of a DataSource.

STATE_DELETING

A constant which can be used with the state property of a DataSource.

STATE_FAILED

A constant which can be used with the state property of a DataSource.

STATE_INACTIVE

A constant which can be used with the state property of a DataSource.

STATE_TERMINATED

A constant which can be used with the state property of a DataSource.

STATE_UPDATING

A constant which can be used with the state property of a DataSource.

TYPE_KUBERNETES_CLUSTER

A constant which can be used with the type property of a DataSource.

TYPE_PROMETHEUS_EMITTER

A constant which can be used with the type property of a DataSource.

allow_metrics

Gets the allow_metrics of this PrometheusEmitterDataSource.

compartment_id

[Required] Gets the compartment_id of this DataSource.

connection_timeout

Gets the connection_timeout of this PrometheusEmitterDataSource.

key

[Required] Gets the key of this DataSource.

metric_dimensions

Gets the metric_dimensions of this PrometheusEmitterDataSource.

name

[Required] Gets the name of this DataSource.

namespace

[Required] Gets the namespace of this PrometheusEmitterDataSource.

proxy_url

Gets the proxy_url of this PrometheusEmitterDataSource.

read_data_limit

Gets the read_data_limit of this PrometheusEmitterDataSource.

read_timeout

Gets the read_timeout of this PrometheusEmitterDataSource.

resource_group

Gets the resource_group of this PrometheusEmitterDataSource.

schedule_mins

Gets the schedule_mins of this PrometheusEmitterDataSource.

state

[Required] Gets the state of this DataSource.

time_created

[Required] Gets the time_created of this DataSource.

time_updated

[Required] Gets the time_updated of this DataSource.

type

[Required] Gets the type of this DataSource.

url

[Required] Gets the url of this PrometheusEmitterDataSource.

Methods:

__init__(**kwargs)

Initializes a new PrometheusEmitterDataSource object with values from keyword arguments.

get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the state property of a DataSource. This constant has a value of “ACTIVE”

STATE_CREATING = 'CREATING'

A constant which can be used with the state property of a DataSource. This constant has a value of “CREATING”

STATE_DELETED = 'DELETED'

A constant which can be used with the state property of a DataSource. This constant has a value of “DELETED”

STATE_DELETING = 'DELETING'

A constant which can be used with the state property of a DataSource. This constant has a value of “DELETING”

STATE_FAILED = 'FAILED'

A constant which can be used with the state property of a DataSource. This constant has a value of “FAILED”

STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the state property of a DataSource. This constant has a value of “INACTIVE”

STATE_TERMINATED = 'TERMINATED'

A constant which can be used with the state property of a DataSource. This constant has a value of “TERMINATED”

STATE_UPDATING = 'UPDATING'

A constant which can be used with the state property of a DataSource. This constant has a value of “UPDATING”

TYPE_KUBERNETES_CLUSTER = 'KUBERNETES_CLUSTER'

A constant which can be used with the type property of a DataSource. This constant has a value of “KUBERNETES_CLUSTER”

TYPE_PROMETHEUS_EMITTER = 'PROMETHEUS_EMITTER'

A constant which can be used with the type property of a DataSource. This constant has a value of “PROMETHEUS_EMITTER”

__init__(**kwargs)

Initializes a new PrometheusEmitterDataSource object with values from keyword arguments. The default value of the type attribute of this class is PROMETHEUS_EMITTER and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • key (str) – The value to assign to the key property of this PrometheusEmitterDataSource.

  • type (str) – The value to assign to the type property of this PrometheusEmitterDataSource. Allowed values for this property are: “KUBERNETES_CLUSTER”, “PROMETHEUS_EMITTER”

  • name (str) – The value to assign to the name property of this PrometheusEmitterDataSource.

  • compartment_id (str) – The value to assign to the compartment_id property of this PrometheusEmitterDataSource.

  • state (str) – The value to assign to the state property of this PrometheusEmitterDataSource. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “TERMINATED”, “DELETING”, “DELETED”, “FAILED”

  • time_created (datetime) – The value to assign to the time_created property of this PrometheusEmitterDataSource.

  • time_updated (datetime) – The value to assign to the time_updated property of this PrometheusEmitterDataSource.

  • url (str) – The value to assign to the url property of this PrometheusEmitterDataSource.

  • namespace (str) – The value to assign to the namespace property of this PrometheusEmitterDataSource.

  • allow_metrics (str) – The value to assign to the allow_metrics property of this PrometheusEmitterDataSource.

  • proxy_url (str) – The value to assign to the proxy_url property of this PrometheusEmitterDataSource.

  • connection_timeout (int) – The value to assign to the connection_timeout property of this PrometheusEmitterDataSource.

  • read_timeout (int) – The value to assign to the read_timeout property of this PrometheusEmitterDataSource.

  • read_data_limit (int) – The value to assign to the read_data_limit property of this PrometheusEmitterDataSource.

  • schedule_mins (int) – The value to assign to the schedule_mins property of this PrometheusEmitterDataSource.

  • resource_group (str) – The value to assign to the resource_group property of this PrometheusEmitterDataSource.

  • metric_dimensions (list[oci.management_agent.models.MetricDimension]) – The value to assign to the metric_dimensions property of this PrometheusEmitterDataSource.

property allow_metrics

Gets the allow_metrics of this PrometheusEmitterDataSource. Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required.

Returns

The allow_metrics of this PrometheusEmitterDataSource.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this DataSource. Compartment owning this DataSource.

Returns

The compartment_id of this DataSource.

Return type

str

property connection_timeout

Gets the connection_timeout of this PrometheusEmitterDataSource. Number in milliseconds. The timeout for connecting to the Prometheus Exporter’s endpoint.

Returns

The connection_timeout of this PrometheusEmitterDataSource.

Return type

int

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property key

[Required] Gets the key of this DataSource. Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.

Returns

The key of this DataSource.

Return type

str

property metric_dimensions

Gets the metric_dimensions of this PrometheusEmitterDataSource. The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.

Returns

The metric_dimensions of this PrometheusEmitterDataSource.

Return type

list[oci.management_agent.models.MetricDimension]

property name

[Required] Gets the name of this DataSource. Unique name of the DataSource.

Returns

The name of this DataSource.

Return type

str

property namespace

[Required] Gets the namespace of this PrometheusEmitterDataSource. The OCI monitoring namespace to which scraped metrics should be uploaded.

Returns

The namespace of this PrometheusEmitterDataSource.

Return type

str

property proxy_url

Gets the proxy_url of this PrometheusEmitterDataSource. The url of the network proxy that provides access to the Prometheus Exporter’s endpoint (url required property).

Returns

The proxy_url of this PrometheusEmitterDataSource.

Return type

str

property read_data_limit

Gets the read_data_limit of this PrometheusEmitterDataSource. Number in kilobytes. The limit on the data being sent, not to exceed the agent’s fixed limit of 400 (KB).

Returns

The read_data_limit of this PrometheusEmitterDataSource.

Return type

int

property read_timeout

Gets the read_timeout of this PrometheusEmitterDataSource. Number in milliseconds. The timeout for reading the response from the Prometheus Exporter’s endpoint.

Returns

The read_timeout of this PrometheusEmitterDataSource.

Return type

int

property resource_group

Gets the resource_group of this PrometheusEmitterDataSource. OCI monitoring resource group to assign the metric to.

Returns

The resource_group of this PrometheusEmitterDataSource.

Return type

str

property schedule_mins

Gets the schedule_mins of this PrometheusEmitterDataSource. Number in minutes. The scraping occurs at the specified interval.

Returns

The schedule_mins of this PrometheusEmitterDataSource.

Return type

int

property state

[Required] Gets the state of this DataSource. State of the DataSource.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “TERMINATED”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The state of this DataSource.

Return type

str

property time_created

[Required] Gets the time_created of this DataSource. The time the DataSource was created. An RFC3339 formatted datetime string

Returns

The time_created of this DataSource.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this DataSource. The time the DataSource data was last received. An RFC3339 formatted datetime string

Returns

The time_updated of this DataSource.

Return type

datetime

property type

[Required] Gets the type of this DataSource. The type of the DataSource.

Allowed values for this property are: “KUBERNETES_CLUSTER”, “PROMETHEUS_EMITTER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The type of this DataSource.

Return type

str

property url

[Required] Gets the url of this PrometheusEmitterDataSource. The url through which the Prometheus Exporter publishes its metrics. (http only)

Returns

The url of this PrometheusEmitterDataSource.

Return type

str