Skip to content

Latest commit

 

History

History
164 lines (125 loc) · 3.88 KB

aws-api-gateway-v2-monitoring-integration.mdx

File metadata and controls

164 lines (125 loc) · 3.88 KB
title tags metaDescription freshnessValidatedDate
Amazon API Gateway HTTP and Websockets (v2) Monitoring Integration
Integrations
Amazon integrations
AWS integrations list
New Relic's AWS API Gateway v2 monitoring integration: what data it reports, and how to enable it.
2024-02-01

New Relic infrastructure integrations now include an integration for AWS API Gateway v2, sending its metrics data to New Relic.

This document explains the integration's features, how to activate it, and what data you can report.

Features [#features]

Collect and send telemetry data to New Relic from your Amazon API Gateway v2 using our integration. Check your services, query incoming data, and build dashboards to observe everything at a glance.

Activate integration [#activate-integration]

To enable this integration, see how to connect AWS services to New Relic.

Find and use data [#find-use-data]

To find your integration's metrics, go to one.newrelic.com > Metrics & Events and filter by aws.apigateway.

Metric data [#metric-data]

This New Relic infrastructure integration collects the following Amazon API Gateway v2 metrics:

Amazon API Gateway v2 Metric data [#table-of-metrics]

  <td>
    The number of client-side errors captured in a given period.
  </td>
</tr>

<tr>
  <td>
    `5xx`
  </td>

  <td>
    The number of server-side errors captured in a given period.
  </td>
</tr>

<tr>
  <td>
    `Count`
  </td>

  <td>
    The total number API requests in a given period.
  </td>
</tr>

<tr>
  <td>
    `IntegrationLatency`
  </td>

  <td>
    The time between when API Gateway relays a request to the backend and when it receives a response from the backend.
  </td>
</tr>

<tr>
  <td>
    `Latency`
  </td>

  <td>
    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.
  </td>
</tr>

<tr>
  <td>
    `DataProcessed`
  </td>

  <td>
    The amount of data processed in bytes.
  </td>
</tr>
Metric 
  </th>

  <th>
    Description
  </th>
</tr>
`4xx`

Dimensions [#dimensions]

You can use the dimensions in the following table to filter API Gateway metrics.

  <th>
    Description
  </th>
</tr>

  <td>
    ilters API Gateway metrics for an API with the specified API ID.
  </td>
</tr>

<tr>
  <td>
    `ApiId`, `Stage`
  </td>

  <td>
    Filters API Gateway metrics for an API stage with the specified API ID and stage ID.
  </td>
</tr>

<tr>
  <td>
    `ApiId`, `Stage`,`Route`
  </td>

  <td>
    Filters API Gateway metrics for an API method with the specified API ID, stage ID, and route ID.
  </td>
</tr>
Dimensions
`ApiId`

Create alerts [#create-alerts]

You can set up alerts to receive a notification if there are any changes. For example, you can set up an alert to get a notification about relevant parties of critical or fatal errors.

Learn more about creating alerts here.