Log Viewer

https://github.com/opcodesio/log-viewer
Admin
Log Viewer is an easy-to-use, fast, and beautiful tool for Laravel applications that allows users to...
Tokens:115,417
Snippets:823
Trust Score:5.7
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Usage example: retrieving and iterating hosts

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/host.md

Shows how to get all hosts via LogViewer::getHosts() and iterate over them, printing identifier, name, and remote/local status. Also demonstrates getting only remote hosts.

```php
use Opcodes\LogViewer\Facades\LogViewer;

$hosts = LogViewer::getHosts();
foreach ($hosts as $host) {
    echo $host->identifier.' => '.$host->name.($host->isRemote() ? ' (remote)' : ' (local)').PHP_EOL;
}

$remote = LogViewer::getHosts()->remote();
```

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

### Usage example: get folder and download

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-folder.md

Shows how to retrieve a LogFolder by identifier, print its clean path and file names, and stream a ZIP download in a controller.

```php
use Opcodes\LogViewer\Facades\LogViewer;

$folder = LogViewer::getFolder($folderIdentifier);

echo $folder->cleanPath();                 // "root" or "root/2024-01"
foreach ($folder->files() as $file) {
    echo $file->name.PHP_EOL;
}

// In a controller: stream a zip of the folder
return $folder->download();
```

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

### Install Log Viewer via Composer

Source: https://github.com/opcodesio/log-viewer/blob/main/README.md

Run this command to install the opcodesio/log-viewer package using Composer. Requires PHP 8.0+ and Laravel 8+.

```bash
composer require opcodesio/log-viewer
```

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

### Install PHP dependencies with Composer

Source: https://github.com/opcodesio/log-viewer/blob/main/CONTRIBUTING.md

Install all PHP dependencies using Composer.

```shell
composer install
```

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

### Usage example: latest file and cross-file search

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-file-collection.md

Demonstrates using sortByLatestFirst() to get the newest file, sortByEarliestFirst()->logs() to get oldest logs, and logs()->search() to search across all files with pagination.

```php
use Opcodes\LogViewer\Facades\LogViewer;

// The most recently modified file, and the oldest entry across all files
$newestFile = LogViewer::getFiles()->sortByLatestFirst()->first();
$oldestLogs = LogViewer::getFiles()->sortByEarliestFirst()->logs()->limit(50)->get();

// Search and paginate across every log file at once
$results = LogViewer::getFiles()->logs()->search('exception')->paginate(25);
```

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

### Benchmark class method signatures

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/utils.md

Lists the static methods for the Benchmark utility, which provides a named stopwatch-style micro-benchmarker with static state. Use `time`/`start` to begin timing, `endTime`/`end` to get duration, and `results` to retrieve summary data.

```php
class Benchmark
{
    public static array $tests = [];

    public static function time(string $name): void
    public static function start(string $name): void                       // alias of time
    public static function endTime(string $name): float                    // returns duration in seconds
    public static function end(string $name): float                        // alias of endTime
    public static function getTotal(string $name): float
    public static function getAverage(string $name): float
    public static function dd(?string $name = null): void                  // dump + exit
    public static function dump(?string $name = null): void
    public static function results(?string $name = null): array
}
```

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

### Usage examples for enums and constants

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/enums.md

Shows how to use SortingMethod, SortingOrder, Direction, and Theme in practice, including sorting folders, reading logs, and overriding config.

```php
use Opcodes\LogViewer\Direction;
use Opcodes\LogViewer\Enums\SortingMethod;
use Opcodes\LogViewer\Enums\SortingOrder;
use Opcodes\LogViewer\Enums\Theme;
use Opcodes\LogViewer\Facades\LogViewer;

// Sort folders newest-first (the UI default)
$folders = LogViewer::getFilesGroupedByFolder();
$folders->sortUsing(SortingMethod::ModifiedTime, SortingOrder::Descending);

// Read across all files, newest entries first
$logs = LogViewer::getFiles()->logs()
    ->setDirection(Direction::Backward)
    ->limit(25)
    ->get();

// Theme is a string constant usable in config overrides
config(['log-viewer.defaults.theme' => Theme::Dark]);
```

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

### Publish Log Viewer Front-end Assets

Source: https://github.com/opcodesio/log-viewer/blob/main/README.md

Run this Artisan command after installation to publish the front-end assets needed for Log Viewer to work.

```bash
php artisan log-viewer:publish
```

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

### Benchmark::start

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/utils.md

Alias of `time`. Starts a named benchmark timer.

```APIDOC
## Benchmark::start

### Description
Alias of `time`. Starts a named benchmark timer.

### Method
`public static function start(string $name): void`

### Parameters
- **$name** (string) - Required - The name of the benchmark.

### Returns
- **void**

### Example
```php
use Opcodes\LogViewer\Utils\Benchmark;

Benchmark::start('my_benchmark');
```
```

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

### Usage examples for log-viewer:publish and log-viewer:generate-dummy-logs

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/console-commands.md

Shows how to run the two console commands: publishing assets (deprecated) and generating dummy logs with a specified channel.

```bash
# Publish the (now deprecated) front-end assets
php artisan log-viewer:publish
php artisan log-viewer:publish --watch

# Create 100 sample entries on the "stderr" channel for previewing
php artisan log-viewer:generate-dummy-logs 100 --channel=stderr
```

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

