Starlink

Introduction

Starlink is a satellite network developed by SpaceX to provide low-cost internet to remote locations. It is the world’s first and largest satellite constellation using low Earth orbit to deliver broadband internet capable of supporting streaming, online gaming, video calls, and more.

Generate credentials (client ID and client secret)

To onboard the Starlink integration, you need to generate a client ID and client secret. These credentials are essential for obtaining an authorization token, which is required to call the available API endpoints.
To set up API access, log into your Starlink account home page. In the Your Service Accounts section, click + in the top right corner to create a new service account. If you do not see the Your Service Accounts section, contact your account manager to inquire about access.
Fill in the applicable fields:
- Name: Enter a name for your service account.
- Secret: Provide the secret for your service account, which will be used for authentication.
- Grant Type: Select Client Credentials (unless you have a specific reason to use Authorization Code).
Once the service account is created, a system-generated client ID will be provided. This client ID, along with the client secret of the service account, can be used to onboard the integration.

Discovery

The available resources under Starlink are as follows:

Starlink Account
Starlink User Terminal

Starlink publishes relationships between resources to provide a topological view and ease of maintenance. The hierarchy of Starlink resources is as follows:

Starlink Account
- Starlink User Terminal

Configure the Integration

From All Clients, select a client.
Navigate to Setup > Account.
Select the Integrations and Apps tab.
The Installed Integrations page, where all the installed applications are displayed.
Note: If there are no installed applications, it will navigate to the ADD APP page.
Click + ADD on the Installed Integrations page. The Available Integrations and Apps page displays all the available applications along with the newly created application with the version.
Note: You can even search for the application using the search option available. Also you can use the All Categories option to search.
Click ADD under Starlink:

In the Account Information page, enter your account information:


Field	Description
Name	(required) User-defined, descriptive integration name.
Client Id	(required) Enter client ID.
Client Secret	(required) Enter the client secret.
Confirm Client Secret	(required) Re-enter the client secret.

Click Next.
In the RESOURCE TYPE section, select:
- ALL: All the existing and future resources will be discovered.
- SELECT: You can select one or multiple resources to be discovered.
In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:
- Minutes
- Hourly
- Daily
- Weekly
- Monthly
Click SAVE.
The application is now installed and displayed on the Installed Integration page. Use the search field to find the installed application.
After configuring the integration, the Starlink metrics can be viewed from the Infrastructure page.

Monitoring

You can start collecting monitoring data without applying templates. However, to enable alerting on these metrics, templates must be applied. Once the resources are discovered, OpsRamp supports monitoring the following metrics for the Starlink User Terminal.

Click here to view the supported metrics


Native Type	Metric Name	Metric Display Name	Units	Description
Starlink User Terminal	starlink_downlink_throughput	Downlink Throughput	Mbps	Refers to the rate at which data is received from the Starlink satellite network to the user terminal.
	starlink_uplink_throughput	Uplink Throughput	Mbps	Refers to the rate at which data is sent from the user's terminal to the Starlink satellite network.
	starlink_ping_drop_rate	Ping Drop Rate	Percentage	Average packet loss over the last 15 seconds is measured by sending pings at a frequency of 10 Hz to the Starlink point of presence. Pings that do not receive a response within 2 seconds are considered dropped. This metric ranges from 0.0 to 1.0, where 0 indicates no packet loss and 1 indicates complete packet loss.
	starlink_ping_latency	Ping Latency	ms	Average ping latency from the Starlink user terminal to the Starlink point of presence.
	starlink_obstruction	Obstruction	Percentage	Moving average percentage of time the Starlink user terminal has been obstructed.
	starlink_uptime	Uptime	Seconds	Time since the device booted, in seconds.
	starlink_signal_quality	Signal Quality	Percentage	Signal Quality is a metric derived from the Signal to Noise Ratio (SNR), typically ranging between 0 and 10 dB. This value is then represented as a percentage from 0% to 100%. Signal Quality will not report values exceeding 10 dB or falling below 0 dB.
	starlink_H3CellId	H3CellId	n/a	The location of the user terminal represented as an H3 cell.

Alerting

Alerts received from the API are shown in the alerts section for the discovered resources.

OpsRamp supports alerting for the following alerts related to the Starlink User Terminal:


Alert Name	Definition
ethernet_slow_10mbps	Ethernet link speed is negotiated to 10 Mbps.
ethernet_slow_100mbps	Ethernet link speed is negotiated to 100 Mbps.
power_supply_thermal_throttling	The power supply is indicating that it is overheating and may shut down soon.
actuator_motor_stuck	The Starlink actuator motor is currently jammed or stuck.
mast_not_vertical	The Starlink dish is not installed with the mast tilted more than 30 degrees from the vertical position.
unable_to_align	Unable to align to desired tilt direction.
power_disconnect_detected	Starlink detected that the previous reboot was due to a power loss.
thermal_shutdown	The Starlink has exceeded the maximum temperature thresholds and requires a reboot to recover.
thermal_throttle	The Starlink has exceeded the high temperature thresholds and will reduce the performance to a lower temperature.
disabled_no_active_account	The service is disabled because the account or associated service line is not active.
disabled_too_far_from_service_address	The service is disabled because the Starlink is too far from the service address.
disabled_no_service_in_ocean	The service is disabled because the Starlink is in the ocean without a service that supports maritime conditions.
disabled_invalid_country	The service is disabled because the Starlink is in an unsupported country.
pop_change	The Starlink point of presence (PoP) location has changed. This may result in a brief disconnect and an IP address change.
disabled_moving_while_not_mobile	The service is disabled because the Starlink device is mobile and lacks mobile service connectivity.
disabled_moving_too_fast	The service is disabled because the Starlink device is moving too fast without an aviation service plan.
high_time_obstruction	The Starlink system is detecting frequent obstructions within its field of view.
software_update_reboot_pending	A pending Starlink software update is scheduled to reboot at 3 AM local time (+/- 30 minutes).

External reference

Starlink docs