PHPackages                             statview/satellite - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. statview/satellite

ActiveLibrary[Utility &amp; Helpers](/categories/utility)

statview/satellite
==================

Satellite package for Statview

2.1.0(2w ago)14.3k↓81.7%11PHP

Since Jul 15Pushed yesterday2 watchersCompare

[ Source](https://github.com/statview-app/satellite-laravel)[ Packagist](https://packagist.org/packages/statview/satellite)[ RSS](/packages/statview-satellite/feed)WikiDiscussions main Synced yesterday

READMEChangelog (10)Dependencies (18)Versions (26)Used By (1)

Statview Satellite
==================

[](#statview-satellite)

The package that sets up the communication channel for Statview. More information at .

Requirements
------------

[](#requirements)

- PHP 8.2+
- Laravel 11, 12 or 13

Installation
------------

[](#installation)

### Composer require

[](#composer-require)

```
composer require statview/satellite
```

### Publishing the config

[](#publishing-the-config)

```
php artisan vendor:publish --tag="statview-config"
```

### Adding environment variables

[](#adding-environment-variables)

You can get the variable data during the project setup at Statview.

```
STATVIEW_DSN=
```

The DSN contains your endpoint, project id and API key. The package parses it automatically, so setting `STATVIEW_DSN` is all you need for a default setup.

#### Optional environment variables

[](#optional-environment-variables)

```
# Override the Statview endpoint (defaults to https://statview.app)
STATVIEW_ENDPOINT=

# Disable SSL verification for outgoing calls (defaults to true)
STATVIEW_VERIFY_SSL=false

# Restrict the satellite routes to a domain
STATVIEW_DOMAIN=

# Change the route prefix (defaults to statview/satellite)
STATVIEW_PATH=
```

### Maintenance mode

[](#maintenance-mode)

You need to make an exception for Statview to access your app during maintenance mode if you want to turn off maintenance mode from your Statview panel.

Add statview to the `$except` array of your `PreventRequestsDuringMaintenance` middleware.

```
/**
 * The URIs that should be reachable while maintenance mode is enabled.
 *
 * @var array
 */
protected $except = [
    '/statview/*'
];
```

Usage
-----

[](#usage)

### Provide data for widgets

[](#provide-data-for-widgets)

You can register your widgets by adding them in a Service Provider.

```
use Statview\Satellite\Statview;
use Statview\Satellite\Widgets\Widget;

public function boot()
{
    Statview::registerWidgets(function () {
        return [
            Widget::make('total_users')
                ->title('Total users')
                ->value(User::count())
                ->description('All the users since start of the project'),

            Widget::make('total_teams')
                ->title('Total teams')
                ->value(Team::count()),

            Widget::make('total_projects')
                ->title('Total projects')
                ->value(Project::count()),
        ];
    });
}
```

#### Chart widgets

[](#chart-widgets)

Use `ChartWidget` to push chart data instead of a single value.

```
use Statview\Satellite\Widgets\ChartWidget;

ChartWidget::make('signups')
    ->title('Signups')
    ->type('line') // Defaults to line
    ->data([
        ['label' => 'Jan', 'value' => 12],
        ['label' => 'Feb', 'value' => 30],
    ]);
```

#### Testing your widgets

[](#testing-your-widgets)

You can preview the registered widgets and their resolved values from the command line.

```
php artisan statview:test-widgets
```

### Post messages to your timeline

[](#post-messages-to-your-timeline)

Posting messages to your timeline is very easy. The Satellite package has everything built-in to start posting to your timeline.

```
use Statview\Satellite\Statview;
use Statview\Satellite\Enums\PostType;

Statview::postToTimeline(
    title: 'Houston, we have a problem',
    body: 'There is a problem with renewing subscriptions.',
    type: PostType::Danger, // Defaults to PostType::Default
    icon: '🚨', // Expects emoji string - defaults to the icon of the given type
);
```

The available types are `PostType::Default`, `PostType::Info`, `PostType::Danger`, `PostType::Warning` and `PostType::Success`. Each type has a default icon, which is used when you don't pass one yourself.

#### Adding actions to a timeline message

[](#adding-actions-to-a-timeline-message)

You can attach actions (links) to a timeline message.

```
use Statview\Satellite\Statview;
use Statview\Satellite\Enums\PostType;
use Statview\Satellite\Widgets\Action;

Statview::postToTimeline(
    title: 'New signup',
    body: 'A new customer just signed up.',
    type: PostType::Success,
    actions: [
        Action::make()
            ->label('View customer')
            ->icon('👤')
            ->url('https://example.com/customers/1'),
    ],
);
```

### Gauges

[](#gauges)

Increment or decrement a gauge by tag.

```
use function Statview\gauge;

gauge()->increment('active_subscriptions');
gauge()->decrement('active_subscriptions', 2);
```

### Announcements

[](#announcements)

Fetch the announcements configured in your Statview panel.

```
use Statview\Satellite\Statview;

$announcements = Statview::getAnnouncements();
```

Support
-------

[](#support)

Send us an email at support\[at\]statview.app. We are happy to help.

###  Health Score

50

—

FairBetter than 95% of packages

Maintenance98

Actively maintained with recent releases

Popularity23

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 85.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~44 days

Recently: every ~112 days

Total

25

Last Release

18d ago

Major Versions

1.4.0 → 2.0.02026-04-28

1.4.1 → 2.0.12026-04-28

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/6506510?v=4)[Sebastiaan Kloos](/maintainers/SebastiaanKloos)[@SebastiaanKloos](https://github.com/SebastiaanKloos)

---

Top Contributors

[![SebastiaanKloos](https://avatars.githubusercontent.com/u/6506510?v=4)](https://github.com/SebastiaanKloos "SebastiaanKloos (42 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (3 commits)")[![jelleroorda](https://avatars.githubusercontent.com/u/9193686?v=4)](https://github.com/jelleroorda "jelleroorda (2 commits)")[![stayallive](https://avatars.githubusercontent.com/u/1090754?v=4)](https://github.com/stayallive "stayallive (2 commits)")

###  Code Quality

TestsPest

### Embed Badge

![Health badge](/badges/statview-satellite/health.svg)

```
[![Health](https://phpackages.com/badges/statview-satellite/health.svg)](https://phpackages.com/packages/statview-satellite)
```

###  Alternatives

[laravel/horizon

Dashboard and code-driven configuration for Laravel queues.

4.2k95.4M304](/packages/laravel-horizon)[spatie/laravel-export

Create a static site bundle from a Laravel app

674146.0k6](/packages/spatie-laravel-export)[illuminate/queue

The Illuminate Queue package.

21332.6M1.6k](/packages/illuminate-queue)[illuminate/console

The Illuminate Console package.

13046.0M6.5k](/packages/illuminate-console)[illuminate/process

The Illuminate Process package.

44869.2k99](/packages/illuminate-process)[psalm/plugin-laravel

Psalm plugin for Laravel

3355.3M346](/packages/psalm-plugin-laravel)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
