An open API service indexing awesome lists of open source software.

https://github.com/inspector-apm/inspector-symfony

Connect your Symfony application to the Inspector monitoring dashboard.
https://github.com/inspector-apm/inspector-symfony

error-handling error-reporting inspector messenger-monitoring monitoring monitoring-tool symfony

Last synced: 2 months ago
JSON representation

Connect your Symfony application to the Inspector monitoring dashboard.

Awesome Lists containing this project

README

          

# Inspector | Code Execution Monitoring tool

[![Total Downloads](https://poser.pugx.org/inspector-apm/inspector-symfony/downloads)](//packagist.org/packages/inspector-apm/inspector-symfony)
[![Latest Stable Version](https://poser.pugx.org/inspector-apm/inspector-symfony/v/stable)](https://packagist.org/packages/inspector-apm/inspector-symfony)
[![License](https://poser.pugx.org/inspector-apm/inspector-symfony/license)](//packagist.org/packages/inspector-apm/inspector-symfony)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)

> Before moving on, please consider giving us a GitHub star ⭐️. Thank you!

Code Execution Monitoring for Symfony applications.

- [Requirements](#requirements)
- [Install](#install)
- [Configure the INGESTION key](#key)
- [Test & Deploy](#deploy)
- [AI Assisted Integration](#agentic)
- [Official Documentation](https://docs.inspector.dev/symfony)

## Requirements

- PHP >= 8.1
- Symfony ^6.0|^7.0|^8.0

## Install

Install the latest version of the bundle:

```
composer require inspector-apm/inspector-symfony
```

## Configure the INGESTION Key

You can obtain the `ingestion key` creating a new project in your [Inspector](https://app.inspector.dev) dashboard.

```dotenv
INSPECTOR_INGESTION_KEY=895d9e6dxxxxxxxxxxxxxxxxx
```

## Test & Deploy
Execute the Symfony command below to check if your app can send data to Inspector correctly:

```
php bin/console inspector:test
```

Go to https://app.inspector.dev to explore your data.

Inspector monitors many components by default:

- HTTP requests
- Console commands
- SQL queries
- Twig views rendering
- Background Messenger processing
- HTTP client outgoing requests

But you have several configuration parameters to customize its behavior. Check out the official documentation below.

## 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)

## Official documentation

**[Go to the official documentation](https://docs.inspector.dev/guides/symfony/installation)**

## Contributing

We encourage you to contribute to the development of the Inspector bundle!
Please check out the [Contribution Guidelines](CONTRIBUTING.md) about how to proceed. Join us!

## LICENSE

This bundle is licensed under the [MIT](LICENSE) license.