README

This package is a continuation of the excellent work done by goksagun at goksagun/elastic-apm-bundle.

Installation

Applications that use Symfony Flex

Open a command console, enter your project directory and execute:

$ composer require chq81/elastic-apm-bundle

Applications that don't use Symfony Flex

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require chq81/elastic-apm-bundle

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the app/AppKernel.php file of your project:

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = [
            // ...
            new Chq81\ElasticApmBundle\ElasticApmBundle(),
        ];

        // ...
    }

    // ...
}

Step 3: Add the Bundle config file

Then, add the bundle configuration yml file elastic_apm.yml into config/packages directory:

elastic_apm:
    enabled: true # Activate the APM Agent, default is true
    serviceName: 'Symfony APM App' # The name of your service, required
    serverUrl: 'http://localhost:8200' # The URL for your APM service, required The URL must be fully qualified, including the protocol and port.
    secretToken: null # The secret token required to send data to your APM service
    environment: dev # The environment of your service

Configuration

The following configurations options are provided:

Furthermore, it is possible to de-/activate the data capturing for transactions and errors. Per default, both are enabled. For errors, status codes and exceptions can be excluded. See the following example:

transactions: # Captures transactions
   enabled: true # Activating capturing of transactions, default is true
errors: # Captures errors
   enabled: true # Activating capturing of errors, default is true
       exclude:
           status_codes: [] # Status codes which should not be captured. The default is none.
           exceptions: [] # Exceptions which should not be captured. The default is none.

Contributing

Contributions are welcome. Read the contributing guide to get started.

Contributors

A big thank you goes out to every contributor of this repo, special thanks goes out to:

• goksagun