Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace PrometheusEmitterDataSource

A Prometheus data source.

Properties

Optional allowMetrics

allowMetrics: undefined | string

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

compartmentId

compartmentId: string

Compartment owning this DataSource.

Optional connectionTimeout

connectionTimeout: undefined | number

Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

key

key: string

Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.

Optional metricDimensions

metricDimensions: Array<MetricDimension>

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

name

name: string

Unique name of the DataSource.

namespace

namespace: string

The OCI monitoring namespace to which scraped metrics should be uploaded.

Optional proxyUrl

proxyUrl: undefined | string

The url of the network proxy that provides access to the Prometheus Exporter's endpoint (url required property).

Optional readDataLimit

readDataLimit: undefined | number

Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB). Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional readTimeout

readTimeout: undefined | number

Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional resourceGroup

resourceGroup: undefined | string

OCI monitoring resource group to assign the metric to.

Optional scheduleMins

scheduleMins: undefined | number

Number in minutes. The scraping occurs at the specified interval. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

state

State of the DataSource.

timeCreated

timeCreated: Date

The time the DataSource was created. An RFC3339 formatted datetime string

timeUpdated

timeUpdated: Date

The time the DataSource data was last received. An RFC3339 formatted datetime string

Const type

type: string = "PROMETHEUS_EMITTER"

url

url: string

The url through which the Prometheus Exporter publishes its metrics. (http only)

Methods

getDeserializedJsonObj

getJsonObj