Laravel Telescope

https://github.com/laravel/telescope
Admin
Laravel Telescope is an elegant debug assistant for the Laravel framework, providing insight into...
Tokens:83,772
Snippets:693
Trust Score:9.7
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### start($app)

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/telescope.md

Bootstrap entry point called by the service provider. It starts recording if Telescope is enabled and the request or command is approved.

```APIDOC
## start($app)

### Description
Bootstrap entry point called by the service provider. If `config('telescope.enabled')` is falsy it returns immediately. Otherwise it registers watchers, registers the mailable-tag extractor, and starts recording without loading monitored tags when not under Octane and an approved command or request is being handled.

### Method
`start`

### Parameters
- `$app` (\Illuminate\Foundation\Application) - Required - The application instance.

### Returns
`void`

```

--------------------------------

### start($app) method signature

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/telescope.md

Bootstrap entry point called by the service provider. Returns immediately if config('telescope.enabled') is falsy; otherwise registers watchers and starts recording without monitored tags when not under Octane and handling an approved command or request.

```php
public static function start($app)
```

--------------------------------

### telescope:show usage examples

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/console-commands.md

Example invocations: show latest exception with full output, and show a specific UUID with type filters as JSON.

```bash
php artisan telescope:show latest:exception --full
php artisan telescope:show <uuid> --type=query,cache --json
```

--------------------------------

### Telescope::startRecording($loadMonitoredTags = true)

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/configuration.md

Starts recording Telescope entries. Optionally loads monitored tags.

```APIDOC
## Telescope::startRecording($loadMonitoredTags = true)

### Description
Starts recording Telescope entries. Optionally loads monitored tags.

### Method
Static method on `Laravel\Telescope\Telescope`

### Parameters
- **$loadMonitoredTags** (bool) - Optional - Whether to load monitored tags. Defaults to true.

```

--------------------------------

### telescope:list usage examples

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/console-commands.md

Example invocations: list request entries with limit 10, and list exception entries filtered by tag 'slow' as JSON.

```bash
php artisan telescope:list request --limit=10
php artisan telescope:list exception --tag=slow --json
```

--------------------------------

### Programmatic usage example

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/repositories.md

Shows how to instantiate the repository and use its methods for querying, monitoring, and pruning.

```php
use Laravel\Telescope\Storage\DatabaseEntriesRepository;
use Laravel\Telescope\Storage\EntryQueryOptions;

$repo = new DatabaseEntriesRepository('mysql', 500);

$entries = $repo->get('query', EntryQueryOptions::forBatchId($batchId)->limit(25));

$repo->monitor(['invoice:42']);
$repo->stopMonitoring(['invoice:42']);
$repo->prune(now()->subDays(7), keepExceptions: true);
```

--------------------------------

### Application usage example

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/service-providers.md

Example of overriding register() and gate() in the application's TelescopeServiceProvider to filter entries and restrict access by email.

```php
namespace App\Providers;

use App\Models\User;
use Illuminate\Support\Facades\Gate;
use Laravel\Telescope\IncomingEntry;
use Laravel\Telescope\Telescope;
use Laravel\Telescope\TelescopeApplicationServiceProvider;

class TelescopeServiceProvider extends TelescopeApplicationServiceProvider
{
    public function register(): void
    {
        $isLocal = $this->app->environment('local');

        Telescope::filter(function (IncomingEntry $entry) use ($isLocal) {
            return $isLocal ||
                   $entry->isReportableException() ||
                   $entry->isFailedRequest() ||
                   $entry->isFailedJob() ||
                   $entry->isScheduledTask() ||
                   $entry->hasMonitoredTag();
        });
    }

    protected function gate(): void
    {
        Gate::define('viewTelescope', function (User $user) {
            return in_array($user->email, ['admin@example.com']);
        });
    }
}
```

--------------------------------

### EntryQueryOptions usage example

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/repositories.md

Shows how to create an EntryQueryOptions instance from a request. This is the pattern used by EntryController::index.

```php
$options = EntryQueryOptions::fromRequest($request); // used by EntryController::index
```

--------------------------------

### Example — consumed from a controller

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/entry-result.md

Route example showing how to retrieve an EntryResult with avatar link populated using EntriesRepository::find() and generateAvatar().

```php
use Laravel\Telescope\Contracts\EntriesRepository;

Route::get('/entry/{id}', function (EntriesRepository $storage, $id) {
    // Returns EntryResult with avatar link populated:
    return response()->json($storage->find($id)->generateAvatar());
});
```

--------------------------------

### Telescope::tag() example

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/telescope.md

Adds tags to entries. The callback receives an IncomingEntry and returns an array of tags, which are merged into the entry's tag list. This example adds a 'host:' tag for request entries.

```php
Telescope::tag(function (IncomingEntry $entry) {
    return $entry->type === EntryType::REQUEST
        ? ['host:'.gethostname()]
        : [];
});
```

--------------------------------

### FormatModel usage example

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/utilities.md

Example of using FormatModel::given() to format an Eloquent model. Outputs App\Models\Order:42.

