🛜 Cribl Pack for Starlink 🚀

---

This Pack is designed to be installed on a Cribl Edge Node within your Starlink network. It enables the collection of data from the Starlink API, which can then be sent to any Cribl-supported output.

About This Pack

Objective

Recreate the default dashboard from the Starlink app using Cribl's full-stack capabilities. This approach enables:

• Real-Time Alerts: Monitor key metrics and trigger alerts promptly.
• Data Retention: Store data for historical analysis and trend tracking.
• Enhanced Insights: Gain deeper visibility into system performance and operational efficiency.

Dashboard in Cribl

🔭 Architecture

📡 Deployment - Collect Data

To set up the environment, follow these steps:

1. Create a subfleet, install this pack, commit, and deploy.

2. SSH into the node and navigate to the following directory:

   ~/cribl-pack-for-starlink/bin

3. Create a virtual environment:

   python -m venv venv

4. Activate the virtual environment:

   source venv/bin/activate

5. Install the required dependencies:

   pip install -r requirements.txt

🛰️ Configure Source - Edge

1. Go to More > Sources > Add Source > Exec > Add Source > Manage as JSON > import .json files one at a time.

📍 Configure Destination - Edge

1. Go to More > Destination > Add Destination > Cribl HTTP > Add Cribl Endpoint
2. How to find Endpoint IP/Ingress IP If on cribl.cloud > click on Access Details

3. Ingress IP

🔀 Configure Route - Edge

1. Navigate to More > Data Routes.
2. Add a filter for the exec input.
   • Example: __inputId.includes('starlink').

BEAST MODE(Reccomended): Manage routes as json. Import json

🕊️ Top-Level Routing - Edge

📦 Pack-Level Routing - Edge

🛰️ Configure Source - Stream

1. Go to More > Sources > Add Source > Cribl HTTP > Disable in_cribl_http > Manage as json > import json

🐟 Configure Lake - Create Dataset

How to Create a Dataset in Cribl Lake

I named mine starlink. A 30 Day Rention Period is should be sufficient.

📍 Configure Destination - Stream

1. Go to More > Destination > Add Destination > Cribl Lake > Create output ID

🔀 Configure Route - Steam

1. Navigate to More > Data Routes.
2. Add a filter for the exec input.
   • Example: __inputId=='cribl_http:starlink-in_cribl_http'.
   • Output: cribl_lake:starlink

📝 Scripts

• dish_common.py: Common functions and utilities for Starlink dish communication.
• dish_grpc_text.py: Main script for collecting data from Starlink dishes using gRPC.
• starlink_grpc.py: gRPC client implementation for Starlink dish communication.

🚦 Supported Modes

The following 11 data collection modes are supported:

• alert_detail
• bulk_history
• location
• obstruction_detail
• ping_drop
• ping_latency
• ping_loaded_latency
• ping_run_length
• power
• status
• usage

🔧 Requirements

• Python 3.x
• gRPC libraries for Python
• See requirements.txt

Pipeline Example - IN

Pipeline Example - OUT

⚠️ Troubleshooting

Ensure you have the necessary permissions to run these scripts and access the Starlink dish data.

📝 Release Notes

Version 0.4.0

• Added Dashboard

Version 0.3.0

• Fixed timestamping issue, events were showing up 3-4hrs behind, autotimestamp function added.

Version 0.2.0

• Archived Bash Scripts replaced with exec source to control python scripts, routing into cribl lake

Version 0.1.0

• Initial Release

🤝 Contributing to the Pack

To contribute, please message me on GitHub or create a pull request:

📜 License

This Pack uses the following license: MIT.

🏆 Credit

Python Scripts: starlink-grpc-tools

---