### Usage example: sorting files by modified time

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-file-collection.md

Shows how to get all discoverable log files and sort them newest-first using sortUsing with ModifiedTime and Descending, then iterate and print file names and sizes.

```php
use Opcodes\LogViewer\Facades\LogViewer;
use Opcodes\LogViewer\Enums\SortingMethod;
use Opcodes\LogViewer\Enums\SortingOrder;

// All discoverable log files, newest-first (default UI ordering)
$files = LogViewer::getFiles();
$files->sortUsing(SortingMethod::ModifiedTime, SortingOrder::Descending);

foreach ($files as $file) {
    echo $file->name.' ('.number_format($file->sizeInMB(), 2).' MB)'.PHP_EOL;
}
```

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

### LogViewer::getFile and File::index usage

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-index.md

Shows how to get a file and its index, then count entries and list levels.

```APIDOC
## LogViewer::getFile and File::index usage

### Description
Shows how to get a file and its index, then count entries and list levels.

### Usage Example
```php
use Opcodes\LogViewer\Facades\LogViewer;

$file = LogViewer::getFile($identifier);
$index = $file->index();                 // default index for this file

// Count entries and list levels
echo $index->count();
$index->getLevelCounts()->each(fn ($c, $level) => print "$level: $c\n");
```
```

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

### Benchmark::time

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/utils.md

Starts a named benchmark timer.

```APIDOC
## Benchmark::time

### Description
Starts a named benchmark timer.

### Method
`public static function time(string $name): void`

### Parameters
- **$name** (string) - Required - The name of the benchmark.

### Returns
- **void**

### Example
```php
use Opcodes\LogViewer\Utils\Benchmark;

Benchmark::time('my_benchmark');
```
```

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

### version()

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-viewer-service.md

Returns the installed version of the log-viewer package, or 'unit-tests' when running unit tests.

```APIDOC
## version()

### Description
Returns the installed version of the log-viewer package, or 'unit-tests' when running unit tests.

### Method
version

### Signature
public function version(): string

### Parameters
None

### Return Value
string - The version string. Returns `'unit-tests'` when running unit tests, otherwise the installed Composer version, falling back to `composer.json` version or `'dev-main'`.
```

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

### Install Node dependencies with npm

Source: https://github.com/opcodesio/log-viewer/blob/main/CONTRIBUTING.md

Install Node dependencies after Composer installation.

```shell
npm install
```

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

### get() and getFlatIndex() method signatures

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-index.md

get() returns a nested array [timestamp][level][index] => filePosition, honoring limit, skip, date filters (filterFrom/filterTo), and level selection. getFlatIndex() returns a flat array [index] => filePosition.

```php
public function get(?int $limit = null): array
public function getFlatIndex(?int $limit = null): array
```

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

### Usage example: sorting folders and files

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-folder-collection.md

Shows how to retrieve folders grouped by folder, sort them by modified time descending (as in FoldersController@index), and then sort folders and their files newest-first. Iterates and prints folder paths and file names.

```php
use Opcodes\LogViewer\Facades\LogViewer;
use Opcodes\LogViewer\Enums\SortingMethod;
use Opcodes\LogViewer\Enums\SortingOrder;

// Exactly what FoldersController@index does (default config)
$folders = LogViewer::getFilesGroupedByFolder();
$folders->sortUsing(SortingMethod::ModifiedTime, SortingOrder::Descending);

// Folders and their files both newest-first
$folders->sortByLatestFirstIncludingFiles();

foreach ($folders as $folder) {
    echo $folder->cleanPath().' — '.$folder->files()->count().' file(s)'.PHP_EOL;
    foreach ($folder->files() as $file) {
        echo '  • '.$file->name.PHP_EOL;
    }
}
```

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

### Usage example: accessing log file properties and iterating logs

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-file.md

Shows how to retrieve a log file by identifier, access its name, type, and formatted size, and iterate over the latest 10 logs in reverse order.

```php
use Opcodes\LogViewer\Facades\LogViewer;

$file = LogViewer::getFile($identifier);

echo $file->name;                       // "laravel.log"
echo $file->type()->name();             // "Laravel"
echo $file->sizeFormatted();            // "12.50 MB"

foreach ($file->logs()->reverse()->limit(10)->get() as $log) {
    echo $log->message.PHP_EOL;
}
```

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

### Usage example: registering a custom log parser

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-type-registrar.md

Shows how to register a custom log parser using LogViewer::extend(). The custom class must extend Opcodes\LogViewer\Logs\Log.

```php
use Opcodes\LogViewer\Facades\LogViewer;

// Register a custom log parser (extends Opcodes\LogViewer\Logs\Log)
LogViewer::extend('my_app', App\Support\MyAppLog::class);

// Later, files detected as 'my_app' are parsed with MyAppLog
```

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

### Usage example: overriding hosts programmatically

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/host.md

Shows how to override hosts using LogViewer::resolveHostsUsing() with a closure that returns a config array, including local and staging hosts with authentication.

