Overview
PHP-based services require you to specify the directory path where the codebase is located. Traces are captured through integration points in PHP scripts and processed using the agent.
Prerequisite
Before you begin, ensure the following requirements are met:
- PHP Version: 8.1 to 8.4
- Docker Version: 20.1 or Higher
- Apache Version: 2.4 or Higher
- Nginx Version: 1.14 or Higher
- The command must be executed from the project's root directory.
- An active internet connection is required while executing the command.
Navigation
Go to Menu > Settings > APM > Application Registration. Clicking the Application Registration button, you can register a new application. From the application registration screen, select the instrumentation type Host/VM or Docker.
- Host/VM
- Docker
PHP Trace Configuration
| Field | Description |
|---|---|
| Select Agent | Select the Host/VM where this application is running. You can configure PHP application service for Linux type agent. |
| Language | Select PHP from the language icons. |
| App Hosting Type | Choose the method your application uses to execute PHP requests. You can select either PHP CLI or PHP FPM. |
| Web Server | If you select app hosting type as PHP FPM then you need to select the web server running your application as Apache or Nginx. |
| Service Name | Provide a unique and meaningful name (e.g., ERP). |
| PHP Directory Path | Please provide complete path where PHP is installed on your system. |
| Application Config Path | If you select app hosting type as PHP FPM then you need to provide complete path where your application or web server configuration is stored. |
Providing these details displays Setup Command to instrument your PHP application. To instrument your PHP application, run the following .sh script. Start collecting Traces by restarting your service.
You can configure Trace ingestion according to the framework used to build the application. The below mentioned are the supported frameworks.
Supported Frameworks
The following frameworks are supported for instrumentation and monitoring. Ensure your application version aligns with the supported versions listed below.
| Framework | Version(s) |
|---|---|
| CakePHP | 4 || 5 |
| CodeIgniter | 4.0+ |
| Laravel | 1.2.2+ |
| Symfony | 1.0.2+ |
| Slim Framework | 1.1.1+ |
Configuring the application, you can provide the below details:
| Field | Description |
|---|---|
| Service Attributes(Tags) | Add key–value tags to your application for better filtering and organizing data in Explorer. Attribute keys must be in lowercase (for example, apm.env = prod). To add multiple Key-Value pairs you can click the add icon. |
| Add Custom Parameters | Allows you to define custom sampling or tagging parameters for advanced use cases. These optional parameters are passed to the agent (for example, version=4). |
Clicking the Apply Configuration button, the ingestion gets started.
Once the Application is Running, you need to verify the below points:
- Confirm that the service has been registered successfully.
- On the service registration screen, the Service Trace Collection Status should display "Running."
- The traces will start appearing in the APM Explorer screen.
PHP Trace Configuration
| Field | Description |
|---|---|
| Select Agent | Select the Docker where this application is running. You can configure PHP application service for Linux type agent. |
| Language | Select PHP from the language icons. |
| App Hosting Type | Choose the method your application uses to execute PHP requests.i.e., PHP CLI, PHP FPM. |
| Service Name | Provide a unique and meaningful name (e.g., ERP). |
| Image Name | Specify the Docker image name where your application is running. (e.g nginx:latest) |
Providing these details displays Setup Command to instrument your Java application. Add the following argument to your java -jar command and restart the service to collect Traces.
You can configure Trace ingestion according to the framework used to build the application. The below mentioned are the supported frameworks.
Supported Frameworks
The following frameworks are supported for instrumentation and monitoring. Ensure your application version aligns with the supported versions listed below.
| Framework | Version(s) |
|---|---|
| CakePHP | 4 || 5 |
| CodeIgniter | 4.0+ |
| Laravel | 1.2.2+ |
| Symfony | 1.0.2+ |
| Slim Framework | 1.1.1+ |
Configuring the application, you can provide the below details:
| Field | Description |
|---|---|
| Service Attributes(Tags) | Add key–value tags to your application for better filtering and organizing data in Explorer. Attribute keys must be in lowercase (for example, apm.env = prod). To add multiple Key-Value pairs you can click the add icon. |
| Add Custom Parameters | Allows you to define custom sampling or tagging parameters for advanced use cases. These optional parameters are passed to the agent (for example, version=4). |
Clicking the Apply Configuration button, the ingestion gets started.
Once the Application is Running, you need to verify the below points:
- Confirm that the service has been registered successfully.
- On the service registration screen, the Service Trace Collection Status should display "Running."
- The traces will start appearing in the APM Explorer screen.