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.

Resource Information:

  • Type of Resource: Generic monitorable resource
  • Discovery type: AWS SDK discovery type
  • Discovery profile selection: Resource can be discovered by “API Gateway Stage” in the profiler
  • ResourceTag: AWS_APIGATEWAY_STAGE
  • Resource Unique Identification: APIId+"-"+stageName (api.id()+"-"+stageName)
  • Dependencies: API Gateway Stage runs on API Gateway and may connect to various deployment environments

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 MetricAWS MetricMetric Display NameUnitAggregation TypeDescription
aws_apigateway_4XXError4XXError4XX ErrorCountSumThe number of client-side errors captured in a given period.
aws_apigateway_5XXError5XXError5XX ErrorCountSumThe number of server-side errors captured in a given period.
aws_apigateway_CountCountCountCountSampleCountThe total number API requests in a given period.
aws_apigateway_LatencyLatencyLatencyMillisecondsAverageThe time between when API Gateway receives a request from a client and when it returns a response to the client. The latency includes the integration latency and other API Gateway overhead.