Skip to content

Commit 2817871

Browse files
authored
Update Device Defender demo documentation (#1574)
1 parent 783b9f5 commit 2817871

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

docs/doxygen/demos/defender_demo.dox

+8-2
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,20 @@ The demo reports the following metrics to the AWS IoT Device Defender Service:
1212
- List of open TCP ports
1313
- List of open UDP ports
1414
- List of established connections
15+
- System CPU usage statistics (as a custom metric of number-list type)
16+
- System memory statistics (as a custom metric of string-list type)
1517

16-
The demo gets the above metrics by reading `/proc/net/dev`, `/proc/net/tcp` and,
17-
`/proc/net/udp`. It then constructs a JSON report in the format as expected by
18+
The demo gets the above metrics by reading `/proc/net/dev`, `/proc/net/tcp`,
19+
`/proc/net/udp`, `/proc/uptime`, and `/proc/meminfo`. It then constructs a JSON report in the format as expected by
1820
the AWS IoT Device Defender service. The constructed JSON report is then
1921
published on the device defender MQTT topic reserved for publishing JSON
2022
reports. The demo then waits for a report accepted response, and ensures that
2123
the response contains the same report Id as was sent in the request.
2224

25+
For the AWS IoT Device Defender service to make use of the custom metrics reported by the demo, you need to
26+
define the custom metrics in your account. You can use either the AWS console or CLI to create
27+
custom metrics in your account. For more information, please refer to [Custom Metrics AWS documentation](https://docs.aws.amazon.com/iot/latest/developerguide/dd-detect-custom-metrics.html).
28+
2329
<div class="caption" style="text-align:center">
2430
AWS IoT Device Defender Demo Workflow
2531
</div>

docs/lexicon.txt

+4-1
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ corehttp
5151
corejson
5252
coremqtt
5353
corepkcs
54+
cpu
5455
crontab
5556
crt
5657
csr
@@ -59,6 +60,7 @@ da
5960
datatypes
6061
daws
6162
dclient
63+
dd
6264
debian
6365
defgroup
6466
dev
@@ -112,6 +114,7 @@ lowercamelcase
112114
lowercamelcased
113115
mainpage
114116
matchtopic
117+
meminfo
115118
metadata
116119
misra
117120
mkdir
@@ -196,4 +199,4 @@ urls
196199
userguide
197200
wikipedia
198201
www
199-
xz
202+
xz

0 commit comments

Comments
 (0)