-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
346 changed files
with
34,031 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
cmake_minimum_required(VERSION 3.0) | ||
|
||
project(appdynamicsiotsdk) | ||
|
||
##################################### | ||
# Build Targets sdk, sample and tests | ||
##################################### | ||
|
||
add_subdirectory(sdk) | ||
add_subdirectory(sample) | ||
|
||
# To build tests, add option flag -DBUILD_TESTS=1 to cmake command | ||
set(BUILD_TESTS, 0) | ||
|
||
if(BUILD_TESTS) | ||
add_subdirectory(tests) | ||
endif() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,176 @@ | ||
Apache License | ||
Version 2.0, January 2004 | ||
http://www.apache.org/licenses/ | ||
|
||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
||
1. Definitions. | ||
|
||
"License" shall mean the terms and conditions for use, reproduction, | ||
and distribution as defined by Sections 1 through 9 of this document. | ||
|
||
"Licensor" shall mean the copyright owner or entity authorized by | ||
the copyright owner that is granting the License. | ||
|
||
"Legal Entity" shall mean the union of the acting entity and all | ||
other entities that control, are controlled by, or are under common | ||
control with that entity. For the purposes of this definition, | ||
"control" means (i) the power, direct or indirect, to cause the | ||
direction or management of such entity, whether by contract or | ||
otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
||
"You" (or "Your") shall mean an individual or Legal Entity | ||
exercising permissions granted by this License. | ||
|
||
"Source" form shall mean the preferred form for making modifications, | ||
including but not limited to software source code, documentation | ||
source, and configuration files. | ||
|
||
"Object" form shall mean any form resulting from mechanical | ||
transformation or translation of a Source form, including but | ||
not limited to compiled object code, generated documentation, | ||
and conversions to other media types. | ||
|
||
"Work" shall mean the work of authorship, whether in Source or | ||
Object form, made available under the License, as indicated by a | ||
copyright notice that is included in or attached to the work | ||
(an example is provided in the Appendix below). | ||
|
||
"Derivative Works" shall mean any work, whether in Source or Object | ||
form, that is based on (or derived from) the Work and for which the | ||
editorial revisions, annotations, elaborations, or other modifications | ||
represent, as a whole, an original work of authorship. For the purposes | ||
of this License, Derivative Works shall not include works that remain | ||
separable from, or merely link (or bind by name) to the interfaces of, | ||
the Work and Derivative Works thereof. | ||
|
||
"Contribution" shall mean any work of authorship, including | ||
the original version of the Work and any modifications or additions | ||
to that Work or Derivative Works thereof, that is intentionally | ||
submitted to Licensor for inclusion in the Work by the copyright owner | ||
or by an individual or Legal Entity authorized to submit on behalf of | ||
the copyright owner. For the purposes of this definition, "submitted" | ||
means any form of electronic, verbal, or written communication sent | ||
to the Licensor or its representatives, including but not limited to | ||
communication on electronic mailing lists, source code control systems, | ||
and issue tracking systems that are managed by, or on behalf of, the | ||
Licensor for the purpose of discussing and improving the Work, but | ||
excluding communication that is conspicuously marked or otherwise | ||
designated in writing by the copyright owner as "Not a Contribution." | ||
|
||
"Contributor" shall mean Licensor and any individual or Legal Entity | ||
on behalf of whom a Contribution has been received by Licensor and | ||
subsequently incorporated within the Work. | ||
|
||
2. Grant of Copyright License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
copyright license to reproduce, prepare Derivative Works of, | ||
publicly display, publicly perform, sublicense, and distribute the | ||
Work and such Derivative Works in Source or Object form. | ||
|
||
3. Grant of Patent License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
(except as stated in this section) patent license to make, have made, | ||
use, offer to sell, sell, import, and otherwise transfer the Work, | ||
where such license applies only to those patent claims licensable | ||
by such Contributor that are necessarily infringed by their | ||
Contribution(s) alone or by combination of their Contribution(s) | ||
with the Work to which such Contribution(s) was submitted. If You | ||
institute patent litigation against any entity (including a | ||
cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
or a Contribution incorporated within the Work constitutes direct | ||
or contributory patent infringement, then any patent licenses | ||
granted to You under this License for that Work shall terminate | ||
as of the date such litigation is filed. | ||
|
||
4. Redistribution. You may reproduce and distribute copies of the | ||
Work or Derivative Works thereof in any medium, with or without | ||
modifications, and in Source or Object form, provided that You | ||
meet the following conditions: | ||
|
||
(a) You must give any other recipients of the Work or | ||
Derivative Works a copy of this License; and | ||
|
||
(b) You must cause any modified files to carry prominent notices | ||
stating that You changed the files; and | ||
|
||
(c) You must retain, in the Source form of any Derivative Works | ||
that You distribute, all copyright, patent, trademark, and | ||
attribution notices from the Source form of the Work, | ||
excluding those notices that do not pertain to any part of | ||
the Derivative Works; and | ||
|
||
(d) If the Work includes a "NOTICE" text file as part of its | ||
distribution, then any Derivative Works that You distribute must | ||
include a readable copy of the attribution notices contained | ||
within such NOTICE file, excluding those notices that do not | ||
pertain to any part of the Derivative Works, in at least one | ||
of the following places: within a NOTICE text file distributed | ||
as part of the Derivative Works; within the Source form or | ||
documentation, if provided along with the Derivative Works; or, | ||
within a display generated by the Derivative Works, if and | ||
wherever such third-party notices normally appear. The contents | ||
of the NOTICE file are for informational purposes only and | ||
do not modify the License. You may add Your own attribution | ||
notices within Derivative Works that You distribute, alongside | ||
or as an addendum to the NOTICE text from the Work, provided | ||
that such additional attribution notices cannot be construed | ||
as modifying the License. | ||
|
||
You may add Your own copyright statement to Your modifications and | ||
may provide additional or different license terms and conditions | ||
for use, reproduction, or distribution of Your modifications, or | ||
for any such Derivative Works as a whole, provided Your use, | ||
reproduction, and distribution of the Work otherwise complies with | ||
the conditions stated in this License. | ||
|
||
5. Submission of Contributions. Unless You explicitly state otherwise, | ||
any Contribution intentionally submitted for inclusion in the Work | ||
by You to the Licensor shall be under the terms and conditions of | ||
this License, without any additional terms or conditions. | ||
Notwithstanding the above, nothing herein shall supersede or modify | ||
the terms of any separate license agreement you may have executed | ||
with Licensor regarding such Contributions. | ||
|
||
6. Trademarks. This License does not grant permission to use the trade | ||
names, trademarks, service marks, or product names of the Licensor, | ||
except as required for reasonable and customary use in describing the | ||
origin of the Work and reproducing the content of the NOTICE file. | ||
|
||
7. Disclaimer of Warranty. Unless required by applicable law or | ||
agreed to in writing, Licensor provides the Work (and each | ||
Contributor provides its Contributions) on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
implied, including, without limitation, any warranties or conditions | ||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
PARTICULAR PURPOSE. You are solely responsible for determining the | ||
appropriateness of using or redistributing the Work and assume any | ||
risks associated with Your exercise of permissions under this License. | ||
|
||
8. Limitation of Liability. In no event and under no legal theory, | ||
whether in tort (including negligence), contract, or otherwise, | ||
unless required by applicable law (such as deliberate and grossly | ||
negligent acts) or agreed to in writing, shall any Contributor be | ||
liable to You for damages, including any direct, indirect, special, | ||
incidental, or consequential damages of any character arising as a | ||
result of this License or out of the use or inability to use the | ||
Work (including but not limited to damages for loss of goodwill, | ||
work stoppage, computer failure or malfunction, or any and all | ||
other commercial damages or losses), even if such Contributor | ||
has been advised of the possibility of such damages. | ||
|
||
9. Accepting Warranty or Additional Liability. While redistributing | ||
the Work or Derivative Works thereof, You may choose to offer, | ||
and charge a fee for, acceptance of support, warranty, indemnity, | ||
or other liability obligations and/or rights consistent with this | ||
License. However, in accepting such obligations, You may act only | ||
on Your own behalf and on Your sole responsibility, not on behalf | ||
of any other Contributor, and only if You agree to indemnify, | ||
defend, and hold each Contributor harmless for any liability | ||
incurred by, or claims asserted against, such Contributor by reason | ||
of your accepting any such warranty or additional liability. | ||
|
||
END OF TERMS AND CONDITIONS |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,118 @@ | ||
# iot-cpp-sdk | ||
Appdynamics IoT C++ SDK to monitor connected devices | ||
# AppDynamics IoT C++ SDK | ||
|
||
## Overview | ||
This repository contains AppDynamics IoT C++ SDK that can be used in embedded applications to monitor network perfomance, errors and business metrics. | ||
|
||
|
||
## Contents | ||
|
||
* `sdk` - C++ SDK source and headers | ||
* `sample` - Sample Application showing how to use the SDK to capture and send events | ||
* `tests` - Unit Tests to test functionality of SDK | ||
* `docs` - SDK API document built in html format using Doxygen. | ||
|
||
|
||
## Requirements | ||
|
||
* GNU C++ Compiler (g++) version 4.2 or above for 32/64-bit architectures | ||
* Any Linux x86 distribution based on glibc 2.20+ | ||
* If using macOS - LLVM version 8.0.0 or above | ||
* cmake version 3.0 or above | ||
|
||
Before building the sdk, check if cmake is installed. If not, you can get it using package manager | ||
|
||
```sh | ||
$ sudo apt-get install cmake | ||
$ cmake -v | ||
``` | ||
Also, ensure your system has all the tools (g++, make, libc, git etc) to build c++ code. If not, you can install them using | ||
|
||
```sh | ||
$ sudo apt-get install build-essential | ||
$ sudo apt-get install git | ||
``` | ||
|
||
## Dependencies | ||
|
||
* cgreen - Tests are written using [cgreen](https://github.com/cgreen-devs/cgreen) unit testing framework to verify SDK functionality. | ||
cgreen repo will be downloaded, compiled and linked to tests as part of build step. | ||
* curl - Sample application uses [curl](https://curl.haxx.se/) to send events to Appdynamics IoT Collector | ||
|
||
You can install curl and its headers using below commands: | ||
|
||
```sh | ||
$ sudo apt-get install curl | ||
$ sudo apt-get install libcurl4-gnutls-dev | ||
``` | ||
|
||
## Platforms | ||
|
||
SDK has been built and tested on below platforms. | ||
* Linux x86 32/64 bit architectures | ||
* macOS 10.12 and above | ||
|
||
SDK can be built on other platforms as long the compiler has support for ISO C++ standard C++98/C++03. | ||
|
||
## Build Targets | ||
|
||
Below are the targets that can be built using this repository. | ||
|
||
* `appdynamicsiotsdk` - SDK is built as a library(libappdynamicsiot) by default. The library and headers can be found in lib/ and include/ directories created when this target is built. | ||
* `sample` - Sample application is built as executable `sample` by default. | ||
* `tests` - Tests are built as executable linking cgreen library. | ||
|
||
|
||
## <a id="Installation"></a>Installation | ||
|
||
All the targets can be built from root directory using the below commands. | ||
|
||
```sh | ||
$ git clone https://github.com/Appdynamics/iot-cpp-sdk.git | ||
$ cd iot-cpp-sdk | ||
$ mkdir build | ||
$ cd build | ||
$ cmake .. | ||
$ make | ||
``` | ||
|
||
if `build` directory is created outside of the root directory, then pass the path of root directory to cmake command. | ||
|
||
Only sdk and sample targets are built by default. To build tests, run | ||
|
||
```sh | ||
$ cmake .. -DBUILD_TESTS=1 | ||
$ make | ||
``` | ||
|
||
You can also build individual targets using below commands | ||
|
||
```sh | ||
$ make appdynamicsiotsdk | ||
$ make sample | ||
$ make tests | ||
``` | ||
|
||
## How to Use | ||
|
||
Best place to understand the usage of SDK is to run the sample application. Please refer [README](sample/README.md) of sample application for steps to run. | ||
|
||
Below are the steps to integrate and use SDK within your own application: | ||
|
||
1. Dynamically link SDK Library (libappdynamicsiot) to your application | ||
* You can find libappdynamicsiot in lib/ folder once sdk target is built | ||
* If you are using cmake, refer to CMakeLists.txt within sample/ on how sdk library is linked | ||
2. Copy and import SDK headers from include directory into your application | ||
3. Get [EUM App Key and Collector URL](https://docs.appdynamics.com/display/PRO44/Set+Up+and+Access+IoT+Monitoring#SetUpandAccessIoTMonitoring-iot-app-key) | ||
4. Initialize SDK with App Key and Collector URL before adding and sending data | ||
5. Confirm [IoT Data](https://docs.appdynamics.com/display/PRO44/Confirm+the+IoT+Application+Reported+Data+to+the+Controller) is | ||
reported to Collector | ||
|
||
|
||
## Additional Resources | ||
|
||
1. [SDK API docs](docs/README.md) - provides definition and implementation of SDK API | ||
2. [REST API docs](https://docs.appdynamics.com/javadocs/iot-rest-api/4.4/latest/) - provides payload structure sent to IoT Collector | ||
3. [User Documents](https://docs.appdynamics.com/display/PRO44/IoT+Monitoring) - provides overview on IoT monitoring capabilities | ||
4. Sample Application in other languages are available on github | ||
* [Java](https://github.com/Appdynamics/iot-java-sdk-sample-apps) | ||
* [Python](https://github.com/Appdynamics/iot-rest-api-sample-apps) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# IoT SDK API Docs | ||
|
||
See html/index.html for API Reference. |
Oops, something went wrong.