# Tempest

### Requirements

* PHP ^8.5
* Tempest ^3.0

## Install

Install the latest version by:

```bash
composer require inspector-apm/inspector-tempest
```

Tempest will automatically discover the package provider and other library components.

### Configure the Ingestion Key

You just need to put the Ingestion Key in your environment file:

```
INSPECTOR_INGESTION_KEY=[ingestion key]
```

You can obtain an `INSPECTOR_INGESTION_KEY` creating a new project in your [Inspector](https://inspector.dev) account.

### Test everything is working

Run the command below:

```bash
vendor/bin/tempest inspector:test
```

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

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

## Publish Configuration

If you want to take full control over the Inspector client behaviour you need to install the inspector assets on your project directory.

The command below will add the `app/inspector.config.php` file providing the `InspectorConfig` instance:

```shellscript
php tempest install inspector    
```

### Ignore Urls

It could be necessary to turn off monitoring based on url. Think about parts of your app that don't affect the user experience.&#x20;

You can also use the wildcard character \* to exclude all sub-paths.

{% code title="inspector.config.php" %}

```php
return new InspectorConfig(
    ...,
    ignoreUrls: [
        '/admin/*'
    ],
);
```

{% endcode %}

### Ignore Commands

You can ignore artisan commands by adding the command name to the `ignoreCommands` argument in the `InspectorConfig` configuration class:

{% code title="inspector.config.php" %}

```php
return new InspectorConfig(
    ...,
    ignoreCommands: [
        'discovery:generate'
    ],
);
```

{% endcode %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.inspector.dev/guides/tempest.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.