```php
use Opcodes\LogViewer\Facades\LogViewer;
use Opcodes\LogViewer\Host;

// Override hosts programmatically (e.g. from a service provider)
LogViewer::resolveHostsUsing(function ($hostsFromConfig) {
    return [
        'local' => ['name' => 'Local'],
        'staging' => [
            'name' => 'Staging',
            'host' => 'https://staging.example.com/log-viewer',
            'auth' => ['username' => 'u', 'password' => 'p'],
        ],
    ];
});
```

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

### Usage example: bytesForHumans and shortMd5

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/utils.md

Shows how to use Utils::bytesForHumans to format a byte count and Utils::shortMd5 to generate a stable short identifier from a file path.

```php
use Opcodes\LogViewer\Utils\Utils;
use Opcodes\LogViewer\Utils\Benchmark;

echo Utils::bytesForHumans(1572864);        // "1.50 MB"
$id = Utils::shortMd5('/var/log/laravel.log'); // stable short id
```

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

### Count entries and list levels

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-index.md

Shows how to get a file's default index, count its entries, and print level counts. Uses the LogViewer facade to retrieve the file by identifier.

```php
use Opcodes\LogViewer\Facades\LogViewer;

$file = LogViewer::getFile($identifier);
$index = $file->index();                 // default index for this file

// Count entries and list levels
echo $index->count();
$index->getLevelCounts()->each(fn ($c, $level) => print "$level: $c\n");
```

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

### Configure remote hosts in config/log-viewer.php

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/configuration.md

Defines the 'hosts' array with local, staging, and production hosts. Each host supports keys: name (required), host (null for local), headers, auth (Bearer, Basic, or Digest), and verify_server_certificate (default true). The staging and production examples show HTTP Basic and Bearer authentication respectively.

```php
'hosts' => [
    'local' => [
        'name' => ucfirst(env('APP_ENV', 'local')),
    ],
    'staging' => [
        'name' => 'Staging',
        'host' => 'https://staging.example.com/log-viewer',
        'auth' => ['username' => 'u', 'password' => 'p'],       // HTTP Basic
        'verify_server_certificate' => true,
    ],
    'production' => [
        'name' => 'Production',
        'host' => 'https://example.com/log-viewer',
        'auth' => ['token' => env('LOG_VIEWER_PRODUCTION_TOKEN')], // Bearer
        'headers' => ['X-Foo' => 'Bar'],
        'verify_server_certificate' => true,
    ],
],
```

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

### Fetch and iterate over log entries using LogViewer facade

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/logs.md

Use the LogViewer facade to get a log file by identifier and iterate over the first five logs, printing each log's timestamp, level name, and message.

```php
use Opcodes\LogViewer\Facades\LogViewer;

$file = LogViewer::getFile($identifier);

foreach ($file->logs()->limit(5)->get() as $log) {
    $level = $log->getLevel();
    echo sprintf('[%s] %s: %s'.PHP_EOL,
        $log->datetime?->toDateTimeString(),
        $level->getName(),
        $log->message
    );
}
```

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

### Usage example: retrieving a parser class via the registrar

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-type-registrar.md

Shows how to resolve the LogTypeRegistrar from the container and use getClass() to obtain the parser class for a given log type.

```php
use Opcodes\LogViewer\LogTypeRegistrar;

$registrar = app(LogTypeRegistrar::class);
$class = $registrar->getClass(LogType::POSTGRES);   // Opcodes\LogViewer\Logs\PostgresLog
```

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

### GET /{view?}

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/endpoints.md

Serves the Log Viewer SPA. This route is a catch-all that returns the Blade layout with the necessary script variables. It returns 404 when API-only mode is enabled.

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

### Description
Serves the Log Viewer SPA. This route is a catch-all that returns the Blade layout with the necessary script variables. It returns 404 when API-only mode is enabled.

### Method
GET

### Endpoint
/{view?}

### Parameters
#### Path Parameters
- **view** (string) - Optional - The view path (matches any string, SPA catch-all).

### Response
#### Success Response (200)
- Returns the Blade layout rendered with the following variables: `assetsPublished`, `logViewerScriptVariables` (headers, assets_outdated, version, app_name, path, back_to_system_url, back_to_system_label, files_sort_by_time, max_log_size_formatted, show_support_link, supports_hosts, hosts, per_page_options, defaults, root_folder_prefix).

#### Error Response (404)
- Returned when `log-viewer.api_only` is `true`.

### Notes
- Route name: `log-viewer.index`
- Controller: `IndexController::__invoke`
- Middleware: `web`, `AuthorizeLogViewer`
- Route group prefix: `{log-viewer.route_path}` (e.g. `/log-viewer`)
```

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

### Usage example: searching with regex and deleting a file

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-file.md

Shows how to search logs with a regular expression, catching InvalidRegularExpression for malformed patterns, and how to delete the file, which triggers LogFileDeleted and clears its cache.

```php
use Opcodes\LogViewer\Exceptions\InvalidRegularExpression;

$file = LogViewer::getFile($identifier);

try {
    $results = $file->search('foo(')->get();
} catch (InvalidRegularExpression $e) {
    // malformed regex — show $e->getMessage() to the user
}

