Collecting Telemetry Data

Before you begin, you must be part of a Juice Telemetry collection program. You should have received an email invitation to join. If you haven't received an invitation, please contact our support team.

---

What We Collect

To provide insights into your hardware's performance and health, the Juice agent collects operational metadata. We do not collect any personal files, source code, or other customer content. The agent only sends system-level information.

Here’s a summary of the data we collect and how often it's sent:

Category	Examples	Frequency
Host	hostname, os, osVersion, systemManufacturer, systemModel, systemType, CPUmodel, systemStorage, systemRam	On agent start
GPU	utilizationGpu, vramUsed, temperatureGpu, powerDraw, fanSpeed, clockCore, clockThrottling, pState	Every 5 seconds
Agent	version, lastCheckinStatus, errors	On agent start

Setup Instructions

Step 1: Accept Your Invitation

First, find the telemetry program invitation in your email inbox and accept it. Follow the link and create your account.

Step 2: Create an M2M Token

The agent requires a secure Machine-to-Machine (M2M) token to authenticate with the Juice platform.

1. Log in to the Juice admin interface at app.juicelabs.co.
2. Navigate to the M2M Tokens page.
3. Click Create Token and give the token a name (e.g., telemetry-agent-token).
4. Copy the generated token immediately and store it somewhere safe. You won't be able to see it again after you navigate away from the page.

Important

The M2M token is a security credential. Treat it like a password and do not share it or expose it in public repositories.

Step 3: Install the Agent

Choose from one of the Agent installation methods below. Whichever method you choose, you will need the M2M Token you created in the previous step to configure the agent.

Bare Metal and Virtual Machines

For standard Linux environments, you can use the one-step curl command to download and run the installer. This is the fastest way to get started.

Before You Run

Make sure to replace [token] with the M2M token you created in Step 2.

curl https://get.juicelabs.co | \
INSTALL_JUICE_TOKEN=[token] \
INSTALL_JUICE_POOL=telemetry \
sh -

For more details on the installer script, see the repository here: Installer

Docker and Docker Compose

Dockerfile

Kubernetes

Helm Charts

Step 4: View Your Data

Once the agent is running, it will begin collecting and sending data.

Navigate to the Metrics page in the admin interface.

You're all set! The agent will now run in the background and continue to collect telemetry. 🚀

Getting Help

If you run into any issues during setup or have questions, don't hesitate to reach out.

Email: Send a detailed message to help@juicelabs.co.

Help Widget: Click the Feedback widget in the lower right of the app.juicelabs.co website.