Skip to content

Latest commit

 

History

History
616 lines (501 loc) · 15.5 KB

File metadata and controls

616 lines (501 loc) · 15.5 KB
title tags metaDescription redirects
AWS IoT monitoring integration
Integrations
Amazon integrations
AWS integrations list
New Relic's AWS IoT monitoring integration: what data it reports, and how to enable it.
/docs/integrations/amazon-integrations/aws-integrations-list/aws-iot-monitoring-integration
/docs/aws-iot-integration
/docs/aws-iot-monitoring-integration

New Relic offers an integration for reporting your AWS IoT metric data.

AWS IoT is a service that provides communication between Internet-connected devices and the AWS Cloud. It also collects and stores telemetry data. With the AWS IoT Infrastructure integration, you can access these features:

  • View charts and other information about your AWS IoT communication and telemetry data.
  • Create custom queries and charts in New Relic from automatically captured metric data.
  • Set alert conditions on your AWS IoT integration data directly from the New Relic Integrations page.

Activate integration [#connect]

To enable this integration follow standard procedures to Connect AWS services to New Relic.

Configuration and polling [#polling]

By default, New Relic queries your AWS IoT services every 5 minutes. If you want New Relic to query your services less often, you can change the polling frequency.

Explore integration data [#find-data]

After connecting the AWS IoT integration to New Relic and waiting a few minutes, you can use integration data:

  <th>
    Do this
  </th>
</tr>
  <td>
    Go to [**one.newrelic.com**](http://one.newrelic.com) **> Infrastructure > AWS** **> IoT**.
  </td>
</tr>

<tr>
  <td>
    [Metric data](#metrics) on custom dashboards
  </td>

  <td>
    Go to the [query builder](/docs/query-your-data/explore-query-data/query-builder/query-builder-basic-mode) and create queries for `IOTBrokerSample`, `IOTRuleActionSample`, and `IOTRuleSample` events.
  </td>
</tr>
View AWS IoT integrations data
Dashboards and [alerts](/docs/infrastructure/new-relic-infrastructure/infrastructure-alert-conditions/infrastructure-alerts-add-edit-or-view-host-alert-information#integration)

Metric data [#metrics]

To view metric data for your AWS IoT integration, create NRQL queries for IOTBrokerSample, IOTRuleActionSample, and IOTRuleSample events and their related attributes. For more information on AWS IoT metrics and dimensions, see the AWS IoT Developer Guide.

Query `IOTBrokerSample` events to view data for the following attributes:
<table>
  <thead>
    <tr>
      <th style={{ width: "250px" }}>
        Name
      </th>

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

  <tbody>
    <tr>
      <td>
        `connect.AuthError`
      </td>

      <td>
        Number of connection requests that the message broker could not authorize.
      </td>
    </tr>

    <tr>
      <td>
        `connect.ClientError`
      </td>

      <td>
        Number of connection requests rejected because the MQTT message did not meet the [AWS IoT requirements](http://docs.aws.amazon.com/iot/latest/developerguide/iot-limits.html).
      </td>
    </tr>

    <tr>
      <td>
        `connect.ServerError`
      </td>

      <td>
        Number of connection requests that failed because of an internal error.
      </td>
    </tr>

    <tr>
      <td>
        `connect.Success`
      </td>

      <td>
        Number of successful connections to the message broker.
      </td>
    </tr>

    <tr>
      <td>
        `connect.Throttle`
      </td>

      <td>
        Number of connection requests that were throttled because the client exceeded the allowed connect request rate.
      </td>
    </tr>

    <tr>
      <td>
        `ping.Success`
      </td>

      <td>
        Number of ping messages that the message broker received.
      </td>
    </tr>

    <tr>
      <td>
        `publishIn.AuthError`
      </td>

      <td>
        Number of publish requests that the message broker could not authorize.
      </td>
    </tr>

    <tr>
      <td>
        `publishIn.ClientError`
      </td>

      <td>
        Number of publish requests that the message broker rejected because the message did not meet the [AWS IoT requirements](http://docs.aws.amazon.com/iot/latest/developerguide/iot-limits.html).
      </td>
    </tr>

    <tr>
      <td>
        `publishIn.ServerError`
      </td>

      <td>
        Number of publish requests that the message broker failed to process because of an internal error.
      </td>
    </tr>

    <tr>
      <td>
        `publishIn.Success`
      </td>

      <td>
        Number of publish requests that the message broker successfully processed.
      </td>
    </tr>

    <tr>
      <td>
        `publishIn.Throttle`
      </td>

      <td>
        Number of publish requests that were throttled because the client exceeded the allowed inbound message rate.
      </td>
    </tr>

    <tr>
      <td>
        `publishOut.AuthError`
      </td>

      <td>
        Number of publish requests that the message broker made that could not be authorized by AWS IoT.
      </td>
    </tr>

    <tr>
      <td>
        `publishOut.ClientError`
      </td>

      <td>
        Number of publish requests that the message broker made that were rejected because the message did not meet the [AWS IoT requirements](http://docs.aws.amazon.com/iot/latest/developerguide/iot-limits.html).
      </td>
    </tr>

    <tr>
      <td>
        `publishOut.Success`
      </td>

      <td>
        Number of publish requests that the message broker successfully made.
      </td>
    </tr>

    <tr>
      <td>
        `subscribe.AuthError`
      </td>

      <td>
        Number of subscription requests made by a client that could not be authorized.
      </td>
    </tr>

    <tr>
      <td>
        `subscribe.ClientError`
      </td>

      <td>
        Number of subscribe requests that were rejected because the `SUBSCRIBE` message did not meet the [AWS IoT requirements](http://docs.aws.amazon.com/iot/latest/developerguide/iot-limits.html).
      </td>
    </tr>

    <tr>
      <td>
        `subscribe.ServerError`
      </td>

      <td>
        Number of subscribe requests that were rejected because of an internal error.
      </td>
    </tr>

    <tr>
      <td>
        `subscribe.Success`
      </td>

      <td>
        Number of subscribe requests that the message broker successfully processed.
      </td>
    </tr>

    <tr>
      <td>
        `subscribe.Throttle`
      </td>

      <td>
        Number of subscribe requests that were throttled because the client exceeded the allowed subscribe request rate.
      </td>
    </tr>

    <tr>
      <td>
        `unsubscribe.ClientError`
      </td>

      <td>
        Number of unsubscribe requests that were rejected because the `UNSUBSCRIBE` message did not meet the [AWS IoT requirements](http://docs.aws.amazon.com/iot/latest/developerguide/iot-limits.html).
      </td>
    </tr>

    <tr>
      <td>
        `unsubscribe.ServerError`
      </td>

      <td>
        Number of unsubscribe requests that were rejected because of an internal error.
      </td>
    </tr>

    <tr>
      <td>
        `unsubscribe.Success`
      </td>

      <td>
        Number of unsubscribe requests that the message broker successfully processed.
      </td>
    </tr>

    <tr>
      <td>
        `unsubscribe.Throttle`
      </td>

      <td>
        Number of unsubscribe requests that were rejected because the client exceeded the allowed unsubscribe request rate.
      </td>
    </tr>

    <tr>
      <td>
        `deleteThingShadow.Accepted`
      </td>

      <td>
        Number of `DeleteThingShadow` requests processed successfully.
      </td>
    </tr>

    <tr>
      <td>
        `getThingShadow.Accepted`
      </td>

      <td>
        Number of `GetThingShadow` requests processed successfully.
      </td>
    </tr>

    <tr>
      <td>
        `updateThingShadow.Accepted`
      </td>

      <td>
        Number of `UpdateThingShadow` requests processed successfully.
      </td>
    </tr>
  </tbody>
</table>

<Collapser id="iotruleactionsample" title="IOTRuleActionSample events"

Query `IOTRuleActionSample` events to view data for the following attributes:

<table>
  <thead>
    <tr>
      <th style={{ width: "250px" }}>
        Name
      </th>

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

  <tbody>
    <tr>
      <td>
        `success`
      </td>

      <td>
        Number of successful rule action invocations. The `RuleName` dimension contains the name of the rule that specifies the action that was invoked. The `ActionType` dimension contains the type of action that was invoked.
      </td>
    </tr>

    <tr>
      <td>
        `failure`
      </td>

      <td>
        Number of failed rule action invocations. The `RuleName` dimension contains the name of the rule that specifies the action that was invoked. The `RuleName`dimension contains the name of the rule that specifies the action. The `ActionType` dimension contains the type of action that was invoked.
      </td>
    </tr>
  </tbody>
</table>

<Collapser id="iotrulesample" title="IOTRuleSample events"

Query `IOTRuleSample` events to view data for the following attributes:

<table>
  <thead>
    <tr>
      <th style={{ width: "250px" }}>
        Name
      </th>

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

  <tbody>
    <tr>
      <td>
        `topicMatch`
      </td>

      <td>
        The number of incoming messages published on a topic on which a rule is listening. The `RuleName` dimension contains the name of the rule.
      </td>
    </tr>

    <tr>
      <td>
        `parseError`
      </td>

      <td>
        The number of JSON parse errors that occurred in messages published on a topic on which a rule is listening. The `RuleName` dimension contains the name of the rule.
      </td>
    </tr>
  </tbody>
</table>

Inventory data [#inventory]

After March 2022, we're discontinuing support for several capabilities, including inventory data for cloud integrations. For more details, including how you can easily prepare for this transition, see our [Explorers Hub post](https://discuss.newrelic.com).

To view inventory data for AWS IoT, go to one.newrelic.com > Infrastructure > Inventory and search for or select the following:

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

  <tbody>
    <tr>
      <td>
        `protocol`
      </td>

      <td>
        Protocol used by the broker.
      </td>
    </tr>
  </tbody>
</table>

<Collapser id="aws-iot-rule-action" title="aws/iot/rule-action/"

<table>
  <thead>
    <tr>
      <th style={{ width: "250px" }}>
        Name
      </th>

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

  <tbody>
    <tr>
      <td>
        `ruleArn`
      </td>

      <td>
        ARN for the rule.
      </td>
    </tr>

    <tr>
      <td>
        `ruleName`
      </td>

      <td>
        Name of the rule.
      </td>
    </tr>

    <tr>
      <td>
        `topicPattern`
      </td>

      <td>
        Pattern for the topic names.
      </td>
    </tr>

    <tr>
      <td>
        `actionType`
      </td>

      <td>
        The [action type](http://docs.aws.amazon.com/iot/latest/developerguide/iot-rule-actions.html) specified by the rule that triggered the request.
      </td>
    </tr>
  </tbody>
</table>

<Collapser id="aws-iot-rule" title="aws/iot/rule"

<table>
  <thead>
    <tr>
      <th style={{ width: "250px" }}>
        Name
      </th>

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

  <tbody>
    <tr>
      <td>
        `ruleArn`
      </td>

      <td>
        ARN for the rule.
      </td>
    </tr>

    <tr>
      <td>
        `ruleName`
      </td>

      <td>
        Name of the rule.
      </td>
    </tr>

    <tr>
      <td>
        `topicPattern`
      </td>

      <td>
        Pattern for the topic names.
      </td>
    </tr>

    <tr>
      <td>
        `createdAt`
      </td>

      <td>
        Date and time when you created the rule.
      </td>
    </tr>

    <tr>
      <td>
        `ruleDisabled`
      </td>

      <td>
        Boolean that specifies whether or not the rule is disabled.
      </td>
    </tr>
  </tbody>
</table>
Name