```php
use Laravel\Telescope\FormatModel;

echo FormatModel::given($order); // App\Models\Order:42
```

--------------------------------

### QueryWatcher configuration example

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/watchers-reference.md

Configure the QueryWatcher with enabled, slow threshold, and ignore_packages options. The slow option flags queries slower than the specified milliseconds.

```php
'watchers' => [
    Watchers\QueryWatcher::class => [
        'enabled' => true,
        'slow' => 500,          // flag queries slower than 500ms
        'ignore_packages' => true,
    ],
],
```

--------------------------------

### telescope:install command

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/console-commands.md

Publishes the service provider stub, config, and migrations, then registers the provider in bootstrap/providers.php or config/app.php.

```bash
telescope:install
```

--------------------------------

### Telescope::filter() example

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/telescope.md

Filters which entries are recorded. The callback receives an IncomingEntry and must return a truthy value to keep it. This example keeps reportable exceptions, failed requests, failed jobs, scheduled tasks, and entries with monitored tags.

```php
use Laravel\Telescope\IncomingEntry;
use Laravel\Telescope\Telescope;

Telescope::filter(function (IncomingEntry $entry) {
    return $entry->isReportableException() ||
           $entry->isFailedRequest() ||
           $entry->isFailedJob() ||
           $entry->isScheduledTask() ||
           $entry->hasMonitoredTag();
});
```

--------------------------------

### get method

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/repositories.md

Retrieves entries of a given type with query options, applying limit and ordering.

```php
public function get($type, EntryQueryOptions $options)
```

--------------------------------

### Example: Mark a job entry as failed

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/incoming-entry.md

Shows how to use EntryUpdate::make with addTags to record an update that marks a job entry as failed.

```php
use Laravel\Telescope\EntryType;
use Laravel\Telescope\EntryUpdate;
use Laravel\Telescope\Telescope;

// Mark a job entry as failed:
Telescope::recordUpdate(
    EntryUpdate::make($uuid, EntryType::JOB, ['status' => 'failed'])
        ->addTags(['failed'])
);
```

--------------------------------

### Example — recording gate

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/telescope.md

Shows how to check if recording is active and how to suspend recording around a sensitive operation using withoutRecording.

```php
use Laravel\Telescope\Telescope;

if (Telescope::isRecording()) {
    // only record when Telescope is active
}

// Suspend recording around a sensitive operation:
$result = Telescope::withoutRecording(function () use ($service) {
    return $service->processSecretData();
});
```

--------------------------------

### boot() method declaration

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/service-providers.md

Registers Artisan commands, publishing, uninstall listener, middleware group, routes, resources, and starts Telescope.

```php
public function boot()
```

--------------------------------

### Exception recording example

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/incoming-entry.md

Records an exception using IncomingExceptionEntry::make.

```php
use Laravel\Telescope\IncomingExceptionEntry;
use Laravel\Telescope\Telescope;

try {
    riskyCall();
} catch (\Throwable $e) {
    Telescope::recordException(
        IncomingExceptionEntry::make($e, [
            'class' => get_class($e),
            'file' => $e->getFile(),
            'line' => $e->getLine(),
            'message' => $e->getMessage(),
            'trace' => $e->getTrace(),
        ])
    );
}
```

--------------------------------

### Recording a cache entry example

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/incoming-entry.md

Shows how to create an IncomingEntry and record it via Telescope::recordCache(). The entry uses withFamilyHash and tags for grouping and search.

```php
use Laravel\Telescope\IncomingEntry;
use Laravel\Telescope\Telescope;

$entry = IncomingEntry::make(['key' => 'users:42', 'value' => 'data'])
    ->withFamilyHash(md5('users:42'))
    ->tags(['users:42']);

Telescope::recordCache($entry);
```

--------------------------------

### Publish Telescope migrations for 5.0 upgrade

Source: https://github.com/laravel/telescope/blob/5.x/UPGRADE.md

Required when upgrading to Telescope 5.0 from 4.x, as migrations are no longer auto-loaded.

```bash
php artisan vendor:publish --tag=telescope-migrations
```

--------------------------------

### Custom watcher example: SubscriptionWatcher

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/watchers.md

Example of a custom watcher that listens for a UserSignedUp event and records it via Telescope::recordEvent. It checks Telescope::isRecording() before recording and tags the entry with the user ID.

```php
namespace App\Telescope;

use Illuminate\Contracts\Foundation\Application;
use Laravel\Telescope\IncomingEntry;
use Laravel\Telescope\Telescope;
use Laravel\Telescope\Watchers\Watcher;
use MyApp\Events\UserSignedUp;

class SubscriptionWatcher extends Watcher
{
    public function register($app)
    {
        $app['events']->listen(UserSignedUp::class, [$this, 'record']);
    }

    public function record(UserSignedUp $event)
    {
        if (! Telescope::isRecording()) {
            return;
        }

        Telescope::recordEvent(IncomingEntry::make([
            'name' => UserSignedUp::class,
            'payload' => ['user' => $event->user->id],
        ])->tags(['Auth:'.$event->user->id]));
    }
}
```

--------------------------------

