Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitoringClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • MonitoringClient

Constructors

constructor

  • new MonitoringClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): MonitoringClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

targetService

targetService: string = "Monitoring"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://telemetry.{region}.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

changeAlarmCompartment

close

  • close(): void

createAlarm

  • Creates a new alarm in the specified compartment. For more information, see Creating an Alarm. For important limits information, see Limits on Monitoring.

    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateAlarm API.

    Parameters

    Returns Promise<CreateAlarmResponse>

    CreateAlarmResponse

createAlarmSuppression

  • Creates a dimension-specific suppression for an alarm.

    For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).

    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateAlarmSuppression API.

    Parameters

    Returns Promise<CreateAlarmSuppressionResponse>

    CreateAlarmSuppressionResponse

createWaiters

  • Creates a new MonitoringWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns MonitoringWaiter

    The service waiters.

deleteAlarm

  • Deletes the specified alarm. For more information, see Deleting an Alarm. For important limits information, see Limits on Monitoring.

    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteAlarm API.

    Parameters

    Returns Promise<DeleteAlarmResponse>

    DeleteAlarmResponse

deleteAlarmSuppression

  • Deletes the specified alarm suppression.

    For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).

    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteAlarmSuppression API.

    Parameters

    Returns Promise<DeleteAlarmSuppressionResponse>

    DeleteAlarmSuppressionResponse

getAlarm

  • Gets the specified alarm. For more information, see Getting an Alarm. For important limits information, see Limits on Monitoring.

    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAlarm API.

    Parameters

    Returns Promise<GetAlarmResponse>

    GetAlarmResponse

getAlarmHistory

  • Get the history of the specified alarm. For more information, see Getting History of an Alarm. For important limits information, see Limits on Monitoring.

    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAlarmHistory API.

    Parameters

    Returns Promise<GetAlarmHistoryResponse>

    GetAlarmHistoryResponse

getAlarmSuppression

  • Gets the specified alarm suppression.

    For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).

    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAlarmSuppression API.

    Parameters

    Returns Promise<GetAlarmSuppressionResponse>

    GetAlarmSuppressionResponse

getWaiters

listAlarmSuppressions

  • Lists alarm suppressions for the specified alarm. Only dimension-level suppressions are listed. Alarm-level suppressions are not listed.

    For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).

    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAlarmSuppressions API.

    Parameters

    Returns Promise<ListAlarmSuppressionsResponse>

    ListAlarmSuppressionsResponse

listAlarms

  • Lists the alarms for the specified compartment. For more information, see Listing Alarms. For important limits information, see Limits on Monitoring.

    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAlarms API.

    Parameters

    Returns Promise<ListAlarmsResponse>

    ListAlarmsResponse

listAlarmsRecordIterator

  • Creates a new async iterator which will iterate over the models.AlarmSummary objects contained in responses from the listAlarms operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AlarmSummary>

listAlarmsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listAlarms operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListAlarmsResponse>

