[telemetry example] initial import

[kneth]

What, How & Why?

This closes #5823

☑️ ToDos

• 📝 Changelog entry
• 📝 Compatibility label is updated or copied from previous entry
• 📝 Update COMPATIBILITY.md
• 🚦 Tests
• 📦 Updated internal package version in consuming package.jsons (if updating internal packages)
• 📱 Check the React Native/other sample apps work if necessary
• 💥 Breaking label has been applied or is not necessary

[otso]

LGTM!

[otso]

@kneth one comment - having an exported Analytics.charts file as in the .NET example would be great as you would be able to visualise the data immediately.

[takameyer]

Just a few considerations

[elle-j]

Here comes the first batch of comments (only got the README left to review). Looks good!

P.S. could we remove the example- prefix from the directory? (So that it aligns with the updated examples discussed on Slack.) So instead of examples/example-node-telemetry we could go with examples/node-telemetry.

[elle-j]

Here's the remainder of the review. Provided some updates and suggestions for the README 🙂

[elle-j]

One improvement I think we could do here to provide a better DX is to let the example be independent of our repo. So e.g. having the README speak from the perspective of this example directory as the root. (Since realm is defined in the package.json, they shouldn't need our repo.)

I think the lines I marked here could be replaced with the following if you agree (ps. temporarily placing \ in front of code blocks otherwise I can't show it in one code block here):

### Install Dependencies

\```sh
npm install
\```

### Run the App

1. [Copy your Atlas App ID](https://www.mongodb.com/docs/atlas/app-services/reference/find-your-project-or-app-id/#std-label-find-your-app-id) from the App Services UI.
2. Paste the copied ID as the value of the existing variable `ATLAS_APP_ID` in [src/atlas-app-services/config.ts](./src/atlas-app-services/config.ts):
\```ts
export const ATLAS_APP_ID = "YOUR_APP_ID";
\```

3. Start the app

\```sh
npm run build
npm start
\```

Notes:

• The mention of ATLAS_APP_ID assumes a refactor of the code, but you can always change it along with the link if you decide not to refactor 👍
• The code shown under Start the app assumes that a start script has been added in package.json (I left a previous alternative where the start script also calls the build script. If so, you could just show npm start).

[kneth]

I think it is related to https://github.com/realm/realm-js/pull/6116/files#r1321373935

[elle-j]

Yeah seems related 🙂 I believe the example runs fine without the git submodule update. Also if you e.g. copy the example directory to outside the js repo, it should run fine.

[kneth]

True. And as @takameyer is saying, we should find a way to make the example easily accessible.

[takameyer]

If we just don't add this to the workspaces, then it will treat itself like a separate project within realm-js. Currently it is not in workspaces, so I guess the git submodule update isn't even a necessary step here. It would just download the realm package into the local node_modules

[takameyer]

Also, we should know as a team that if we want to test these examples against the local version of realm, this could be done by adding the example to the workspaces. The only issue would be with the React Native projects, as these require a bit of configuration changes to work within the mono-repo.

[elle-j]

Suggested change

	│ │ ├── machine_info.ts
	│ │ └── sensor_reading.ts
	│ │ ├── MachineInfo.ts
	│ │ └── SensorReading.ts