### Avatar::register and Avatar::url usage example

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/utilities.md

Shows how to register a custom avatar callback and then retrieve a URL. The callback receives the user id and email, returning a custom URL. The example output is https://example.com/avatars/5.png for the given input.

```php
use Laravel\Telescope\Avatar;

Avatar::register(function ($id, $email) {
    return "https://example.com/avatars/{$id}.png";
});

$url = Avatar::url(['id' => 5, 'email' => 'a@b.com']); // https://example.com/avatars/5.png
```

--------------------------------

### Example: hasWatcher with QueryWatcher

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/telescope.md

Checks if the QueryWatcher is active and executes the conditional block if so.

```php
if (Telescope::hasWatcher(\Laravel\Telescope\Watchers\QueryWatcher::class)) {
    // Query watcher is active
}
```

--------------------------------

### css() usage example in Blade layout

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/telescope.md

Outputs the Telescope dashboard CSS in a Blade layout. Use {{ \Laravel\Telescope\Telescope::css() }} to render the style tags.

```php
// In a Blade layout:
{{ \Laravel\Telescope\Telescope::css() }}
```

--------------------------------

### Publish Telescope assets and clear view cache

Source: https://github.com/laravel/telescope/blob/5.x/UPGRADE.md

Run these commands after every upgrade to publish Telescope's assets and clear the view cache.

```bash
php artisan telescope:publish
```

```bash
php artisan view:clear
```

--------------------------------

### js() usage example in Blade layout

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/telescope.md

Outputs the Telescope dashboard JavaScript in a Blade layout. Use {{ \Laravel\Telescope\Telescope::js() }} to render the script tag.

```php
{{ \Laravel\Telescope\Telescope::js() }}
```

--------------------------------

### TelescopeApplicationServiceProvider class declaration

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/service-providers.md

Base class for the application-level provider published by telescope:install; the stub extends this class.

```php
class TelescopeApplicationServiceProvider extends ServiceProvider
```

--------------------------------

### DumpWatcher runtime dump example

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/watchers-reference.md

Use this PHP snippet to capture a variable dump with DumpWatcher. It is captured only when the watcher is enabled, either via the 'always' option or the 'telescope:dump-watcher' cache key.

```php
dump($someVariable); // captured by DumpWatcher when enabled ('always' or via 'telescope:dump-watcher' cache key)
```

--------------------------------

### Example: hiding sensitive data with Telescope

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/telescope.md

Shows how to hide request parameters, request headers, and response parameters. The RequestWatcher and ClientRequestWatcher apply these when formatting headers/payloads, replacing matches with ********.

```php
Telescope::hideRequestParameters(['_token']);
Telescope::hideRequestHeaders(['cookie', 'x-csrf-token']);
Telescope::hideResponseParameters(['api_key']);
```

--------------------------------

### startRecording($loadMonitoredTags = true) method signature

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/telescope.md

Loads monitored tags from the EntriesRepository when $loadMonitoredTags is true, then reads the telescope:pause-recording cache key and sets $shouldRecord accordingly.

```php
public static function startRecording($loadMonitoredTags = true)
```

--------------------------------

### startRecording($loadMonitoredTags = true)

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/telescope.md

Loads monitored tags from the entries repository and sets the recording state based on the pause-recording cache key.

```APIDOC
## startRecording($loadMonitoredTags = true)

### Description
Loads monitored tags from the `EntriesRepository` when `$loadMonitoredTags` is true, then reads the `telescope:pause-recording` cache key (exceptions swallowed) and sets `$shouldRecord = ! $recordingPaused`.

### Method
`startRecording`

### Parameters
- `$loadMonitoredTags` (bool) - Optional - Whether to load monitored tags. Defaults to `true`.

### Returns
`void`

```

--------------------------------

### night() method signature

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/telescope.md

Sets static::$useDarkTheme = true; css() then loads dist/styles-dark.css. Returns static.

```php
public static function night()
```

--------------------------------

### js() method signature

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/telescope.md

Loads dist/app.js, normalizes line endings, then emits it in a <script type="module"> tag preceded by window.Telescope = {...scriptVariables()};. Returns HtmlString. Throws RuntimeException when dist/app.js is unreadable.

```php
public static function js()
```

--------------------------------

### css() method signature

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/telescope.md

Loads dist/app.css plus dist/styles.css (or styles-dark.css when dark theme is active) and returns them as a single Illuminate\Support\HtmlString with two <style> tags (including CSP nonce attribute when set). Throws RuntimeException when files are unreadable.

```php
public static function css()
```

--------------------------------

### GET /telescope-api/monitored-tags

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Retrieves the list of monitored tags. The response contains a JSON object with a `tags` array.

```APIDOC
## [GET] /telescope-api/monitored-tags

### Description
Retrieves the list of monitored tags. The response contains a JSON object with a `tags` array.

### Method
GET

### Endpoint
/telescope-api/monitored-tags

### Response
#### Success Response (200)
- **tags** (array of strings) - List of monitored tags.

#### Response Example
{
  "tags": ["invoice:42"]
}
```

--------------------------------