// Delete the file (triggers LogFileDeleted and clears its cache)
$file->delete();
```

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

### GenerateDummyLogsCommand class for log-viewer:generate-dummy-logs

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/console-commands.md

Defines the log-viewer:generate-dummy-logs command with an amount argument and optional --channel option. The handle() method is omitted in the source; it refuses to run in production, loops the given amount, and logs random severities with example messages.

```php
<?php

namespace Opcodes\LogViewer\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\Log;

class GenerateDummyLogsCommand extends Command
{
    protected $signature = 'log-viewer:generate-dummy-logs {amount} {--channel=single}';
    protected $description = 'Generate dummy log entries to preview in the Log Viewer';
    protected array $severities = ['info', 'debug', 'warning', 'error'];
    // ('notice', 'alert', 'critical', 'emergency' are present but commented out)
}
```

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

### GET /folders/{folderIdentifier}/download/request

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/endpoints.md

Requests a temporary signed URL for downloading a folder. Returns a JSON object with a URL that is valid for 30 minutes. Returns 404 if the folder is not found.

```APIDOC
## GET /folders/{folderIdentifier}/download/request

### Description
Requests a temporary signed URL for downloading a folder. Returns a JSON object with a URL that is valid for 30 minutes. Returns 404 if the folder is not found.

### Method
GET

### Endpoint
/folders/{folderIdentifier}/download/request

### Parameters
#### Path Parameters
- **folderIdentifier** (string) - Required - The identifier of the folder to download.

### Response
#### Success Response (200)
- **url** (string) - The temporary signed URL for downloading the folder.

#### Response Example
{
  "url": "https://example.com/signed-url"
}

#### Error Response (404)
- Folder not found.
```

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

### Enable API-only mode with authentication and middleware

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/configuration.md

Example configuration for config/log-viewer.php to enable API-only mode behind a named route. Sets api_only to true, defines a custom route path, requires authentication in production, and applies web, auth, and custom middleware.

```php
// config/log-viewer.php — enable API-only mode behind a named route
return [
    'enabled' => env('LOG_VIEWER_ENABLED', true),
    'api_only' => true,
    'route_path' => 'admin/logs',
    'require_auth_in_production' => true,
    'middleware' => ['web', 'auth', AuthorizeLogViewer::class],
];
```

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

### download method

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-folder.md

Creates a ZIP in the temp directory containing files that pass the downloadLogFile Gate, then streams it. Throws exceptions if the Zip extension is missing, if opening the archive fails, or if saving fails.

```php
public function download(): BinaryFileResponse
```

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

### Enumerate and fetch log files with LogViewer facade

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-viewer-service.md

Shows how to use LogViewer::getFilesGroupedByFolder() to list all discoverable log files grouped by folder, and LogViewer::getFile($identifier) to fetch a specific file and read its log entries with a limit.

```php
use Opcodes\LogViewer\Facades\LogViewer;

// Enumerate all discoverable log files, grouped by folder
$folders = LogViewer::getFilesGroupedByFolder();

foreach ($folders as $folder) {
    foreach ($folder->files() as $file) {
        echo $file->name.' ('.$file->type()->name().')';
    }
}

// Fetch one file by its identifier and read its log entries
$file = LogViewer::getFile($identifier);
$logs = $file->logs()->reverse()->limit(50)->get();
```

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

### supportsHostsFeature()

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-viewer-service.md

Checks if the hosts feature is supported (GuzzleHttp installed).

```APIDOC
## supportsHostsFeature()

### Description
Returns true when GuzzleHttp\Client exists, indicating the hosts feature is available.

### Method
GET

### Endpoint
N/A (PHP method)

### Parameters
None

### Response
#### Success Response
- **supported** (boolean) - True if Guzzle is installed.

#### Response Example
```
true
```
```

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

### Fluent querying with search, levels, direction, and limit

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/readers.md

Demonstrates fluent querying on a single log file: search for 'exception', filter to ERROR and CRITICAL levels, set direction to Backward, limit to 100, and iterate over results.

```php
use Opcodes\LogViewer\Facades\LogViewer;
use Opcodes\LogViewer\Direction;

$reader = LogViewer::getFile($identifier)->logs();

// Fluent querying
$logs = $reader
    ->search('exception')
    ->only(['ERROR', 'CRITICAL'])
    ->setDirection(Direction::Backward)
    ->limit(100)
    ->get();

foreach ($logs as $log) {
    echo $log->message.PHP_EOL;
}
```

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

### maxLogSize() / setMaxLogSize(int $bytes)

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-viewer-service.md

Gets or sets the maximum log entry size to display.

```APIDOC
## maxLogSize() / setMaxLogSize(int $bytes)

### Description
Returns the maximum number of bytes of a log entry that the UI renders. setMaxLogSize sets it, resetting to default if <= 0.

### Method
GET/POST

### Endpoint
N/A (PHP methods)

### Parameters
#### Request Body (for setMaxLogSize)
- **bytes** (int) - Required - The maximum size in bytes.

### Response
#### Success Response
- **maxLogSize** (int) - The current maximum size.

#### Response Example
```
131072
```
```

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

### Host::fromConfig() method signature

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/host.md

Static method that builds a Host from a config entry. When identifier is an integer, it uses Utils::shortMd5 of the host and falls back to the host for the name.

```php
public static function fromConfig(string|int $identifier, array $config = []): self
```

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

### GET /files/{fileIdentifier}/download

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/endpoints.md

Downloads a raw file. Requires a valid signature and expires query pair produced by the request endpoint.

```APIDOC
## GET /files/{fileIdentifier}/download

