Merge pull request #31 from nipwaayoni/remove-service-bindings

Replace container bindings for AgentBuilder configurations and resolv…

Author: dstepe

README.md

@@ -114,7 +114,7 @@ Refer to the [configuration docs](docs/configuration.md) for more information.
 
 ### HTTP Client Customization
 
-It is no longer possible to provide HTTP client options through the APM PHP Agent configuration. If you need to customize the HTTP client, you must implement and configure a suitable client object and properly register it with the Laravel service container. See the "HTTP Client Configuation" section of the [configuration docs](docs/configuration.md).
+It is no longer possible to provide HTTP client options through the APM PHP Agent configuration. If you need to customize the HTTP client, you must implement and configure a suitable client object and provide it to the `AgentBuilder`. See the "HTTP Client Configuration" section of the [configuration docs](docs/configuration.md).
 
 ## Laravel Test Setup
 

docs/breaking_changes.md

@@ -1,6 +1,10 @@
 # Breaking Changes
 
-## 7.x
+## 7.1.0
+
+1. Removed the ability to bind "ElasticApm*" objects into the container to set on the AgentBuilder. Configuring the AgentBuilder is now done by binding an implementation into the container which the ElasticApmServiceProvider will resolve and use.
+
+## 7.0.0
 
 1. The [Elastic APM PHP Agent](https://github.com/nipwaayoni/elastic-apm-php-agent) minimum version has been updated.
 2. It is no longer recommended to call `Agent::send()` in `Exceptions\Handler::report()`. This will likely result in duplicate reporting of exceptions.

docs/configuration.md

@@ -26,38 +26,67 @@ Once published, open the `config/elastic-apm.php` file and review the various se
 
 ## Customizing Agent Creation
 
+The `Agent` object used to manage APM events is created using the provided `AgentBuilder` class. You can control many aspects of the `Agent` creation by binding your own implementation into the service container. Some helpful examples are shown below. For more details, refer to the [Elastic APM PHP Agent](https://github.com/nipwaayoni/elastic-apm-php-agent/blob/master/docs/agent.md) documentation.
+
+### Binding an AgentBuilder
+
+Bind your implementation as a singleton in the service container:
+
+```php
+$this->app->bind(AgentBuilder::class, function () {
+    $builder = new AgentBuilder();
+
+    // configure the builder
+
+    return $builder;
+});
+```
+
+Note that the `ElasticApmServiceProvider` will always call the `AgentBuilder::withConfig()` and `AgentBuilder::withEnvData()` methods. You must use the provided `elastic-apm` configuration options to influence those settings.
+
 ### HTTP Client Configuration
 
-If you need to customize the HTTP client, you must create a [PSR-18](https://www.php-fig.org/psr/psr-18/) compatible implementation and bind it in the Laravel service container. For now, we will use a GuzzleHttp adapter from the PHP-HTTP project.
+If you need to customize the HTTP client, you must create a [PSR-18](https://www.php-fig.org/psr/psr-18/) compatible implementation and provide it to the `AgentBuilder. For now, we will use a GuzzleHttp adapter from the PHP-HTTP project.
 
 ```bash
 composer require http-interop/http-factory-guzzle php-http/guzzle6-adapter
 ```
 
-The following example demonstrates how to create a GuzzleHttp client that will not verify server certificates. Once you create the client, bind it in the service container under the `ElasticApmHttpClient` abstract.
+The following example demonstrates how to create a GuzzleHttp client that will not verify server certificates.
 
 ```php
-$this->app->bind('ElasticApmHttpClient', function () {
-    // Create the configured client
+$this->app->bind(AgentBuilder::class, function () {
+    $builder = new AgentBuilder();
+
     $client = new \GuzzleHttp\Client([
         'verify' => false,
         // other client options
     ]);
 
     // Wrap the client object in the adapter and return it
-    return new \Http\Adapter\Guzzle6\Client($client);
-});
+    $builder->withHttpClient(new \Http\Adapter\Guzzle6\Client($client));
 
+    return $builder;
+});
 ```
 
-If the service container has a binding for `ElasticApmHttpClient`, the concrete implementation will be retrieved and passed into the `Agent`.
+### APM Transaction Hooks
 
-### Other Agent Services
+You can hook the APM HTTP request/response process to examine the data to be sent to APM and the response after sending. This may be helpful in troubleshooting issues.
 
-ElasticApmEventFactory
-ElasticApmTransactionStore
-ElasticApmRequestFactory
-ElasticApmStreamFactory
+```php
+$this->app->bind(AgentBuilder::class, function () {
+    $builder = new AgentBuilder();
 
-### APM Transaction Hooks
+    $builder->withPreCommitCallback(function (RequestInterface $request) {
+        Log::info(sprintf('Pre commit url is: %s', $request->getUri()));
+    });
 
+    $builder->withPostCommitCallback(function (ResponseInterface $response) {
+        Log::info(sprintf('Post commit response status: %s', $response->getStatusCode()));
+        Log::debug($response->getBody()->getContents());
+    });
+
+    return $builder;
+});
+```

src/Providers/ElasticApmServiceProvider.php

@@ -51,10 +51,9 @@ public function register()
             'elastic-apm'
         );
 
-        $this->app->singleton(Agent::class, function ($app) {
-            $container = resolve(ContainerInterface::class);
-
+        $this->app->singleton(Agent::class, function () {
             $builder = resolve(AgentBuilder::class);
+
             $builder->withConfig(new Config(
                 array_merge(
                     [
@@ -70,26 +69,6 @@ public function register()
 
             $builder->withEnvData(config('elastic-apm.env'));
 
-            if ($container->has('ElasticApmEventFactory')) {
-                $builder->withEventFactory($container->get('ElasticApmEventFactory'));
-            }
-
-            if ($container->has('ElasticApmTransactionStore')) {
-                $builder->withTransactionStore($container->get('ElasticApmTransactionStore'));
-            }
-
-            if ($container->has('ElasticApmHttpClient')) {
-                $builder->withHttpClient($container->get('ElasticApmHttpClient'));
-            }
-
-            if ($container->has('ElasticApmRequestFactory')) {
-                $builder->withRequestFactory($container->get('ElasticApmRequestFactory'));
-            }
-
-            if ($container->has('ElasticApmStreamFactory')) {
-                $builder->withStreamFactory($container->get('ElasticApmStreamFactory'));
-            }
-
             return $builder->build();
         });