### Default auth callback in boot()

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/service-providers.md

Allows access in local environment or when the viewTelescope gate passes.

```php
Telescope::auth(function ($request) {
    return app()->environment('local') ||
           Gate::check('viewTelescope', [$request->user()]);
});
```

--------------------------------

### register() method declaration

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/service-providers.md

Merges config and registers the storage driver, defaulting to database driver.

```php
public function register()
```

--------------------------------

### GET /telescope-api/redis/{telescopeEntryId}

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Retrieves a single redis entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

```APIDOC
## [GET] /telescope-api/redis/{telescopeEntryId}

### Description
Retrieves a single redis entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

### Method
GET

### Endpoint
/telescope-api/redis/{telescopeEntryId}

### Parameters
#### Path Parameters
- **telescopeEntryId** (string) - Required - The UUID or short hex prefix of the entry.

### Request Example
```bash
curl -X GET "$APP_URL/telescope/telescope-api/redis/$ENTRY_ID" \
     -H "Accept: application/json" -b "$COOKIE_JAR"
```

### Response
#### Success Response (200)
- **entry** (object) - The redis entry details.

#### Response Example
```json
{
  "entry": {}
}
```
```

--------------------------------

### recordCommand

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/telescope.md

Records a command entry of type COMMAND. Accepts an IncomingEntry instance and returns void.

```APIDOC
## recordCommand

### Description
Records a command entry of type COMMAND. Accepts an IncomingEntry instance and returns void.

### Method
recordCommand

### Signature
public static function recordCommand(IncomingEntry $entry)

### Parameters
- **$entry** (IncomingEntry) - Required - The IncomingEntry to record.

### Returns
void
```

--------------------------------

### GET /telescope-api/schedule/{telescopeEntryId}

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Retrieves a single schedule entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

```APIDOC
## [GET] /telescope-api/schedule/{telescopeEntryId}

### Description
Retrieves a single schedule entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

### Method
GET

### Endpoint
/telescope-api/schedule/{telescopeEntryId}

### Parameters
#### Path Parameters
- **telescopeEntryId** (string) - Required - The UUID or short hex prefix of the entry.

### Request Example
```bash
curl -X GET "$APP_URL/telescope/telescope-api/schedule/$ENTRY_ID" \
     -H "Accept: application/json" -b "$COOKIE_JAR"
```

### Response
#### Success Response (200)
- **entry** (object) - The schedule entry details.

#### Response Example
```json
{
  "entry": {}
}
```
```

--------------------------------

### GET /telescope-api/commands/{telescopeEntryId}

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Retrieves a single command entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

```APIDOC
## [GET] /telescope-api/commands/{telescopeEntryId}

### Description
Retrieves a single command entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

### Method
GET

### Endpoint
/telescope-api/commands/{telescopeEntryId}

### Parameters
#### Path Parameters
- **telescopeEntryId** (string) - Required - The UUID or short hex prefix of the entry.

### Request Example
```bash
curl -X GET "$APP_URL/telescope/telescope-api/commands/$ENTRY_ID" \
     -H "Accept: application/json" -b "$COOKIE_JAR"
```

### Response
#### Success Response (200)
- **entry** (object) - The command entry details.

#### Response Example
```json
{
  "entry": {}
}
```
```

--------------------------------

### GET /telescope-api/views/{telescopeEntryId}

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Retrieves a single view entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

```APIDOC
## [GET] /telescope-api/views/{telescopeEntryId}

### Description
Retrieves a single view entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

### Method
GET

### Endpoint
/telescope-api/views/{telescopeEntryId}

### Parameters
#### Path Parameters
- **telescopeEntryId** (string) - Required - The UUID or short hex prefix of the entry.

### Request Example
```bash
curl -X GET "$APP_URL/telescope/telescope-api/views/$ENTRY_ID" \
     -H "Accept: application/json" -b "$COOKIE_JAR"
```

### Response
#### Success Response (200)
- **entry** (object) - The view entry details.

#### Response Example
```json
{
  "entry": {}
}
```
```

--------------------------------

### store(EntriesRepository $storage) method signature

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/telescope.md

Flushes the queues to storage. Returns immediately if both queues are empty, runs inside withoutRecording(), and applies filter callbacks. Dispatches ProcessPendingUpdates unless VAPOR_SSM_PATH is set, and reports any Throwable via the exception handler without bubbling up.

```php
public static function store(EntriesRepository $storage)
```

--------------------------------

### GET /telescope-api/requests/{telescopeEntryId}

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Retrieves a single request entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

```APIDOC
## [GET] /telescope-api/requests/{telescopeEntryId}

### Description
Retrieves a single request entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

### Method
GET

### Endpoint
/telescope-api/requests/{telescopeEntryId}

### Parameters
#### Path Parameters
- **telescopeEntryId** (string) - Required - The UUID or short hex prefix of the entry.

### Request Example
```bash
curl -X GET "$APP_URL/telescope/telescope-api/requests/$ENTRY_ID" \
     -H "Accept: application/json" -b "$COOKIE_JAR"
