|
1 | 1 |
|
2 | 2 | # AppDynamics IoT Java SDK |
3 | 3 |
|
4 | | -## Table of contents |
| 4 | +## Table of Contents |
5 | 5 |
|
6 | 6 | - [Overview](#overview) |
7 | 7 | - [What is included](#what-is-included) |
8 | 8 | - [Getting Started](#getting-started) |
9 | 9 | - [Download the released jar](#download-the-released-jar) |
10 | | -- [Building the SDK](#building-the-sdk) |
11 | | -- [Building the Javadocs](#building-the-javadocs) |
| 10 | +- [Building the SDK](#build-the-sdk) |
| 11 | +- [Building the Javadocs](#build-the-javadocs) |
12 | 12 | - [Documentation](#documentation) |
13 | 13 | - [Versioning](#versioning) |
14 | 14 | - [Copyright and License](#copyright-and-license) |
15 | 15 |
|
16 | 16 | ## Overview |
17 | | -This repository contains AppDynamics IoT Java SDK that can be used in embedded applications to monitor network perfomance, errors and business metrics. |
18 | 17 |
|
| 18 | +This repository contains the AppDynamics IoT Java SDK that can be used in embedded applications to monitor network perfomance, errors, and business metrics. |
19 | 19 |
|
20 | | -## What is included |
21 | 20 |
|
22 | | -* `sdk` - The Appdynamics Java SDK for IoT |
23 | | -* `sample-apps` - A Sample Application showing how to use the SDK |
24 | | -* `docs` - The Javadoc for the SDK. It can also be viewed online [here](https://appdynamics.github.io/iot-java-sdk/) |
| 21 | +## What is Included |
| 22 | + |
| 23 | +* `sdk` - The Appdynamics Java SDK for IoT. |
| 24 | +* `sample-apps` - A sample application showing how to use the SDK. |
| 25 | +* `docs` - The Javadoc for the SDK. It can also be [viewed online](https://appdynamics.github.io/iot-java-sdk/). |
25 | 26 |
|
26 | 27 |
|
27 | 28 | ## Getting Started |
28 | 29 |
|
29 | | -Best place to understand the usage of SDK is to run the sample application. |
| 30 | +The best way to understand how to use the SDK is to run the sample application. |
30 | 31 |
|
31 | | -* Clone or download the repo https://github.com/Appdynamics/iot-java-sdk.git in `<MY_SOURCE_FOLDER>` |
| 32 | +1. Clone or download the repo https://github.com/Appdynamics/iot-java-sdk.git in `<MY_SOURCE_FOLDER>`. |
32 | 33 |
|
33 | | -* Get [EUM App Key and Collector URL](https://docs.appdynamics.com/display/latest/Set+Up+and+Access+IoT+Monitoring#SetUpandAccessIoTMonitoring-iot-app-key) |
34 | | - |
35 | | -* Add your EUM app key and Collector URL to your sample app by editing: |
36 | | -`<MY_SOURCE_FOLDER>/iot-java-sdk/sample-apps/src/main/java/com/appdynamics/iotapps/MyIoTSampleApp.java` |
37 | | -`public static final String APP_KEY = "<YOUR-APP-KEY>";` |
38 | | -`public static final String COLLECTOR_URL = "<YOUR-COLLECTOR-URL>";` |
39 | | - |
40 | | -* Build the sample-app by running the following commands. (It also builds the SDK) |
41 | | -`cd <MY_SOURCE_FOLDER>/iot-java-sdk ` |
42 | | -`./gradlew -p sample-apps clean distTar` |
43 | | - |
44 | | -* Create a new folder from where to run the deployed code. |
45 | | -`mkdir <MY_DEPLOY_FOLDER>` |
46 | | - |
47 | | -* Copy the distribution tar file which includes the Sample App and the AppDynamics IoT Java SDK to this deployment folder. |
48 | | -`cp ./sample-apps/build/distributions/appd-iot-sample-app.tar <MY_DEPLOY_FOLDER>` |
49 | | - |
50 | | -* Un-tar and run the application. |
51 | | - |
52 | | - `cd <MY_DEPLOY_FOLDER> ` |
53 | | - `tar xvf appd-iot-sample-app.tar` |
54 | | - `./appd-iot-sample-app/bin/sample-apps` |
55 | | - |
56 | | -* Confirm [IoT Data](https://docs.appdynamics.com/display/latest/Confirm+the+IoT+Application+Reported+Data+to+the+Controller) is |
57 | | -reported to Collector. |
58 | | - |
59 | | -## Download the released jar |
60 | | -The released version of the SDK can be downloaded from [here](https://github.com/Appdynamics/iot-java-sdk/releases) |
61 | | - |
62 | | -## Building the SDK |
63 | | -* Clone or download the repo: https://github.com/Appdynamics/iot-java-sdk.git in `<MY_SOURCE_FOLDER>` |
64 | | -* Make any modifications to the sdk, if desired |
65 | | -* Run the following command from the terminal |
66 | | -`cd <MY_SOURCE_FOLDER>/iot-java-sdk ` |
67 | | -`./gradlew -p sdk/ clean assemble test ` |
68 | | - |
69 | | -## Building the Javadocs |
70 | | - |
71 | | -* Clone or download the repo: https://github.com/Appdynamics/iot-java-sdk.git in `<MY_SOURCE_FOLDER>` |
72 | | -* Make any modifications, if desired |
73 | | -* Run the following command from the terminal |
74 | | -`cd <MY_SOURCE_FOLDER>/iot-java-sdk ` |
75 | | -`./gradlew -p sdk/ clean assemble test generateZippedJavadocs ` |
| 34 | +1. Get an [EUM App Key and a Collector URL](https://docs.appdynamics.com/display/latest/Set+Up+and+Access+IoT+Monitoring#SetUpandAccessIoTMonitoring-iot-app-key). |
| 35 | + |
| 36 | +1. Add your EUM app key and Collector URL to your sample app by making the following edits to |
| 37 | +`<MY_SOURCE_FOLDER>/iot-java-sdk/sample-apps/src/main/java/com/appdynamics/iotapps/MyIoTSampleApp.java`: |
| 38 | + |
| 39 | + ```java |
| 40 | + public static final String APP_KEY = "<YOUR-APP-KEY>"; |
| 41 | + public static final String COLLECTOR_URL = "<YOUR-COLLECTOR-URL>"; |
| 42 | + ``` |
| 43 | + |
| 44 | +1. Build the sample-app by running the following commands. (It also builds the SDK.) |
| 45 | + ```bash |
| 46 | + cd <MY_SOURCE_FOLDER>/iot-java-sdk |
| 47 | + ./gradlew -p sample-apps clean distTar |
| 48 | + ``` |
| 49 | + |
| 50 | +1. Create a new folder where you'll run the deployed code. |
| 51 | + ```bash |
| 52 | + mkdir <MY_DEPLOY_FOLDER> |
| 53 | + ``` |
| 54 | + |
| 55 | +1. Copy the distribution tar file that includes the sample app and the AppDynamics IoT Java SDK to this deployment folder. |
| 56 | + ```bash |
| 57 | + cp ./sample-apps/build/distributions/appd-iot-sample-app.tar <MY_DEPLOY_FOLDER> |
| 58 | + ``` |
| 59 | + |
| 60 | +1. Un-tar and run the application. |
| 61 | + |
| 62 | + ```bash |
| 63 | + cd <MY_DEPLOY_FOLDER> |
| 64 | + tar xvf appd-iot-sample-app.tar |
| 65 | + ./appd-iot-sample-app/bin/sample-apps |
| 66 | + ``` |
| 67 | + |
| 68 | +1. Confirm the [IoT Data](https://docs.appdynamics.com/display/latest/Confirm+the+IoT+Application+Reported+Data+to+the+Controller) was |
| 69 | +reported to the EUM Collector. |
| 70 | + |
| 71 | +## Download the Released JAR |
| 72 | +The released version of the SDK can be downloaded from https://github.com/Appdynamics/iot-java-sdk/releases. |
| 73 | + |
| 74 | +## Build the SDK |
| 75 | + |
| 76 | +1. Clone or download the repo https://github.com/Appdynamics/iot-java-sdk.git in `<MY_SOURCE_FOLDER>`. |
| 77 | +1. Make any modifications to the SDK, if desired. |
| 78 | +1. Run the following command from a terminal: |
| 79 | + ```bash |
| 80 | + cd <MY_SOURCE_FOLDER>/iot-java-sdk |
| 81 | + ./gradlew -p sdk/ clean assemble test |
| 82 | + ``` |
| 83 | + |
| 84 | +## Build the Javadocs |
| 85 | + |
| 86 | +1. Clone or download the repo https://github.com/Appdynamics/iot-java-sdk.git in `<MY_SOURCE_FOLDER>`. |
| 87 | +1. Make any modifications, if desired. |
| 88 | +1. Run the following command from a terminal: |
| 89 | + ```bash |
| 90 | + cd <MY_SOURCE_FOLDER>/iot-java-sdk |
| 91 | + ./gradlew -p sdk/ clean assemble test generateZippedJavadocs |
| 92 | + ``` |
76 | 93 |
|
77 | 94 | ## Documentation |
78 | 95 |
|
79 | | -1. [Javadoc](https://appdynamics.github.io/iot-java-sdk/) |
80 | | -2. [REST API docs](https://docs.appdynamics.com/javadocs/iot-rest-api/4.4/latest/) - provides payload structure sent to Appdynamics IoT Collector |
81 | | -3. [User Documents](https://docs.appdynamics.com/display/latest/IoT+Monitoring) - provides overview on IoT monitoring capabilities |
82 | | -4. Support for other languages |
| 96 | +* [Javadoc](https://appdynamics.github.io/iot-java-sdk/) |
| 97 | +* [REST API docs](https://docs.appdynamics.com/javadocs/iot-rest-api/4.4/latest/) - provides the payload structure sent to the Appdynamics EUM Collector. |
| 98 | +* [User Documents](https://docs.appdynamics.com/display/latest/IoT+Monitoring) - provides an overview about the IoT monitoring capabilities. |
| 99 | +* Support for other languages: |
83 | 100 | * [C++ SDK and Sample App](https://github.com/Appdynamics/iot-cpp-sdk) |
84 | 101 | * [Python Sample Code](https://github.com/Appdynamics/iot-rest-api-sample-apps) |
85 | 102 |
|
86 | 103 |
|
87 | 104 | ## Versioning |
88 | | -Versioning of releases of this project is maintained under [the Semantic Versioning Guidelines](https://semver.org/) |
| 105 | +Versioning of releases of this project is maintained under the [Semantic Versioning Guidelines](https://semver.org/) |
89 | 106 |
|
90 | | -## Copyright and license |
| 107 | +## Copyright and License |
91 | 108 |
|
92 | | -Code released under the [Apache 2.0](https://github.com/Appdynamics/iot-java-sdk/blob/master/LICENSE) License. Copyright (c) 2018 AppDynamics LLC and its affiliates. |
| 109 | +The code is released under the [Apache 2.0](https://github.com/Appdynamics/iot-java-sdk/blob/master/LICENSE) License. Copyright (c) 2018 AppDynamics LLC and its affiliates. |
0 commit comments