https://github.com/inspector-apm/inspector-php
Connect your PHP application to Inspector monitoring dashboard.
https://github.com/inspector-apm/inspector-php
error-handling error-monitoring error-reporting inspector monitoring monitoring-tool php
Last synced: 3 months ago
JSON representation
Connect your PHP application to Inspector monitoring dashboard.
- Host: GitHub
- URL: https://github.com/inspector-apm/inspector-php
- Owner: inspector-apm
- License: mit
- Created: 2019-04-02T17:57:01.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2026-01-21T11:27:35.000Z (3 months ago)
- Last Synced: 2026-01-21T22:57:18.058Z (3 months ago)
- Topics: error-handling, error-monitoring, error-reporting, inspector, monitoring, monitoring-tool, php
- Language: PHP
- Homepage: https://inspector.dev?utm_source=github&utm_medium=link&utm_campaign=organic&utm_content=php
- Size: 391 KB
- Stars: 34
- Watchers: 1
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Inspector | Code Execution Monitoring Tool
[](//packagist.org/packages/inspector-apm/inspector-php)
[](https://packagist.org/packages/inspector-apm/inspector-php)
[](//packagist.org/packages/inspector-apm/inspector-php)
> Before moving on, please consider giving us a GitHub star ⭐️. Thank you!
Code Execution Monitoring, built for PHP developers.
## Requirements
- PHP >= ^8.1
## Install
Install the latest version by:
```shell
composer require inspector-apm/inspector-php
```
## Use
To start sending data to Inspector you need an Ingestion Key to create an instance of the `Configuration` class.
You can obtain `INSPECTOR_API_KEY` creating a new project in your [Inspector](https://www.inspector.dev) dashboard.
```php
use Inspector\Inspector;
use Inspector\Configuration;
$configuration = new Configuration('YOUR_INGESTION_KEY');
$inspector = new Inspector($configuration);
```
All start with a `transaction`. Transaction represents an execution cycle, and it can contain one or hundred of segments:
```php
// Start an execution cycle with a transaction
$inspector->startTransaction($_SERVER['PATH_INFO']);
```
Use `addSegment` method to monitor a code block in your transaction:
```php
$result = $inspector->addSegment(function ($segment) {
// Do something here...
return "Hello World!";
}, 'my-process');
echo $result; // this will print "Hello World!"
```
Inspector will monitor your code execution in real time alerting you if something goes wrong.
## Custom Transport
You can also set up a custom transport class to transfer monitoring data from your server to Inspector
in a personalized way.
The transport class needs to implement `\Inspector\Transports\TransportInterface`:
```php
class CustomTransport implements \Inspector\Transports\TransportInterface
{
protected $configuration;
protected $queue = [];
public function __constructor($configuration)
{
$this->configuration = $configuration;
}
public function addEntry(\Inspector\Models\Model $entry)
{
// Add an \Inspector\Models\Model entry in the queue.
$this->queue[] = $entry;
}
public function flush()
{
// Performs data transfer.
$handle = curl_init('https://ingest.inspector.dev');
curl_setopt($handle, CURLOPT_POST, 1);
curl_setopt($handle, CURLOPT_HTTPHEADER, [
'X-Inspector-Key: xxxxxxxxxxxx',
'Content-Type: application/json',
'Accept: application/json',
]);
curl_setopt($handle, CURLOPT_POSTFIELDS, json_encode($this->queue));
curl_exec($handle);
curl_close($handle);
}
}
```
Then you can set the new transport in the `Inspector` instance
using a callback that will receive the current configuration state as parameter.
```php
$inspector->setTransport(function (\Inspector\Configuration $configuration) {
return new CustomTransport($configuration);
});
```
**[Chek out the official documentation](https://docs.inspector.dev/php)**
## Agentic Integration
You can connect the Inspector library documentation to your coding assistant as a Model Context Protocol (MCP) server.
It makes it easy for tools like Claude Code, Cursor, and VS Code extensions reliably understand what Inspector
client library can do, its configurations, how to use it.
[AI Assisted Integration](https://docs.inspector.dev/concepts/agentic-integration)
## Contributing
We encourage you to contribute to Inspector! Please check out the [Contribution Guidelines](CONTRIBUTING.md) about how to proceed. Join us!
## LICENSE
This package is licensed under the [MIT](LICENSE) license.