listAlarmsStatus

  • List the status of each alarm in the specified compartment. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use {@link #retrieveDimensionStates(RetrieveDimensionStatesRequest) retrieveDimensionStates}. Optionally filter by resource or status value. For more information, see Listing Alarm Statuses. For important limits information, see Limits on Monitoring.

    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAlarmsStatus API.

    Parameters

    Returns Promise<ListAlarmsStatusResponse>

    ListAlarmsStatusResponse

listAlarmsStatusRecordIterator

  • Creates a new async iterator which will iterate over the models.AlarmStatusSummary objects contained in responses from the listAlarmsStatus operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AlarmStatusSummary>

listAlarmsStatusResponseIterator

listAllAlarms

  • NOTE: This function is deprecated in favor of listAlarmsRecordIterator function. Creates a new async iterator which will iterate over the models.AlarmSummary objects contained in responses from the listAlarms operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AlarmSummary>

listAllAlarmsResponses

  • NOTE: This function is deprecated in favor of listAlarmsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listAlarms operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListAlarmsResponse>

listAllAlarmsStatus

  • NOTE: This function is deprecated in favor of listAlarmsStatusRecordIterator function. Creates a new async iterator which will iterate over the models.AlarmStatusSummary objects contained in responses from the listAlarmsStatus operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AlarmStatusSummary>

listAllAlarmsStatusResponses

  • NOTE: This function is deprecated in favor of listAlarmsStatusResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listAlarmsStatus operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListAlarmsStatusResponse>

listAllMetrics

  • NOTE: This function is deprecated in favor of listMetricsRecordIterator function. Creates a new async iterator which will iterate over the models.Metric objects contained in responses from the listMetrics operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Metric>

listAllMetricsResponses

  • NOTE: This function is deprecated in favor of listMetricsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listMetrics operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListMetricsResponse>

listMetrics

listMetricsRecordIterator

  • Creates a new async iterator which will iterate over the models.Metric objects contained in responses from the listMetrics operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Metric>

listMetricsResponseIterator

postMetricData

  • Publishes raw metric data points to the Monitoring service. For a data point to be posted, its timestamp must be near current time (less than two hours in the past and less than 10 minutes in the future).

    For more information about publishing metrics, see [Publishing Custom Metrics](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/publishingcustommetrics.htm) and [Custom Metrics Walkthrough](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/custom-metrics-walkthrough.htm). For information about developing a metric-posting client, see [Developer Guide](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/devtoolslanding.htm). For an example client, see [MonitoringMetricPostExample.java](https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/MonitoringMetricPostExample.java). For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).

    Per-call limits information follows.

    Dimensions per metric group*. Maximum: 20. Minimum: 1. * Unique metric streams*. Maximum: 50. * Transactions Per Second (TPS) per-tenancy limit for this operation: 50.

    A metric group is the combination of a given metric, metric namespace, and tenancy for the purpose of determining limits. A dimension is a qualifier provided in a metric definition. A metric stream is an individual set of aggregated data for a metric with zero or more dimension values. For more information about metric-related concepts, see [Monitoring Concepts](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#concepts).

    *Note:** The endpoints for this operation differ from other Monitoring operations. Replace the string `telemetry` with `telemetry-ingestion` in the endpoint, as in the following example:

    https://telemetry-ingestion.eu-frankfurt-1.oraclecloud.com

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use PostMetricData API.

    Parameters

    Returns Promise<PostMetricDataResponse>

    PostMetricDataResponse

removeAlarmSuppression

  • Removes any existing suppression for the specified alarm. For more information, see Removing Suppression from an Alarm. For important limits information, see Limits on Monitoring.

    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RemoveAlarmSuppression API.

    Parameters

    Returns Promise<RemoveAlarmSuppressionResponse>

    RemoveAlarmSuppressionResponse

retrieveDimensionStates

  • Lists the current alarm status of each metric stream, where status is derived from the metric stream's last associated transition. Optionally filter by status value and one or more dimension key-value pairs. For more information, see Listing Metric Stream Status in an Alarm.

    For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).

    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RetrieveDimensionStates API.

    Parameters

    Returns Promise<RetrieveDimensionStatesResponse>

    RetrieveDimensionStatesResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

summarizeAlarmSuppressionHistory

  • Returns history of suppressions for the specified alarm, including both dimension-specific and and alarm-wide suppressions.

    For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).

    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeAlarmSuppressionHistory API.

    Parameters

    Returns Promise<SummarizeAlarmSuppressionHistoryResponse>

    SummarizeAlarmSuppressionHistoryResponse

summarizeMetricsData

updateAlarm

  • Updates the specified alarm. For more information, see Updating an Alarm. For important limits information, see Limits on Monitoring.

    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateAlarm API.

    Parameters

    Returns Promise<UpdateAlarmResponse>

    UpdateAlarmResponse