Stage variables are name-value pairs that are defined as configuration attributes. These variables are associated with a deployment stage of a REST API, act like environment variables, and can be used in your API setup and mapping templates.

For example, you can define a stage variable in a stage configuration, and set its value as the URL string of an HTTP integration for a method in your REST API. Later, you can reference the URL string using the associated stage variable name from the API setup.

Use the AWS public cloud integration to discover and collect metrics against the AWS service.

External reference

Setting up stage variables for a REST API deployment

Setup

To set up the AWS integration and discover the AWS service, go to AWS Integration Discovery Profile and select API Gateway Stage.

Event support

CloudTrail event support

  • Not supported

CloudWatch alarm support

  • Supported
  • Configurable in OpsRamp AWS Integration Discovery Profile.

Supported metrics

OpsRamp MetricMetric Display NameUnitAggregation Type
aws_apigateway_4XXError

Number of client-side errors captured.
4XXErrorCountAverage
aws_apigateway_5XXError

Number of server-side errors captured.
5XXErrorCountAverage
aws_apigateway_Count

Number of calls to API methods.
CountCountAverage
aws_apigateway_Latency

Time between when API Gateway receives a request from a client and when it returns a response to the client.
LatencyMillisecondAverage