Merge remote-tracking branch 'origin/main'

Author: peterpeterparker

blog/2023-09-21-introducing-juno-analytics-unlock-deeper-insights-with-privacy-in-mind/index.md

@@ -0,0 +1,73 @@
+---
+slug: introducing-juno-analytics-unlock-deeper-insights-with-privacy-in-mind
+title: Introducing Juno Analytics - Unlock Deeper Insights with Privacy in Mind
+authors: [peterpeterparker]
+tags: [dapp, web3, analytics, opensource]
+image: https://juno.build/assets/images/introducing-juno-analytics-unlock-deeper-insights-with-privacy-in-mind-fb4d97daf48952a39b95259bf8a7d369.png
+---
+
+![](./introducing-juno-analytics-unlock-deeper-insights-with-privacy-in-mind.png)
+
+---
+
+We're excited to introduce [Juno Analytics](../../docs/build/analytics), a simple, performant, and open-source web3 analytics solution designed with privacy in mind for the developers building decentralized dapps with Juno.
+
+In a digital age where data privacy is paramount, Juno Analytics empowers you to gather valuable insights about your users while ensuring anonymity and respecting their privacy.
+
+Here's a closer look at this powerful new feature:
+
+---
+
+## Privacy-Friendly Analytics
+
+Juno Analytics is part of our commitment to user privacy. It conducts measurements of your dapps and sites completely anonymously, without using cookies or collecting any personal data.
+
+This means no more intrusive cookie banners, no persistent identifiers, no cross-site tracking, and no cross-device tracking.
+
+Your analytics data remains solely focused on providing you valuable insights without any other ulterior motives.
+
+---
+
+## Performance-Optimized Script
+
+Our JavaScript library for gathering analytics is designed for peak performance. It consists of a minimal main script that seamlessly integrates with your application's user interface and a dedicated worker responsible for handling logic and cryptography.
+
+This thoughtful design ensures that adding analytics won't slow down your application, even during boot time, preserving your customer acquisition rate.
+
+---
+
+## Comprehensive Tracking
+
+With Juno Analytics, you're not limited to just basic page views. You can gain deeper insights into your visitors by creating custom events to track conversions, attributions, and more. It's a powerful tool for optimizing your dapps and sites.
+
+---
+
+## Fully Open Source
+
+Juno is fully committed to the principles of open-source development. Unlike proprietary tools like Google Analytics, Juno Analytics is built with a commitment to transparency and freedom.
+
+---
+
+## You Own Your Data
+
+All data tracked by our analytics solution is securely stored on the blockchain. As with all our services, you have full control over your smart contracts, and your data remains exclusively yours.
+
+---
+
+## Getting Started
+
+To begin using Juno Analytics, please refer to our detailed documentation for [step-by-step instructions](/docs/build/analytics#getting-started).
+
+It will guide you through the process of setting up and integrating Analytics into your websites and dapps. 🚀
+
+---
+
+## Conclusion
+
+We hope you're as excited about Juno Analytics as we are! This feature marks a significant stride toward a more privacy-conscious analytics solution and provide Juno's developers an additional feature in the eco-system to build awesome decentralized applications.
+
+👋
+
+Stay connected with Juno by following us on [Twitter](https://twitter.com/junobuild).
+
+⭐️⭐️⭐️ stars are also much appreciated: visit the [GitHub repo](https://github.com/buildwithjuno/juno) and show your support!

blog/2023-09-21-introducing-juno-analytics-unlock-deeper-insights-with-privacy-in-mind/introducing-juno-analytics-unlock-deeper-insights-with-privacy-in-mind.png

@@ -0,0 +1,219 @@
+---
+sidebar_position: 5
+---
+
+# Analytics
+
+Juno Analytics, a simple, performant, and open-source web3 analytics solution that respects your users' privacy and doesn't use cookies, ensuring anonymity while providing valuable user insights.
+
+![Juno's Analytics screenshot](../img/analytics.webp)
+
+## Features
+
+Juno Analytics offers several advantages for developers:
+
+### No cookie banners required
+
+Just like all of Juno's features, Analytics prioritizes privacy. It conducts dapp and site measurements entirely anonymously, without using cookies or collecting personal data. There are no persistent identifiers, cross-site tracking, or cross-device tracking. Your analytics data is not used for any other purposes.
+
+### Performance-Optimized Script
+
+Juno's JavaScript library for statistics is optimized for performance. It consists of a minimal main script that seamlessly integrates with your application's UI and a dedicated worker responsible for handling logic and cryptography. This design ensures that adding analytics won't impact your application's performance, including its boot time, and per extension preserving your customer acquisition rate.
+
+### Track goal conversions and campaigns
+
+Beyond standard page views, you can gain valuable insights into your visitors by creating custom events to track conversions and attribution.
+
+### Transparent and fully open source
+
+Juno is fully open source, including all its Analytics features, setting it apart from proprietary tools like Google Analytics.
+
+Furthermore, unlike any other analytics alternative or solution, Juno's long-term vision is to evolve into a decentralized organization (DAO), embracing a new paradigm in the analytics industry.
+
+## Considerations
+
+In deploying Juno Analytics, it's important to understand various aspects that can affect its use and compliance.
+
+### GDPR and PECR compliance
+
+Juno Analytics refrains from generating persistent identifiers. Temporary anonymous data is stored in IndexedDB until it is synchronized with the smart contract. It employs a random unique string to calculate unique visitor sessions on a website with each new visit.
+
+While we are not legal experts and the responsibility for adding analytics to your project ultimately rests with you, the above approach aligns our analytics with various cookie laws and privacy regulations, including GDPR and PECR.
+
+### Hosted on the blockchain
+
+All tracked data is securely stored on the blockchain without any specific geolocation. Currently, Analytics is not guaranteed to be located in Europe.
+
+### No cross-dapp tracking
+
+Juno Analytics does not follow users across websites and applications they visit. All data remains isolated to a single satellite.
+
+### You 100% own your data
+
+As with all services provided by Juno, you are the sole controller of your smart contracts, and your data belongs exclusively to you.
+
+You have the capability to delete all collected data within your Analytics at any time by utilizing the [CLI] to reset your smart contract.
+
+## How does it work?
+
+To gather analytics for your dapps, you need to create an [orbiter]. Creating an Orbiter requires ICP, and its price is defined in the [transaction costs](../pricing#transaction-costs).
+
+Each orbiter is used to collect analytics for one or multiple [satellites].
+
+Page views are collected anonymously and saved with a unique random ID for attribution. This data is organized based on its collection timestamp.
+
+You can also collect custom tracking events, which are organized in the same manner.
+
+Additionally, a unique random session ID is generated for all data. Each time a visitor visits your dapps, a new session is created.
+
+## Limitation
+
+Currently, an orbiter can store up to 96GB of data.
+
+:::caution
+
+Similar to other analytics services in the Web2 environment, an Orbiter accepts data submitted from any source as long as the requested payload matches the expected format, and the targeted satellite is configured to accept analytics. This is because the origin of the HTTP request cannot be accessed, for a valid reason – to prevent tracking. Therefore, calls cannot be limited to the domain of your dapps.
+
+Consequently, this leaves the canister open to potential attacks that can pollute the data and consume cycles. For this reason, we recommend the following:
+
+1. Avoid topping up the smart contract with excessive cycles; instead, adopt a lean approach.
+2. Utilize the [monitoring](../miscellaneous/monitoring.md) feature to stay informed about the status.
+3. Interpret the statistics provided by this feature with some reservation, similar to any other analytics data, considering potential inaccuracies.
+
+:::
+
+## Getting started
+
+Before integrating Juno Analytics into your app or website, you need to create an orbiter. Here's a step-by-step guide to help you get started:
+
+1. Sign in to the Juno [console](https://console.juno.build).
+2. Navigate to "Analytics" in the astronaut entry menu at the top right of your screen.
+3. Click on **Get started**
+4. Confirm by selecting **Create analytics**
+
+The platform will then create your orbiter smart contract and provision its resources. Once the process is complete, click "Close" to terminate the creation wizard.
+
+At this point, you have successfully created the analytics; however, you have not yet listed which satellites are eligible to track page views and events. To complete the configuration, proceed to the **Settings** page to register them.
+
+## Install the SDK and initialize the Orbiter
+
+To start using Juno Analytics, follow these steps:
+
+1. Install Juno's analytics library using npm:
+
+```bash
+npm i @junobuild/analytics
+```
+
+2. Initialize the orbiter in your web app or website:
+
+```typescript
+import { initOrbiter } from "@junobuild/analytics";
+
+// TODO: Replace the following satelliteId and orbiterId with the effective ID.
+await initOrbiter({
+  satelliteId: "aaaaa-bbbbb-ccccc-ddddd-cai",
+  orbiterId: "eeeee-fffff-ddddd-11111-cai",
+});
+```
+
+3. Copy the pre-packaged web worker provided by the library to your `public` or `static` folder, where your project's static assets are located.
+
+- You can achieve this by adding a post-install script to your `package.json`. Here's an example of an inline command:
+
+```json
+{
+  "scripts": {
+    "postinstall": "node -e \"require('fs').cpSync('node_modules/@junobuild/analytics/dist/workers/', './static/workers', {recursive: true});\""
+  }
+}
+```
+
+- Alternatively, you can create a script, e.g., `copy-juno-workers.mjs`, at the root of your project with the following code:
+
+```js
+import { cp } from "node:fs";
+import { extname } from "node:path";
+
+await cp(
+  "node_modules/@junobuild/analytics/dist/workers/",
+  "./static/workers",
+  {
+    recursive: true,
+  },
+  (err) => {
+    if (err === null) {
+      return;
+    }
+
+    console.error(err);
+  }
+);
+```
+
+Finally, add a command to your `package.json` that executes the script:
+
+```json
+{
+  "scripts": {
+    "postinstall": "node ./scripts/copy-juno-workers.mjs"
+  }
+}
+```
+
+Once configured, run `npm run postinstall` manually to trigger the initial copy. Every time you run `npm ci`, the post-install target will execute, ensuring the worker is copied.
+
+:::info
+
+- The above example assumes that `/static` is the folder holding your static assets (e.g., images, favicons, etc.). Adjust the path according to your application.
+
+- If you prefer to specify a custom path for the worker, you can use the `initOrbiter` function with the additional parameter `{worker?: {path?: string}}` for this purpose.
+
+:::
+
+## Page views
+
+Page views, such as when a visitor opens your website or navigates to a subpage, are automatically tracked once you have configured, initialized, and deployed your application with the analytics module.
+
+There's **no need** for additional development work!
+
+## Track custom events
+
+Custom events can be tracked using the `trackEvent` function. You need to provide a `name` for the event, and you can include up to 10 custom `metadata` fields.
+
+:::note
+
+This is an option. As explained in the previous chapter, the library will take care of gathering insightful anonymous data as soon as it is configured and initialized.
+
+Custom events are useful if you want to take an extra step and collect your own specific information.
+
+:::
+
+Here's an example of how to use it:
+
+```javascript
+import { trackEvent } from "@junobuild/analytics";
+
+await trackEvent({
+  name: "Your custom event",
+  metadata: {
+    your_key: "A value",
+    your_other_key: "Another value",
+  },
+});
+```
+
+This allows you to track specific events and gather data relevant to your application.
+
+:::note
+
+For scalability and optimization reasons, the data collected must adhere to certain rules, particularly regarding their length. For instance, a randomly generated key should not exceed 36 bytes in length.
+
+For detailed information about these rules, please refer to Juno's GitHub [repository](https://github.com/buildwithjuno/juno).
+
+:::
+
+[CLI]: ../miscellaneous/cli.md
+[satellites]: ../terminology.md#satellite
+[orbiter]: ../terminology.md#orbiter
+[controllers]: ../terminology.md#controller

docs/build/analytics.md

@@ -6,30 +6,32 @@ sidebar_position: 11
 
 There are two types of costs associated with using Juno.
 
-1. Operating costs for your [mission control] or satellites
+1. Operating costs for your [mission control], satellites and orbiters
 2. Costs for executing transactions with Juno
 
 :::note
 
-Last update: June 15, 2023
+Last update: Sept. 17, 2023
 
 :::
 
 ## Operating costs
 
-As the owner of your mission control or satellites, you are responsible for their operating costs.
+As the owner of your mission control, satellites and orbiters, you are responsible for their operating costs.
 
 To ensure that your infrastructure usage is covered, you must maintain a minimum balance of [cycles](terminology.md#cycles).
 
 You can top up your cycle balance in the Juno [console](https://console.build.com) using ICP from your mission control or from anywhere else on the [Internet Computer](https://internetcomputer.org/).
 
 ## Transaction costs
 
-New developers joining Juno are given credits to create a mission control and their first [satellite].
+New developers who join Juno are granted credits to create a mission control and their initial [satellite].
 
-To create additional satellites, a fee of 0.5 ICP is required, in addition to the costs required by the infrastructure to create the smart contract.
+To create additional satellites, a fee of 0.5 ICP is necessary, along with the infrastructure costs for setting up the smart contract.
 
-Please note that further transaction fees may be required in the future and prices and models are subject to change.
+Similarly, enabling analytics by creating an [orbiter] entails a fee of 0.5 ICP, plus the infrastructure costs for creating the smart contract.
+
+Please note that additional transaction fees may be introduced in the future, and pricing and models are subject to change.
 
 ## Cost examples
 
@@ -69,3 +71,4 @@ You are the owner of your mission control, and Juno has no control or access to
 
 [mission control]: terminology.md#mission-control
 [satellite]: terminology.md#satellite
+[orbiter]: terminology.md#orbiter

docs/img/analytics.webp

@@ -10,7 +10,6 @@ We have big plans for the near and distant future.
 
 Our goal is to continue delivering features that seamlessly integrate both web3 and web2 worlds, while ensuring ease of development. This includes:
 
-- Analytics
 - Plug-and-play recurring payment and paywall solutions
 - Handing over [mission control] or [satellite] to DAO SNS (Service Nervous Systems)
 
@@ -29,7 +28,7 @@ While Juno is currently focused on individual developers, we recognize the impor
 To support growth and foster new ideas, we aim to make various infrastructure improvements, including:
 
 - Upgrading satellites overall available memory, starting with 64 GB
-- Enabling the implementation of backend functions in response to events triggered in satellites
+- Enabling the implementation of backend functions ("serverless functions") in response to events triggered in satellites
 - Replacing quick queries with certified calls by default
 - Automatically topping up mission control and satellites
 - Providing real-time data updates

docs/pricing.md

@@ -52,6 +52,10 @@ For a schematic representation, refer to the [Architecture](./architecture.md) d
 
 [NFID](https://nfid.one) is a digital identity that provides private and secure sign-in to applications. It offers a convenient way to authenticate with third-party providers like [Metamask](https://metamask.io/) and [Google](https://www.google.com/account/about/).
 
+## Orbiter
+
+An orbiter is the term we use to refer to the smart contract that can optionally be employed for analytics to gather valuable, anonymous insights about your users.
+
 ## Principal
 
 Principals are generic identifiers for the [console], [mission controls], [satellites], and users.

docs/roadmap.md

@@ -6,6 +6,7 @@ import Authentication from "@site/static/icons/authentication.svg";
 import Datastore from "@site/static/icons/datastore.svg";
 import Storage from "@site/static/icons/storage.svg";
 import Hosting from "@site/static/icons/hosting.svg";
+import Analytics from "@site/static/icons/analytics.svg";
 
 export default function Features(): JSX.Element {
   return (
@@ -57,6 +58,17 @@ export default function Features(): JSX.Element {
           }
           icon={<Hosting />}
         />
+
+        <Feature
+          title="Analytics"
+          text="Gather valuable, anonymous user insights with a simple, lightweight, and open-source web analytics that do not use cookies."
+          link={
+            <Link to="/docs/build/analytics" className={styles.link}>
+              Learn more
+            </Link>
+          }
+          icon={<Analytics />}
+        />
       </div>
     </>
   );