### Description
Downloads a raw file. Requires a valid signature and expires query pair produced by the request endpoint.

### Method
GET

### Endpoint
/files/{fileIdentifier}/download

### Parameters
#### Path Parameters
- **fileIdentifier** (string) - Required - The identifier of the file to download.

#### Query Parameters
- **signature** (string) - Required - The signature generated by the request endpoint.
- **expires** (integer) - Required - The expiration timestamp of the signature.

### Response
#### Success Response (200)
- The raw file content.

#### Error Response (403)
- Invalid or expired signature.
```

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

### HorizonStatusLevel

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-levels.md

Represents Horizon status levels. Provides a constructor, static from/caseValues methods, and methods to get the level name and CSS class.

```APIDOC
## HorizonStatusLevel

### Description
Represents Horizon status levels. Provides a constructor, static from/caseValues methods, and methods to get the level name and CSS class.

### Constructor
`__construct(string $value)` - Creates an instance with a given value.

### Static Methods
- `from(?string $value = null): LevelInterface` - Creates an instance from a value.
- `caseValues(): array` - Returns an array of case values: ['Processing', 'Running', 'Processed', 'Done', 'Failed', 'Fail'].

### Instance Methods
- `getName(): string` - Returns the level name.
- `getClass(): LevelClass` - Maps the level to a CSS class: processing/running → info, processed/done → success, failed/fail → danger, else none.
```

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

### downloadUrl() / download() methods

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-file.md

Returns the download URL or a BinaryFileResponse for downloading the file.

```php
public function downloadUrl(): string                          // route('log-viewer.files.download', $this->identifier)
```

```php
public function download(): BinaryFileResponse                 // response()->download($this->path)
```

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

### getLevelCounts() method signature

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-index.md

Returns a Collection of severity => count. Uses fast chunk-level level_counts when no date filters are active, otherwise counts from get().

```php
public function getLevelCounts(): Collection
```

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

### Iterate logs and display level name and class

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-levels.md

Uses the LogViewer facade to fetch the first file's logs (limited to 10) and prints each log's level name and class value. Demonstrates the getLevel() method on log entries.

```php
use Opcodes\LogViewer\Facades\LogViewer;

// Every log exposes its level through getLevel()
foreach (LogViewer::getFiles()->first()?->logs()->limit(10)->get() ?? [] as $log) {
    echo $log->getLevel()->getName().' => '.$log->getLevel()->getClass()->value.PHP_EOL;
}
```

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

### NginxStatusLevel

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-levels.md

Represents Nginx log levels. Provides constants for each level, a constructor, static cases/from methods, and methods to get the level name and CSS class.

```APIDOC
## NginxStatusLevel

### Description
Represents Nginx log levels. Provides constants for each level, a constructor, static cases/from methods, and methods to get the level name and CSS class.

### Constants
- `Debug` = 'debug'
- `Info` = 'info'
- `Notice` = 'notice'
- `Warning` = 'warn'
- `Error` = 'error'
- `Critical` = 'crit'
- `Alert` = 'alert'
- `Emergency` = 'emerg'

### Constructor
`__construct(?string $value = null)` - Defaults to Error.

### Static Methods
- `cases(): array` - Returns an array of all cases.
- `from(?string $value = null): self` - Creates an instance from a value.
- `caseValues(): array` - Returns an array of case values.

### Instance Methods
- `getName(): string` - Returns the level name, with "Warning", "Critical", and "Emergency" special-cased.
- `getClass(): LevelClass` - Maps the level to a CSS class.
```

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

### Host::fromConfig

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/host.md

Builds a Host instance from a configuration array. Handles numeric identifiers by generating a short MD5 hash of the host URL and falling back to the host URL as the name.

```APIDOC
## Host::fromConfig

### Description
Builds a Host instance from a configuration array. Handles numeric identifiers by generating a short MD5 hash of the host URL and falling back to the host URL as the name.

### Method
Static method

### Signature
```php
public static function fromConfig(string|int $identifier, array $config = []): self
```

### Parameters
- **$identifier** (string|int) - Required - The host identifier; if integer, treated as a numeric list index
- **$config** (array) - Optional - Configuration array with keys: name, host, headers, auth, verify_server_certificate

### Returns
- **Host** - A new Host instance

### Example
```php
$host = Host::fromConfig('staging', [
    'name' => 'Staging',
    'host' => 'https://staging.example.com/log-viewer',
    'auth' => ['username' => 'u', 'password' => 'p'],
]);
```
```

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

### LaravelLogLevel

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-levels.md

Represents Laravel log levels. Provides constants for each level, a constructor, static cases/from methods, and methods to get the level name and CSS class.

```APIDOC
## LaravelLogLevel

### Description
Represents Laravel log levels. Provides constants for each level, a constructor, static cases/from methods, and methods to get the level name and CSS class.

### Constants
- `Debug` = 'DEBUG'
- `Info` = 'INFO'
- `Notice` = 'NOTICE'
- `Warning` = 'WARNING'
- `Error` = 'ERROR'
- `Critical` = 'CRITICAL'
- `Alert` = 'ALERT'
- `Emergency` = 'EMERGENCY'
- `None` = ''

