Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inspector-apm/inspector-php
Connect your PHP application to Inspector monitoring dashboard.
https://github.com/inspector-apm/inspector-php
inspector monitoring php
Last synced: 6 days 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 (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-20T16:16:08.000Z (29 days ago)
- Last Synced: 2025-01-05T02:07:18.500Z (13 days ago)
- Topics: inspector, monitoring, php
- Language: PHP
- Homepage: https://www.inspector.dev
- Size: 303 KB
- Stars: 29
- Watchers: 2
- Forks: 9
- Open Issues: 1
-
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)
[](CODE_OF_CONDUCT.md)
[](https://travis-ci.org/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 >= 7.2.0
## 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 represent an execution cycle and it can contains 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 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\Arrayable $entry)
{
// Add an \Inspector\Models\Arrayable 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 the will receive the current configuration state as parameter.
```php
$inspector->setTransport(function ($configuration) {
return new CustomTransport($configuration);
});
```
**[Chek out the official documentation](https://docs.inspector.dev/php)**
## 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.