Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inspector-apm/inspector-slim
Connect Slim applications to Inspector AI Bug Fixer.
https://github.com/inspector-apm/inspector-slim
Last synced: about 7 hours ago
JSON representation
Connect Slim applications to Inspector AI Bug Fixer.
- Host: GitHub
- URL: https://github.com/inspector-apm/inspector-slim
- Owner: inspector-apm
- License: mit
- Created: 2023-01-16T10:28:53.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-22T11:29:26.000Z (over 1 year ago)
- Last Synced: 2024-09-24T10:18:05.763Z (about 2 months ago)
- Language: PHP
- Size: 17.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- 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-slim)
[](https://packagist.org/packages/inspector-apm/inspector-slim)
[](//packagist.org/packages/inspector-apm/inspector-slim)
[](code_of_conduct.md)
Simple code execution monitoring for Slim framework based applications.
- [Requirements](#requirements)
- [Install](#install)
- [Middleware](#middleware)
- [Test](#test)
- [Add Segment](#segment)
- [Official Documentation](https://docs.inspector.dev/guides/slim)
- [Contribution Guidelines](#contribution)
## Requirements
- PHP >= 7.2.0
- Slim >= 4.x
## Install
Install the latest version by:
```
composer require inspector-apm/inspector-slim
```
### Register On Container
First you have to register the Inspector instance inside the application container
in order to make the monitoring agent available within the application.
```php
$container->set('inspector', function () {
$configuration = new \Inspector\Slim\Configuration('INSPECTOR_INGESTION_KEY');
return new Inspector($configuration);
});
```
Consider to use [environment variables](https://github.com/vlucas/phpdotenv) to store your project's INGESTION KEY.
If you are using a Slim 4 skeleton you can add a new container definition in `app/dependencies.php` file:
```php
use DI\ContainerBuilder;
use Psr\Container\ContainerInterface;
return function (ContainerBuilder $containerBuilder) {
$containerBuilder->addDefinitions([
// Other services definitions...
'inspector' => function (ContainerInterface $container) {
$configuration = new \Inspector\Slim\Configuration('INSPECTOR_INGESTION_KEY');
return new Inspector\Inspector($configuration);
}
]);
}
```
You can get an `INSPECTOR_INGESTION_KEY` creating a new project in your [Inspector](https://www.inspector.dev) account.
## Attach the Middleware
You can attach the middleware globally:
```php
$app->add(\Inspector\Slim\WebRequestMonitoring::class);
```
Or in specific routes:
```php
$app->get('/', function () {
// your code here...
})->add(\Inspector\Slim\WebRequestMonitoring::class);
```
## Test that everything works
Create a test route and open it in the browser [http://localhost:8080](http://localhost:8080):
```php
$app->get('/test', function () {
throw new \Exception('My First Exception.');
})->add(\Inspector\Slim\WebRequestMonitoring::class);
```
## Add Segment
You can add segments to the transaction's timeline from route functions:
```php
$app->get('/', function (Request $request, Response $response) {
/*
* Retrieve the inspector instance from the container.
*/
$this->get('inspector')->addSegment(function () {
// Your code here...
sleep(1);
}, 'sleep');
return $response;
});
```
If your routes are organized using controllers you need to inject the container in the controller constructor:
```php
namespace App\Controllers;
use Psr\Container\ContainerInterface;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
class TestController
{
protected $container;
/**
* Inject the container to retrieve the inspector instance later.
*/
public function __construct(ContainerInterface $container)
{
$this->container = $container;
}
public function __invoke(Request $request, Response $response)
{
// Retrieve the inspector instance from the container.
$this->container->get('inspector')->addSegment(function () {
// Your code here...
sleep(1);
}, 'sleep');
$response->getBody()->write('Test route.');
return $response;
}
}
```
## Official documentation
**[Check out the official documentation](https://docs.inspector.dev/guides/slim)**
## 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.