### Constructor
`__construct(?string $value = null)` - Defaults to None.

### Static Methods
- `cases(): array` - Returns an array of all cases.
- `from(?string $value = null): self` - Creates an instance from a value.
- `caseValues(): array` - Alias of cases().

### Instance Methods
- `getName(): string` - Returns the level name.
- `getClass(): LevelClass` - Maps the level to a CSS class: DEBUG/INFO → info, NOTICE → notice, WARNING → warning, ERROR/CRITICAL/ALERT/EMERGENCY → danger, else none.
```

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

### Customize authorization and reader class with LogViewer facade

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-viewer-service.md

Demonstrates how to set a custom authorization callback using LogViewer::auth(), swap in a custom reader class with LogViewer::useLogReaderClass(), and raise the per-entry render cap from the 128 KB default using LogViewer::setMaxLogSize().

```php
use Opcodes\LogViewer\Facades\LogViewer;

// Custom authorization via a callable (e.g. from a service provider boot())
LogViewer::auth(function ($request) {
    return $request->user()?->can('view-logs') ?? false;
});

// Swap in a custom reader implementation
LogViewer::useLogReaderClass(MyCustomReader::class);

// Raise the per-entry render cap from the 128 KB default
LogViewer::setMaxLogSize(1024 * 1024); // 1 MB
```

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

### Usage example: validateRegex with exception handling

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/utils.md

Demonstrates catching InvalidRegularExpression when validating an invalid regex pattern. The method throws when $throw is true and the regex is invalid.

```php
use Opcodes\LogViewer\Exceptions\InvalidRegularExpression;
use Opcodes\LogViewer\Utils\Utils;

try {
    Utils::validateRegex('([unclosed');   // throws
} catch (InvalidRegularExpression $e) {
    // handle invalid user-supplied pattern
}
```

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

### rootPrefix method

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-folder.md

Static, memoized method returning the configured root folder prefix, defaulting to 'root'.

```php
public static function rootPrefix(): string
```

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

### HostCollection::fromConfig() method signature

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/host.md

Static method that maps each identifier => config pair through Host::fromConfig().

```php
public static function fromConfig(array $config = []): self
```

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

### HostCollection::fromConfig

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/host.md

Creates a HostCollection from a configuration array by mapping each identifier-config pair through Host::fromConfig().

```APIDOC
## HostCollection::fromConfig

### Description
Creates a HostCollection from a configuration array by mapping each identifier-config pair through Host::fromConfig().

### Method
Static method

### Signature
```php
public static function fromConfig(array $config = []): self
```

### Parameters
- **$config** (array) - Optional - Associative array of identifier => config pairs

### Returns
- **HostCollection** - A new collection of Host instances

### Example
```php
$hosts = HostCollection::fromConfig([
    'local' => ['name' => 'Local'],
    'staging' => ['name' => 'Staging', 'host' => 'https://staging.example.com/log-viewer'],
]);
```
```

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

### GET /folders/{folderIdentifier}/download

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/endpoints.md

Downloads a folder as a ZIP file. Requires a valid signature and expires query pair produced by the request endpoint. Requires the PHP zip extension.

```APIDOC
## GET /folders/{folderIdentifier}/download

### Description
Downloads a folder as a ZIP file. Requires a valid signature and expires query pair produced by the request endpoint. Requires the PHP zip extension.

### Method
GET

### Endpoint
/folders/{folderIdentifier}/download

### Parameters
#### Path Parameters
- **folderIdentifier** (string) - Required - The identifier of the folder to download.

#### Query Parameters
- **signature** (string) - Required - The signature generated by the request endpoint.
- **expires** (integer) - Required - The expiration timestamp of the signature.

### Response
#### Success Response (200)
- The ZIP file content.

#### Error Response (403)
- Invalid or expired signature.
```

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

### GET /files/{fileIdentifier}/download/request

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/endpoints.md

Requests a temporary signed URL for downloading a file. Returns a JSON object with a URL that is valid for 1 minute. Returns 404 if the file is not found.

```APIDOC
## GET /files/{fileIdentifier}/download/request

### Description
Requests a temporary signed URL for downloading a file. Returns a JSON object with a URL that is valid for 1 minute. Returns 404 if the file is not found.

### Method
GET

### Endpoint
/files/{fileIdentifier}/download/request

### Parameters
#### Path Parameters
- **fileIdentifier** (string) - Required - The identifier of the file to download.

### Response
#### Success Response (200)
- **url** (string) - The temporary signed URL for downloading the file.

#### Response Example
{
  "url": "https://example.com/signed-url"
}

#### Error Response (404)
- File not found.
```

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

### index() method

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-file.md

Returns and memoizes the LogIndex instance for this file. A non-empty query produces a query-scoped index.

```php
public function index(?string $query = null): LogIndex
```

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

### SupervisorLogLevel class methods

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-levels.md

Defines the public methods for the SupervisorLogLevel class. Includes a MAP constant that maps shorthand codes to level names. The constructor takes a string value and maps shorthand via MAP before storing. from returns a LevelInterface. caseValues returns array_values(MAP). getName returns the level name, and getClass returns the corresponding LevelClass.

```php
const MAP = [
    'CRIT' => 'critical', 'ERRO' => 'error', 'WARN' => 'warning', 'INFO' => 'info',
    'DEBG' => 'debug', 'TRAC' => 'trace', 'BLAT' => 'blather',
];