```

### Response
#### Success Response (200)
- **entry** (object) - The request entry details.

#### Response Example
```json
{
  "entry": {}
}
```
```

--------------------------------

### EntryQueryOptions factories and fluent setters

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/repositories.md

Lists the static factory methods and fluent setters for EntryQueryOptions. fromRequest maps request parameters (batch_id, uuids, before, tag, family_hash, take) and is used by EntryController::index.

```php
public static function fromRequest(Request $request)   // maps batch_id, uuids, before, tag, family_hash, take
public static function forBatchId(?string $batchId)    // new instance limited to a batch
public function batchId(?string $batchId)              // $this
public function uuids(?array $uuids)                   // $this
public function beforeSequence($id)                    // $this
public function tag(?string $tag)                      // $this
public function familyHash(?string $familyHash)        // $this
public function limit(int $limit)                      // $this
```

--------------------------------

### Contextual resolution of constructor dependencies

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/repositories.md

Service provider binds the connection and chunk size from configuration for the repository.

```php
$this->app->when(DatabaseEntriesRepository::class)
    ->needs('$connection')->give(fn () => config('telescope.storage.database.connection'));
$this->app->when(DatabaseEntriesRepository::class)
    ->needs('$chunkSize')->give(fn () => config('telescope.storage.database.chunk'));
```

--------------------------------

### GET /telescope-api/models/{telescopeEntryId}

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Retrieves a single model entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

```APIDOC
## [GET] /telescope-api/models/{telescopeEntryId}

### Description
Retrieves a single model entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

### Method
GET

### Endpoint
/telescope-api/models/{telescopeEntryId}

### Parameters
#### Path Parameters
- **telescopeEntryId** (string) - Required - The UUID or short hex prefix of the entry.

### Request Example
```bash
curl -X GET "$APP_URL/telescope/telescope-api/models/$ENTRY_ID" \
     -H "Accept: application/json" -b "$COOKIE_JAR"
```

### Response
#### Success Response (200)
- **entry** (object) - The model entry details.

#### Response Example
```json
{
  "entry": {}
}
```
```

--------------------------------

### Route group configuration in boot()

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/service-providers.md

Defines the route group for Telescope's HTTP routes, using domain, namespace, prefix, and middleware from config.

```php
Route::group([
    'domain' => config('telescope.domain', null),
    'namespace' => 'Laravel\Telescope\Http\Controllers',
    'prefix' => config('telescope.path'),
    'middleware' => 'telescope',
], function () {
    $this->loadRoutesFrom(__DIR__.'/../routes/web.php');
});
```

--------------------------------

### GET /telescope-api/queries/{telescopeEntryId}

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Retrieves a single query entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

```APIDOC
## [GET] /telescope-api/queries/{telescopeEntryId}

### Description
Retrieves a single query entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

### Method
GET

### Endpoint
/telescope-api/queries/{telescopeEntryId}

### Parameters
#### Path Parameters
- **telescopeEntryId** (string) - Required - The UUID or short hex prefix of the entry.

### Request Example
```bash
curl -X GET "$APP_URL/telescope/telescope-api/queries/$ENTRY_ID" \
     -H "Accept: application/json" -b "$COOKIE_JAR"
```

### Response
#### Success Response (200)
- **entry** (object) - The query entry details.

#### Response Example
```json
{
  "entry": {}
}
```
```

--------------------------------

### GET /telescope-api/cache/{telescopeEntryId}

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Retrieves a single cache entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

```APIDOC
## [GET] /telescope-api/cache/{telescopeEntryId}

### Description
Retrieves a single cache entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

### Method
GET

### Endpoint
/telescope-api/cache/{telescopeEntryId}

### Parameters
#### Path Parameters
- **telescopeEntryId** (string) - Required - The UUID or short hex prefix of the entry.

### Request Example
```bash
curl -X GET "$APP_URL/telescope/telescope-api/cache/$ENTRY_ID" \
     -H "Accept: application/json" -b "$COOKIE_JAR"
```

### Response
#### Success Response (200)
- **entry** (object) - The cache entry details.

#### Response Example
```json
{
  "entry": {}
}
```
```

--------------------------------

### Inspect Telescope entries with jq

Source: https://github.com/laravel/telescope/blob/5.x/resources/boost/skills/telescope-debugging/SKILL.md

Use these jq commands to extract specific details from Telescope JSON output. The first shows the latest exception's class, message, file, and line. The second lists slow queries in the latest request with their file and line. The third groups repeated SQL patterns to identify N+1 candidates. The fourth finds recent 500 responses. The fifth lists failed jobs with their exception messages.

```bash
# Exception class, message, and location for the latest exception
php artisan telescope:show latest:exception --json | jq '.entry.content | {class, message, file, line}'

# Slow queries in the latest request, with the file that ran them
php artisan telescope:show latest:request --json --type=query | jq '.batch[] | select(.content.slow) | {sql: .content.sql, time: .content.time, file: .content.file, line: .content.line}'

# Repeated SQL patterns in a request (N+1 candidates), most repeated first
php artisan telescope:show latest:request --json --type=query | jq '[.batch[].content.sql] | group_by(.) | map({sql: .[0], count: length}) | sort_by(-.count) | .[] | select(.count > 1)'

# Recent 500 responses
php artisan telescope:list request --json --limit=50 | jq '.[] | select(.content.response_status >= 500) | {id, uri: .content.uri, status: .content.response_status}'

# Failed jobs and their exception messages
php artisan telescope:list job --json | jq '.[] | select(.content.status == "failed") | {id, name: .content.name, error: .content.exception.message}'
```

