[telemetry example] initial import (#6116)

* [telemetry example] initial import --------- Co-authored-by: Andrew Meyer <[email protected]> Co-authored-by: LJ <[email protected]>
realm · Sep 14, 2023 · c63f804 · c63f804
1 parent 473994b
commit c63f804
Show file tree

Hide file tree

Showing 14 changed files with 3,366 additions and 0 deletions.
diff --git a/examples/node-telemetry/.eslintignore b/examples/node-telemetry/.eslintignore
@@ -0,0 +1 @@
+dist/
diff --git a/examples/node-telemetry/.eslintrc.json b/examples/node-telemetry/.eslintrc.json
@@ -0,0 +1,18 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "extends": [
+    "plugin:@typescript-eslint/recommended",
+    "plugin:jsdoc/recommended-typescript"
+  ],
+  "rules": {
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "no-console": "error",
+    "sort-imports": ["warn", { "ignoreDeclarationSort": true }],
+    "jsdoc/check-tag-names": "off",
+    "jsdoc/require-jsdoc": "off",
+    "jsdoc/require-returns": "off",
+    "jsdoc/require-yields": "off",
+    "jsdoc/require-param": "off",
+    "jsdoc/no-undefined-types": "warn"
+  }
+}
diff --git a/examples/node-telemetry/.gitignore b/examples/node-telemetry/.gitignore
@@ -0,0 +1,8 @@
+# TS-generated output files.
+ dist/
+
+ # Dependencies.
+ node_modules/
+
+ # Local MongoDB Realm database.
+ mongodb-realm/
diff --git a/examples/node-telemetry/Charts/Dashboard.charts b/examples/node-telemetry/Charts/Dashboard.charts
@@ -0,0 +1 @@
+{"exportVersion":6,"dashboards":{"dashboard-1":{"description":"","embedding":{},"filters":[],"layout":[{"i":"item-1","x":0,"y":0,"w":2,"h":2}],"title":"Dashboard"}},"items":{"item-1":{"calculatedFields":[],"channels":{"x":{"channelType":"value","inferredType":"Date","field":"timestamp","type":"temporal"},"y":{"channelType":"value","inferredType":"Number","field":"loadAvg","type":"quantitative","transformedType":"Number"}},"chartType":"Line Continuous","convertedFields":[{"fieldPath":"loadAvg","convertTo":"double","arrayParentPaths":["loadAvg"]}],"customisations":{"options":{},"axes":{"y":{}},"channels":{"x":{"dateTimeFormatting":{"enabled":true,"value":"DD-MMM-YYYY"}},"y":{"numberFormatting":{"enabled":true,"value":"Default"}}},"conditionalFormatting":[]},"dashboardId":"dashboard-1","dataSourceId":"data-source-1","description":"","filters":[],"iconValue":"line-continuous","interactiveFiltering":"highlight","itemType":"chart","lookupFields":[],"meta":{},"missedFields":[],"query":null,"queryId":null,"reductions":{"y":[{"dimensionality":1,"field":"loadAvg","type":"Array element by index","arguments":[0]}]},"sample":false,"title":"","embedding":{}}},"dataSources":{"data-source-1":{"alias":"SensorReading","collection":"SensorReading","database":"telemetry","deployment":"Cluster0","sourceType":"cluster"}},"queries":{}}
diff --git a/examples/node-telemetry/Charts/charts-example.png b/examples/node-telemetry/Charts/charts-example.png
diff --git a/examples/node-telemetry/LICENSE b/examples/node-telemetry/LICENSE
@@ -0,0 +1,177 @@
+                                 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
+
diff --git a/examples/node-telemetry/README.md b/examples/node-telemetry/README.md
@@ -0,0 +1,138 @@
+# Telemetry demo app using Data Ingest and Atlas Charts
+
+A [Node.js](https://nodejs.org) application to demonstrate how to use [Atlas Device Sync](https://www.mongodb.com/atlas/app-services/device-sync) and the [Realm Node.js SDK](https://www.mongodb.com/docs/realm/sdk/node/) to read sensor data, store the data in [Atlas](https://www.mongodb.com/atlas), and visualize it with [Atlas Charts](https://www.mongodb.com/products/charts). [Data Ingest](https://www.mongodb.com/docs/atlas/app-services/sync/configure/sync-settings/#data-ingest) is enabled since this app uses insert-only workloads.
+
+## Project Structure
+
+The following shows the project structure and the most relevant files.
+
+```
+├── src
+│   ├── models
+│   │   ├── machine_info.ts
+│   │   └── sensor_reading.ts
+│   ├── app.ts
+│   └── config.ts
+├── package.json
+└── README.md
+```
+
+* `src/app.ts` - the actual application
+* `src/config.ts` - contains the configuration (Atlas App ID)
+* `src/models/` - the model classes
+
+## Use Cases
+
+This app focuses on showing how to use Data Ingest for heavy client-side insert-only workloads. It specifically addresses the following points:
+
+* Using the [Data Ingest](https://www.mongodb.com/docs/atlas/app-services/sync/configure/sync-settings/#data-ingest) sync strategy via asymmetric Realm objects.
+* Reading sensor data (system load averages, uptime, and free memory).
+* Inserting sensor data every few seconds and syncing it to [Atlas](https://www.mongodb.com/atlas).
+* (The data in Atlas can be visualized via [Atlas Charts](https://www.mongodb.com/products/charts), but since this is a Node.js app, the visualization is not shown.)
+
+### Realm Details
+
+* [Realm JavaScript](https://github.com/realm/realm-js) version: ^12.1.0
+* Device Sync type: [Flexible](https://www.mongodb.com/docs/realm/sdk/node/sync/flexible-sync/) with [Data Ingest](https://www.mongodb.com/docs/atlas/app-services/sync/configure/sync-settings/#data-ingest)
+
+## Getting Started
+
+### Prerequisites
+
+* [Node.js](https://nodejs.org/)
+* An [Atlas App Service](https://www.mongodb.com/docs/atlas/app-services/) account
+
+### Set Up an Atlas App Services App
+
+To sync Realm data you must first:
+
+1. [Create an App Services App](https://www.mongodb.com/docs/atlas/app-services/manage-apps/create/create-with-ui/)
+2. [Enable Anonymous Authentication](https://www.mongodb.com/docs/atlas/app-services/authentication/anonymous/)
+3. [Enable Flexible Sync](https://www.mongodb.com/docs/atlas/app-services/sync/configure/enable-sync/) with **[Development Mode](https://www.mongodb.com/docs/atlas/app-services/sync/configure/sync-settings/#development-mode)** on.
+
+After running the client and seeing the available collection in Atlas, [set write permissions](https://www.mongodb.com/docs/atlas/app-services/rules/roles/#define-roles---permissions) for the collection.
+
+The following schema will automatically be created in **Development Mode** and you can find it at `App Services / Data Access / Schema` in the Atlas App Service UI:
+
+```json
+{
+  "title": "SensorReading",
+  "type": "object",
+  "required": [
+    "_id",
+    "freemem",
+    "timestamp",
+    "uptime"
+  ],
+  "properties": {
+    "_id": {
+      "bsonType": "objectId"
+    },
+    "freemem": {
+      "bsonType": "long"
+    },
+    "loadAvg": {
+      "bsonType": "array",
+      "items": {
+        "bsonType": "float"
+      }
+    },
+    "machineInfo": {
+      "title": "MachineInfo",
+      "type": "object",
+      "required": [
+        "platform",
+        "release"
+      ],
+      "properties": {
+        "platform": {
+          "bsonType": "string"
+        },
+        "release": {
+          "bsonType": "string"
+        }
+      }
+    },
+    "timestamp": {
+      "bsonType": "date"
+    },
+    "uptime": {
+      "bsonType": "float"
+    }
+  }
+}
+```
+
+### Visualize Data
+
+Data can be visualized by [Charts](https://www.mongodb.com/products/charts). An example from a [dashboard](Charts/Dashboard.charts) is shown below.
+
+![An example on how Charts can visualize incoming data](Charts/charts-example.png)
+
+## How to build and run
+
+You need to clone Realm JavaScript's git repository:
+
+```sh
+git clone https://github.com/realm/realm-js
+```
+
+Moreover, you need to install the dependencies for this app:
+
+```sh
+cd realm-js/examples/example-node-telemetry
+npm install
+```
+
+Before building the app, you need to add your app id to `src/config.ts`. After that, you can build and run the app:
+
+```sh
+npm start
+```
+
+You can enable debug messages:
+
+```sh
+DEBUG=realm:telemetry node dist/app.js # only debug messages for the app
+DEBUG=realm:* node dist/app.js         # debug messages for many Realm operations - WARNING: much output
+```