public function __construct(string $value)   // maps shorthand via MAP before storing
public static function from(?string $value = null): LevelInterface
public static function caseValues(): array    // array_values(MAP)
public function getName(): string
public function getClass(): LevelClass
```

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

### Add local path repository to composer.json

Source: https://github.com/opcodesio/log-viewer/blob/main/CONTRIBUTING.md

Modify composer.json to add a repositories key with the path to your local Log Viewer copy, so Composer installs from your local folder instead of the official repository.

```json
// File: composer.json

{
  "scripts": { ... },

  "repositories": [
    {
      "type": "path",
      "url": "/home/myuser/projects/log-viewer"

    }
  ]
}
```

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

### Use LaravelLogLevel to get level name and class

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-levels.md

Creates a LaravelLogLevel instance from a string and outputs its name and CSS class value. Useful for mapping log level strings to their display properties.

```php
use Opcodes\LogViewer\LogLevels\LaravelLogLevel;

$level = LaravelLogLevel::from('ERROR');
echo $level->getName();          // "Error"
echo $level->getClass()->value;  // "danger"
```

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

### LogFolder::__construct

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-folder.md

Creates a new LogFolder instance with a path and files collection.

```APIDOC
## LogFolder::__construct

### Description
Creates a new LogFolder instance.

### Method
Constructor

### Signature
```php
public function __construct(
    public string $path,
    mixed $files,
)
```

### Parameters
- **$path** (string) - Required - Folder path; empty or the logs base path denotes the root folder.
- **$files** (mixed) - Required - Any value accepted by `LogFileCollection` (array of `LogFile`, or a `LogFileCollection`).

### Notes
Public property `identifier` is set to `Utils::shortMd5(path)` (IP-prefixed unless `log-viewer.exclude_ip_from_identifiers` is enabled).
```

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

### Utils class method signatures

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/utils.md

Lists the static methods available in the Utils class with their signatures. Use these helpers for formatting byte sizes, measuring variable memory, validating regex, generating short MD5 hashes, recursive globbing, and obtaining the local IP.

```php
class Utils
{
    public static function bytesForHumans(int $bytes): string
    public static function sizeOfVar(mixed $var): int
    public static function sizeOfVarInMB(mixed $var): string
    public static function validateRegex(string $regexString, bool $throw = true): bool
    public static function shortMd5(string $content, int $length = 8): string
    public static function glob_recursive($pattern, $flags = 0): array
    public static function getLocalIP(bool $cached = true): string
    public static function setCachedLocalIP(string $ip): void     // testing only
}
```

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

### RedisLogLevel class methods

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-levels.md

Defines the public methods for the RedisLogLevel class. The constructor takes a string value. from returns a LevelInterface. caseValues returns a mapping of Redis log symbols to level names: '.' => debug, '-' => verbose, '*' => notice, '#' => warning. getName maps symbols to names: '.'→Debug, '-'→Verbose, '*'→Notice, '#'→Warning. getClass returns the corresponding LevelClass.

```php
public function __construct(string $value)
public static function from(?string $value = null): LevelInterface
public static function caseValues(): array
// ['.' => 'debug', '-' => 'verbose', '*' => 'notice', '#' => 'warning']
public function getName(): string     // '.'→Debug, '-'→Verbose, '*'→Notice, '#'→Warning
public function getClass(): LevelClass
```

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

### Query-scoped, filtered, newest-first traversal

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-index.md

Demonstrates a filtered traversal of the index with a query, level filter, date range, direction, skip, and limit. Iterates with next() to get [logIndex, position] pairs where position is the byte offset of the log entry in the file.

```php
use Opcodes\LogViewer\Facades\LogViewer;
use Opcodes\LogViewer\Direction;

$file = LogViewer::getFile($identifier);
$index = $file->index();

// Query-scoped, filtered, newest-first traversal
$index
    ->setQuery('exception')
    ->forLevels(['ERROR', 'CRITICAL'])
    ->forDateRange(now()->subDay()->timestamp, now()->timestamp)
    ->setDirection(Direction::Backward)
    ->skip(20)
    ->limit(10);

while (($item = $index->next()) !== null) {
    [$logIndex, $position] = $item;
    // $position is the byte offset where this log entry starts in the file
}
```

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

### LogFile::__construct

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-file.md

Creates a new LogFile instance with the given path, optional type, and optional path alias.

```APIDOC
## LogFile::__construct

### Description
Creates a new LogFile instance representing a single log file.

### Method
Constructor

### Signature
```php
public function __construct(string $path, ?string $type = null, ?string $pathAlias = null)
```

### Parameters
- **$path** (string) - Required - Absolute filesystem path of the log file
- **$type** (?string) - Optional - A LogType value; when null, the type is guessed on first type() call
- **$pathAlias** (?string) - Optional - Folder alias used for display when the file was matched via an include_files alias pattern