--------------------------------

### GET /telescope-api/gates/{telescopeEntryId}

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Retrieves a single gate entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

```APIDOC
## [GET] /telescope-api/gates/{telescopeEntryId}

### Description
Retrieves a single gate entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

### Method
GET

### Endpoint
/telescope-api/gates/{telescopeEntryId}

### Parameters
#### Path Parameters
- **telescopeEntryId** (string) - Required - The UUID or short hex prefix of the entry.

### Request Example
```bash
curl -X GET "$APP_URL/telescope/telescope-api/gates/$ENTRY_ID" \
     -H "Accept: application/json" -b "$COOKIE_JAR"
```

### Response
#### Success Response (200)
- **entry** (object) - The gate entry details.

#### Response Example
```json
{
  "entry": {}
}
```
```

--------------------------------

### Telescope::catch($e, $tags = [])

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/configuration.md

Logs an exception through the recording pipeline. Accepts an exception and optional tags.

```APIDOC
## Telescope::catch($e, $tags = [])

### Description
Logs an exception through the recording pipeline. Accepts an exception and optional tags.

### Method
Static method on `Laravel\Telescope\Telescope`

### Parameters
- **$e** (Exception) - Required - The exception to log.
- **$tags** (array) - Optional - Tags to associate with the exception.

```

--------------------------------

### GET /telescope-api/events/{telescopeEntryId}

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Retrieves a single event entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

```APIDOC
## [GET] /telescope-api/events/{telescopeEntryId}

### Description
Retrieves a single event entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

### Method
GET

### Endpoint
/telescope-api/events/{telescopeEntryId}

### Parameters
#### Path Parameters
- **telescopeEntryId** (string) - Required - The UUID or short hex prefix of the entry.

### Request Example
```bash
curl -X GET "$APP_URL/telescope/telescope-api/events/$ENTRY_ID" \
     -H "Accept: application/json" -b "$COOKIE_JAR"
```

### Response
#### Success Response (200)
- **entry** (object) - The event entry details.

#### Response Example
```json
{
  "entry": {}
}
```
```

--------------------------------

### GET /telescope-api/jobs/{telescopeEntryId}

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Retrieves a single job entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

```APIDOC
## [GET] /telescope-api/jobs/{telescopeEntryId}

### Description
Retrieves a single job entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

### Method
GET

### Endpoint
/telescope-api/jobs/{telescopeEntryId}

### Parameters
#### Path Parameters
- **telescopeEntryId** (string) - Required - The UUID or short hex prefix of the entry.

### Request Example
```bash
curl -X GET "$APP_URL/telescope/telescope-api/jobs/$ENTRY_ID" \
     -H "Accept: application/json" -b "$COOKIE_JAR"
```

### Response
#### Success Response (200)
- **entry** (object) - The job entry details.

#### Response Example
```json
{
  "entry": {}
}
```
```

--------------------------------

### Dispatch behavior inside Telescope::store()

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/jobs.md

Shows how Telescope::store() dispatches the job with configuration-based connection, queue, and delay. Skips on Vapor.

```php
// Inside Telescope::store(), unless running on Vapor (VAPOR_SSM_PATH):
$delay = config('telescope.queue.delay');

$updateResult->whenNotEmpty(fn ($pendingUpdates) => rescue(fn () => ProcessPendingUpdates::dispatch(
    $pendingUpdates,
)->onConnection(config('telescope.queue.connection'))
  ->onQueue(config('telescope.queue.queue'))
  ->delay(is_numeric($delay) && $delay > 0 ? now()->addSeconds($delay) : null)));
```

--------------------------------

### GET /telescope-api/notifications/{telescopeEntryId}

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Retrieves a single notification entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

```APIDOC
## [GET] /telescope-api/notifications/{telescopeEntryId}

### Description
Retrieves a single notification entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

### Method
GET

### Endpoint
/telescope-api/notifications/{telescopeEntryId}

### Parameters
#### Path Parameters
- **telescopeEntryId** (string) - Required - The UUID or short hex prefix of the entry.

### Request Example
```bash
curl -X GET "$APP_URL/telescope/telescope-api/notifications/$ENTRY_ID" \
     -H "Accept: application/json" -b "$COOKIE_JAR"
```

### Response
#### Success Response (200)
- **entry** (object) - The notification entry details.

#### Response Example
```json
{
  "entry": {}
}
```
```

--------------------------------

### IncomingEntry constructor

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/incoming-entry.md

Merges hostname into content and sets recordedAt to now. UUID defaults to an ordered UUID string.

```php
public function __construct(array $content, $uuid = null)
```

