Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ImportOciTelemetryResourcesTaskDetails

Request details for importing resources from Telemetry like resources from OCI Native Services and prometheus.

Properties

Optional availabilityProxyMetricCollectionInterval

availabilityProxyMetricCollectionInterval: undefined | number

Metrics collection interval in seconds used when calculating the availability of the resource based on metrics specified using the property 'availabilityProxyMetrics'. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional availabilityProxyMetrics

availabilityProxyMetrics: Array<string>

List of metrics to be used to calculate the availability of the resource. Resource is considered to be up if at least one of the specified metrics is available for the resource during the specified interval using the property 'availabilityProxyMetricCollectionIntervalInSeconds'. If no metrics are specified, availability will not be calculated for the resource.

Optional consolePathPrefix

consolePathPrefix: undefined | string

The console path prefix to use for providing service home url page navigation. For example if the prefix provided is 'security/bastion/bastions', the URL used for navigation will be https:///security/bastion/bastions/. If not provided, service home page link will not be shown in the stack monitoring home page.

Optional externalIdMapping

externalIdMapping: undefined | string

The external resource identifier property in the metric dimensions. Resources imported will be using this property value for external id.

Optional lifecycleStatusMappingsForUpStatus

lifecycleStatusMappingsForUpStatus: Array<string>

Lifecycle states of the external resource which reflects the status of the resource being up.

namespace

namespace: string

Name space to be used for OCI Native service resources discovery.

Optional resourceGroup

resourceGroup: undefined | string

The resource group to use while fetching metrics from telemetry. If not specified, resource group will be skipped in the list metrics request.

Optional resourceNameFilter

resourceNameFilter: undefined | string

The resource name filter. Resources matching with the resource name filter will be imported. Regular expressions will be accepted.

Optional resourceNameMapping

resourceNameMapping: undefined | string

The resource name property in the metric dimensions. Resources imported will be using this property value for resource name.

Optional resourceTypeFilter

resourceTypeFilter: undefined | string

The resource type filter. Resources matching with the resource type filter will be imported. Regular expressions will be accepted.

Optional resourceTypeMapping

resourceTypeMapping: undefined | string

The resource type property in the metric dimensions. Resources imported will be using this property value for resource type. If not specified, namespace will be used for resource type.

Optional serviceBaseUrl

serviceBaseUrl: undefined | string

The base URL of the OCI service to which the resource belongs to. Also this property is applicable only when source is OCI_TELEMETRY_NATIVE.

Optional shouldUseMetricsFlowForStatus

shouldUseMetricsFlowForStatus: undefined | false | true

Flag to indicate whether status is calculated using metrics or LifeCycleState attribute of the resource in OCI service.

source

source: Source

Source from where the metrics pushed to telemetry. Possible values:

  • OCI_TELEMETRY_NATIVE - The metrics are pushed to telemetry from OCI Native Services.
  • OCI_TELEMETRY_PROMETHEUS - The metrics are pushed to telemetry from Prometheus.

Const type

type: string = "IMPORT_OCI_TELEMETRY_RESOURCES"

Methods

getDeserializedJsonObj

getJsonObj