### Public Properties Set
- **$path** (string) - Absolute path
- **$name** (string) - basename($path)
- **$identifier** (string) - Utils::shortMd5(ip . ':' . path) . '-' . name, or without IP when exclude_ip_from_identifiers is true
- **$subFolder** (string) - Directory portion of the path (or pathAlias), trailing separator stripped
- **$displayPath** (string) - pathAlias . DIRECTORY_SEPARATOR . name, or path when no alias
```

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

### log-viewer:generate-dummy-logs

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/console-commands.md

Generates dummy log entries to preview in the Log Viewer. It refuses to run in production and accepts an amount and optional channel.

```APIDOC
## [ARTISAN] log-viewer:generate-dummy-logs

### Description
Generates dummy log entries to preview in the Log Viewer. It refuses to run in production and accepts an amount and optional channel.

### Method
Artisan command

### Endpoint
`php artisan log-viewer:generate-dummy-logs {amount} {--channel=single}`

### Parameters
#### Arguments
- **amount** (int) - Required - Number of dummy log entries to generate.

#### Options
- **--channel** (string) - Optional - Log channel passed to `Log::channel($channel)`. Default: `single`.

### Behavior
1. Refuses to run when `app()->environment('production')` — prints `'You should not be generating dummy logs in production. Exiting...'` and returns.
2. Loops `$amount` times choosing a random severity from `['info', 'debug', 'warning', 'error']` (via `Arr::random`).
3. For `error` it logs `new \Exception('Example exception being logged')`; for other levels it logs `'Example log entry for the level {level}'` with context `['one' => 1, 'two' => 'two', 'three' => [1, 2, 3]]`.

### Usage Example
```bash
php artisan log-viewer:generate-dummy-logs 100 --channel=stderr
```
```

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

### PublishCommand class for log-viewer:publish

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/console-commands.md

Defines the log-viewer:publish command with an optional --watch flag. The handle() method is omitted in the source; it prints a deprecation warning, calls vendor:publish with --tag=log-viewer-assets and --force, and if --watch is set, watches the package public directory for manifest.json changes.

```php
<?php

namespace Opcodes\LogViewer\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Support\Str;
use Opcodes\LogViewer\LogViewerServiceProvider;
use Spatie\Watcher\Watch;

class PublishCommand extends Command
{
    protected $signature = 'log-viewer:publish  {--watch}';
    protected $description = 'Publish Log Viewer assets';

    public function handle() { ... }
}
```

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

### Publish Log Viewer assets with watch mode

Source: https://github.com/opcodesio/log-viewer/blob/main/CONTRIBUTING.md

Publish assets and continuously watch for new front-end changes using the --watch parameter.

```shell
php artisan log-viewer:publish --watch
```

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

### Format code with Laravel Pint

Source: https://github.com/opcodesio/log-viewer/blob/main/CONTRIBUTING.md

Run Laravel Pint for code formatting.

```shell
composer format
```

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

### cleanPath method

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-folder.md

Returns the cleaned path: root folders return rootPrefix(), otherwise replaces the base path prefix with rootPrefix and directory separator, and replaces HOME with ~ if present.

```php
public function cleanPath(): string
```

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

### Index query methods usage

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-index.md

Shows how to query the index with filters, direction, skip, and limit, and iterate over results.

```APIDOC
## Index query methods usage

### Description
Shows how to query the index with filters, direction, skip, and limit, and iterate over results.

### Usage Example
```php
use Opcodes\LogViewer\Facades\LogViewer;
use Opcodes\LogViewer\Direction;

$file = LogViewer::getFile($identifier);
$index = $file->index();

// Query-scoped, filtered, newest-first traversal
$index
    ->setQuery('exception')
    ->forLevels(['ERROR', 'CRITICAL'])
    ->forDateRange(now()->subDay()->timestamp, now()->timestamp)
    ->setDirection(Direction::Backward)
    ->skip(20)
    ->limit(10);

while (($item = $index->next()) !== null) {
    [$logIndex, $position] = $item;
    // $position is the byte offset where this log entry starts in the file
}
```
```

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

### Build production assets

Source: https://github.com/opcodesio/log-viewer/blob/main/CONTRIBUTING.md

Build CSS and JavaScript assets for production before committing if you changed any front-end files.

```shell
npm run production
```

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

### getRouteDomain() / getRoutePrefix() / getRouteMiddleware()

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-viewer-service.md

Returns route configuration values for domain, prefix, and middleware.

```APIDOC
## getRouteDomain() / getRoutePrefix() / getRouteMiddleware()

### Description
Returns the configured route domain, prefix, and middleware for the log viewer routes.

### Method
GET

### Endpoint
N/A (PHP methods)

### Parameters
None

### Response
#### Success Response
- **domain** (string|null) - The route domain.
- **prefix** (string) - The route prefix.
- **middleware** (array) - The middleware array.

#### Response Example
```
{
  "domain": null,
  "prefix": "log-viewer",
  "middleware": ["web"]
}
```
```

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

### latest() and earliest() method signatures

Source: https://github.com/opcodesio/log-viewer/blob/main/_autodocs/api-reference/log-file-collection.md

Signatures for methods that return the file with the greatest latestTimestamp() or least earliestTimestamp(), or null on empty collection.

```php
public function latest(): ?LogFile
public function earliest(): ?LogFile
```
Tokens:
Raw