--------------------------------

### GET /telescope-api/logs/{telescopeEntryId}

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Retrieves a single log entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

```APIDOC
## [GET] /telescope-api/logs/{telescopeEntryId}

### Description
Retrieves a single log entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

### Method
GET

### Endpoint
/telescope-api/logs/{telescopeEntryId}

### Parameters
#### Path Parameters
- **telescopeEntryId** (string) - Required - The UUID or short hex prefix of the entry.

### Request Example
```bash
curl -X GET "$APP_URL/telescope/telescope-api/logs/$ENTRY_ID" \
     -H "Accept: application/json" -b "$COOKIE_JAR"
```

### Response
#### Success Response (200)
- **entry** (object) - The log entry details.

#### Response Example
```json
{
  "entry": {}
}
```
```

--------------------------------

### find method

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/repositories.md

Finds an entry by ID, supporting short hex prefixes. Throws ModelNotFoundException if not found.

```php
public function find($id): EntryResult
```

--------------------------------

### GET /telescope-api/exceptions/{telescopeEntryId}

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Retrieves a single exception entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

```APIDOC
## [GET] /telescope-api/exceptions/{telescopeEntryId}

### Description
Retrieves a single exception entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

### Method
GET

### Endpoint
/telescope-api/exceptions/{telescopeEntryId}

### Parameters
#### Path Parameters
- **telescopeEntryId** (string) - Required - The UUID or short hex prefix of the entry.

### Request Example
```bash
curl -X GET "$APP_URL/telescope/telescope-api/exceptions/$ENTRY_ID" \
     -H "Accept: application/json" -b "$COOKIE_JAR"
```

### Response
#### Success Response (200)
- **entry** (object) - The exception entry details.

#### Response Example
```json
{
  "entry": {}
}
```
```

--------------------------------

### scriptVariables() method signature

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/telescope.md

Returns an array with path, timezone, and recording status. The recording value is the negation of cache('telescope:pause-recording').

```php
public static function scriptVariables()
```

--------------------------------

### GET /telescope-api/mail/{telescopeEntryId}

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Retrieves a single mail entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

```APIDOC
## [GET] /telescope-api/mail/{telescopeEntryId}

### Description
Retrieves a single mail entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

### Method
GET

### Endpoint
/telescope-api/mail/{telescopeEntryId}

### Parameters
#### Path Parameters
- **telescopeEntryId** (string) - Required - The UUID or short hex prefix of the entry.

### Request Example
```bash
curl -X GET "$APP_URL/telescope/telescope-api/mail/$ENTRY_ID" \
     -H "Accept: application/json" -b "$COOKIE_JAR"
```

### Response
#### Success Response (200)
- **entry** (object) - The mail entry details.

#### Response Example
```json
{
  "entry": {}
}
```
```

--------------------------------

### Constructor

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/incoming-entry.md

Stores exception and calls parent constructor.

```php
public function __construct($exception, array $content)
```

--------------------------------

### auth($callback)

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/telescope.md

Registers the authentication callback used by the Authorize middleware. Returns static.

```APIDOC
## auth($callback)

### Description
Registers the authentication callback used by the `Authorize` middleware. Returns `static`.

### Method
`auth`

### Parameters
- **$callback** (callable) - Required - The authentication callback to register.

### Return Value
- `static` - Returns the current class instance for chaining.

### Example
```php
Telescope::auth(function ($request) {
    return $request->user()->isAdmin();
});
```
```

--------------------------------

### Monitoring methods

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/repositories.md

Methods to load, check, and modify monitored tags.

```php
public function loadMonitoredTags()                        // void — caches $this->monitoredTags, swallows Throwable
public function isMonitoring(array $tags)                  // bool
public function monitoring()                               // array — pluck('tag') from telescope_monitoring
public function monitor(array $tags)                       // void — inserts tags not already monitored
public function stopMonitoring(array $tags)                // void — deletes whereIn('tag', $tags)
```

--------------------------------

### GET /telescope-api/mail/{telescopeEntryId}/preview

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Retrieves the raw HTML body of a mail entry for preview. The response is the HTML content rendered as a string.

```APIDOC
## [GET] /telescope-api/mail/{telescopeEntryId}/preview

### Description
Retrieves the raw HTML body of a mail entry for preview. The response is the HTML content rendered as a string.

### Method
GET

### Endpoint
/telescope-api/mail/{telescopeEntryId}/preview

### Parameters
#### Path Parameters
- **telescopeEntryId** (string) - Required - The ID of the mail entry.

### Response
#### Success Response (200)
- **body** (string) - Raw HTML body of the mail (`content['html']`), rendered as a string.

#### Response Example
[Raw HTML string]
```

--------------------------------

### GET /telescope-api/client-requests/{telescopeEntryId}

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Retrieves a single client request entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

