Login
    Contents x
    Amazon API Gateway (Device Type)
    • 11 Jan 2023
    • 3 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Amazon API Gateway (Device Type)

    • Updated on 11 Jan 2023
    • 3 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Description

    Amazon API Gateway is an AWS service for creating, publishing, maintaining, monitoring, and securing REST, HTTP, and WebSocket APIs at any scale.

    The Amazon API Gateway device type allows you to monitor a variety of statistics from an Amazon API Gateway.

    Device License Value: 0.1 (See Device Licenses for more information.)

    Collected Statistics

    Additional Cost Alert
    Enabling these metrics will incur additional charges to your account. For pricing information, see Amazon CloudWatch Pricing.

    Netreo collects and stores the following statistics for the Amazon API Gateway device type.

    See Data Retention for information on how long this data is stored in Netreo.

    StatisticDescription
    4XXError

    The number of client-side errors captured in a given period.

    The Sum statistic represents this metric, namely, the total count of the 4XXError errors in the given period. The Average statistic represents the 4XXError error rate, namely, the total count of the 4XXError errors divided by the total number of requests during the period. The denominator corresponds to the Count metric (below).

    Unit: Count

    5XXError

    The number of server-side errors captured in a given period.

    The Sum statistic represents this metric, namely, the total count of the 5XXError errors in the given period. The Average statistic represents the 5XXError error rate, namely, the total count of the 5XXError errors divided by the total number of requests during the period. The denominator corresponds to the Count metric (below).

    Unit: Count

    CacheHitCount

    The number of requests served from the API cache in a given period.

    The Sum statistic represents this metric, namely, the total count of the cache hits in the given period. The Average statistic represents the cache hit rate, namely, the total count of the cache hits divided by the total number of requests during the period. The denominator corresponds to the Count metric (below).

    Unit: Count

    CacheMissCount

    The number of requests served from the backend in a given period, when API caching is enabled.

    The Sum statistic represents this metric, namely, the total count of the cache misses in the given period. The Average statistic represents the cache miss rate, namely, the total count of the cache misses divided by the total number of requests during the period. The denominator corresponds to the Count metric (below).

    Unit: Count

    Count

    The total number API requests in a given period.

    The SampleCount statistic represents this metric.

    Unit: Count

    IntegrationLatency

    The time between when API Gateway relays a request to the backend and when it receives a response from the backend.

    Unit: Millisecond

    Latency

    The 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.

    Unit: Millisecond

    See Amazon's documentation for more information about these statistics: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-metrics-and-dimensions.html

    Requirements

    Netreo Configuration

    In order for Netreo to retrieve statistics for an Amazon API Gateway device type, you must add the appropriate credentials for your Amazon account.

    1. Log in to Netreo as a user with the SuperAdmin access level.
    2. Go to the main menu and select Administration > Modules > Cloud Monitoring to open the Cloud Monitoring Administration page.
    3. In the "Amazon Web Services" section select Add AWS.
    4. Enter the account information provided by Amazon for the account that contains the Amazon API Gateway that you wish to monitor.
    5. Select Save.
    6. Repeat for each Amazon account you wish to add.
    7. Move on to External Configuration below.

    External Configuration

    You must configure your AWS account to send statistics for each resource you wish to monitor.

    For HTTP APIs

    1. Log in to your AWS account.
    2. Navigate to the AWS Management Console and go to API Gateway.
    3. In the API list, select the name of the HTTP API for which you wish to enable metrics.
    4. Select the metric on the left side and select a stage.
    5. Enable the Detailed Route Metrics option.
    6. Deploy the API.

    For RESTful APIs

    1. Log in to your AWS account.
    2. Navigate to the AWS Management Console and go to API Gateway.
    3. In the API list, select the name of the RESTful API for which you wish to enable metrics.
    4. On the left select a stage.
    5. Select the Logs/Tracing tab.
    6. Select the Enable Detailed CloudWatch Metrics checkbox.
    7. Save the changes.
    Was this article helpful?
    What's Next
    PLATFORM
    WHY NETREO?
    SOLUTIONS BY INITIATIVE
    SOLUTIONS BY INDUSTRY
    SOLUTIONS BY JOB FUNCTION
    Change password!
    Changing your password will log you out immediately. Use the new password to log back in.
    Change profile
    Success!
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    Logout