https://github.com/bretrzaun/statuspage

Add a simple status page to applications.
https://github.com/bretrzaun/statuspage

php statuspage twig

Last synced: 19 days ago
JSON representation

Add a simple status page to applications.

• Host: GitHub
• URL: https://github.com/bretrzaun/statuspage
• Owner: bretrzaun
• License: mit
• Created: 2015-11-11T13:13:30.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-03-19T08:38:39.000Z (8 months ago)
• Last Synced: 2024-10-12T11:15:54.215Z (about 1 month ago)
• Topics: php, statuspage, twig
• Language: PHP
• Homepage:
• Size: 289 KB
• Stars: 6
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# StatusPage

[![Latest Stable Version](https://poser.pugx.org/bretrzaun/statuspage/v/stable)](https://packagist.org/packages/bretrzaun/statuspage)

[![Tests](https://github.com/bretrzaun/statuspage/actions/workflows/tests.yml/badge.svg)](https://github.com/bretrzaun/statuspage/actions/workflows/tests.yml)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/bretrzaun/statuspage/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/bretrzaun/statuspage/?branch=master)

Add a simple status page to applications with custom checks.

The status page runs all registered checks and renders a page showing its results.



    



## Installation

```

composer require bretrzaun/statuspage

```

## Usage

```php

$checker = new \BretRZaun\StatusPage\StatusChecker();

// add your checks here

$checker->addCheck(...);

// in different groups if you like

$group = new StatusCheckerGroup('Group 01');

$group->addCheck(...);

$group->addCheck(...);

$checker->addGroup($group);

// run the checks

$checker->check();

// use the built-in Twig template

$loader = new Twig_Loader_Filesystem('resources/views/');

$twig = new Twig_Environment($loader, ['autoescape' => false]);

$content = $twig->render(

    'status.twig',

        [

            'results' => $checker->getResults(),

            'title' => 'My status page'

        ]

    );

$code = $checker->hasErrors() ? 503 : 200;

// create a response with $content and $code

```

## Out-of-the-box checks

- **CallbackCheck**: generic check using a PHP callback function

- **DoctrineConnectionCheck**: checks for a valid [Doctrine DBAL](http://www.doctrine-project.org/projects/dbal.html) connection

- **ElasticsearchCheck**: checks an [Elasticsearch Client](https://github.com/elastic/elasticsearch-php) for successful pings

- **LogFileContentCheck**: check a (log) file for certain content

- **MongoDbCheck**: checks a [MongoDB](https://mongodb.com) client

- **PhpExtensionCheck**: check a given PHP extension is loaded

- **PhpIniCheck**: check a value of php.ini

- **PhpMemoryLimitCheck**: check PHP memory limit

- **PhpVersionCheck**: check PHP version

- **UrlCheck**: checks a URL

### Custom checks

Custom checks can be easily added by implementing `BretRZaun\StatusPage\Check\CheckInterface` or inheriting `BretRZaun\StatusPage\Check\AbstractCheck`.

## Tests

To run the tests, just enter:

```

composer install

vendor/bin/phpunit

```