```APIDOC
## [GET] /telescope-api/client-requests/{telescopeEntryId}

### Description
Retrieves a single client request entry by its telescope entry ID. The ID can be a UUID or a short hex prefix.

### Method
GET

### Endpoint
/telescope-api/client-requests/{telescopeEntryId}

### Parameters
#### Path Parameters
- **telescopeEntryId** (string) - Required - The UUID or short hex prefix of the entry.

### Request Example
```bash
curl -X GET "$APP_URL/telescope/telescope-api/client-requests/$ENTRY_ID" \
     -H "Accept: application/json" -b "$COOKIE_JAR"
```

### Response
#### Success Response (200)
- **entry** (object) - The client request entry details.

#### Response Example
```json
{
  "entry": {}
}
```
```

--------------------------------

### clear method

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/repositories.md

Deletes all entries and monitoring data.

```php
public function clear()   // void
```

--------------------------------

### Telescope::night()

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/configuration.md

Enables dark theme for the Telescope dashboard.

```APIDOC
## Telescope::night()

### Description
Enables dark theme for the Telescope dashboard.

### Method
Static method on `Laravel\Telescope\Telescope`

### Parameters
None.

```

--------------------------------

### css()

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/telescope.md

Loads the dashboard CSS files and returns them as an HtmlString. Throws exceptions if files are unreadable.

```APIDOC
## css()

### Description
Loads `dist/app.css` plus `dist/styles.css` (or `styles-dark.css` when the dark theme is active) and returns them as a single `Illuminate\Support\HtmlString` with two `<style>` tags (including the CSP nonce attribute when set).

### Method
PHP static method

### Signature
```php
public static function css()
```

### Returns
- `Illuminate\Support\HtmlString` - The combined CSS as an HtmlString.

### Throws
- `RuntimeException` - When `dist/app.css` is unreadable.
- `RuntimeException` - When the theme stylesheet is unreadable.

### Example
```php
{{ \Laravel\Telescope\Telescope::css() }}
```
```

--------------------------------

### GET /telescope-api/mail/{telescopeEntryId}/download

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Downloads the raw email content as an .eml file. The response includes headers for content type and attachment disposition.

```APIDOC
## [GET] /telescope-api/mail/{telescopeEntryId}/download

### Description
Downloads the raw email content as an .eml file. The response includes headers for content type and attachment disposition.

### Method
GET

### Endpoint
/telescope-api/mail/{telescopeEntryId}/download

### Parameters
#### Path Parameters
- **telescopeEntryId** (string) - Required - The ID of the mail entry.

### Response
#### Success Response (200)
- **body** (string) - `content['raw']` with headers `Content-Type: message/rfc822` and `Content-Disposition: attachment; filename="mail-{id}.eml"`.

#### Response Example
[Raw email content]
```

--------------------------------

### assignEntryPointFromBatch() method

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/api-reference/incoming-entry.md

Finds first request/job/command entry in batch and merges entry point details into content.

```php
public function assignEntryPointFromBatch(array $batch)   // returns void
```

--------------------------------

### GET /{view?}

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Returns the SPA shell for the Telescope dashboard. This route serves the main layout view that loads Telescope's CSS and JavaScript assets and initializes the client-side application.

```APIDOC
## [GET] /{view?}

### Description
Returns the SPA shell for the Telescope dashboard. This route serves the main layout view that loads Telescope's CSS and JavaScript assets and initializes the client-side application.

### Method
GET

### Endpoint
`/{view?}` (where `view = (.*)`)

### Parameters
#### Path Parameters
- **view** (string) - Optional - The view name to load (any string).

### Response
#### Success Response (200)
- Returns the `view('telescope::layout')` SPA shell, which emits `Telescope::css()` / `Telescope::js()` and sets `window.Telescope = {path, timezone, recording}`.

#### Response Example
```html
<!-- HTML content of the SPA shell -->
```

### Error Handling
- **403**: `Telescope::check($request)` is false (from `Authorize`).
- **404**: `DatabaseEntriesRepository::find()` — no matching entry (Eloquent `ModelNotFoundException`), e.g. for show/preview/download routes.
- **500**: General framework errors (e.g. a throwing mail body during preview).
```

--------------------------------

### GET /telescope-api/batches/{telescopeEntryId}

Source: https://github.com/laravel/telescope/blob/5.x/_autodocs/endpoints.md

Retrieves a single batch entry by its telescope entry ID. The ID can be a UUID or a short hex prefix. Also refreshes the batch from the BatchRepository via an EntryUpdate.

```APIDOC
## [GET] /telescope-api/batches/{telescopeEntryId}

### Description
Retrieves a single batch entry by its telescope entry ID. The ID can be a UUID or a short hex prefix. Also refreshes the batch from the BatchRepository via an EntryUpdate.

### Method
GET

### Endpoint
/telescope-api/batches/{telescopeEntryId}

### Parameters
#### Path Parameters
- **telescopeEntryId** (string) - Required - The UUID or short hex prefix of the entry.

### Request Example
```bash
curl -X GET "$APP_URL/telescope/telescope-api/batches/$ENTRY_ID" \
     -H "Accept: application/json" -b "$COOKIE_JAR"
```

### Response
#### Success Response (200)
- **entry** (object) - The batch entry details.

#### Response Example
```json
{
  "entry": {}
}
```
```
Tokens:
Raw