https://github.com/marcorieser/statamic-vitals
Provide vitals of your Statamic installation for external usage.
https://github.com/marcorieser/statamic-vitals
laravel monitoring php statamic vitals
Last synced: 12 months ago
JSON representation
Provide vitals of your Statamic installation for external usage.
- Host: GitHub
- URL: https://github.com/marcorieser/statamic-vitals
- Owner: marcorieser
- License: mit
- Created: 2022-04-06T10:44:40.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-17T12:27:25.000Z (almost 2 years ago)
- Last Synced: 2025-05-01T18:51:35.107Z (12 months ago)
- Topics: laravel, monitoring, php, statamic, vitals
- Language: PHP
- Homepage: https://vitals-for-statamic.com/
- Size: 23.4 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vitals for Statamic
> You can monitor your installations with this addon on [vitals-for-statamic.com](https://vitals-for-statamic.com).
Provide vitals of your Statamic installation for external usage.
```json
{
"system": {
"name": "System name",
"domain": "https:\/\/site.tld",
"environment": "production",
"laravel": "9.6.0",
"php": "8.1.4",
"debug": false
},
"statamic": {
"version": "3.3.4",
"cp_url": "https:\/\/site.tld\/cp",
"latest_version": "3.4.1",
"pro": true,
"antlers_version": "runtime",
"static_page_cache": "full",
"update_available": true
},
"addons": [
{
"name": "Collaboration",
"package": "statamic\/collaboration",
"version": "0.4.0",
"latest_version": "0.4.0",
"update_available": false
},
{
"name": "Export",
"package": "youfront\/statamic-export",
"version": "1.0.1",
"latest_version": "1.0.3",
"update_available": true
}
],
"updates_available": 2
}
```
## How to Install
You can search for this addon in the `Tools > Addons` section of the Statamic control panel and click **install**, or run the following command from your project root:
``` bash
composer require marcorieser/statamic-vitals
```
## Configuration
Be sure to generate an access key which is used to authenticate external requests.
```bash
php please vitals:generate-key
```
## How to Use
Send a post request to the vitals endpoint `https://site.tld/api/statamic-vitals/vitals`.
```bash
curl --request POST \
--url https://site.tld/api/statamic-vitals/vitals \
--header 'Content-Type: application/json' \
--data '{
"access_key":"4Vz?xNc_eE&2uqQL"
}'
```
### Parameters
| Parameter | Description | Default | Required |
|---------------|------------------------------------------------|---------|:--------:|
| `access_key` | The access key in your `.env` file | `''` | * |
| `clear_cache` | Whether the vitals should be generated freshly | `false` | |