auxmoney/opentracing-bundle-guzzle

Symfony Opentracing bundle extension for Guzzle

v1.3.0 2023-05-05 09:12 UTC

Requires

• php: ^8.0
• auxmoney/opentracing-bundle-core: ^1.3
• guzzlehttp/guzzle: ^6.0|^7.0
• opentracing/opentracing: ^1.0.1

Requires (Dev)

• mtdowling/jmespath.php: ^2.6
• phpmd/phpmd: ^2.12
• phpspec/prophecy-phpunit: ^2.0
• phpstan/phpstan: ^1.5
• phpunit/phpunit: ^9.5
• roave/security-advisories: dev-latest
• squizlabs/php_codesniffer: ^3.6
• symfony/filesystem: *
• symfony/process: *
• symfony/yaml: *

MIT

• symfony
• Guzzle
• symfony-bundle
• opentracing
• distributed-tracing
• auxmoney
• opentracing-bundle

README

This bundle adds automatic header injection for Guzzle clients to the OpentracingBundle.

Installation

Prerequisites

This bundle is only an additional plugin and should not be installed independently. See its documentation for more information on installing the OpentracingBundle first.

Require dependencies

After you have installed the OpentracingBundle:

• require the dependencies:

    composer req auxmoney/opentracing-bundle-guzzle

Enable the bundle

If you are using Symfony Flex, you are all set!

If you are not using it, you need to manually enable the bundle:

• add bundle to your application:

    # Symfony 3: AppKernel.php
    $bundles[] = new Auxmoney\OpentracingGuzzleBundle\OpentracingGuzzleBundle();

    # Symfony 4+: bundles.php
    Auxmoney\OpentracingGuzzleBundle\OpentracingGuzzleBundle::class => ['all' => true],

Configuration

No configuration is necessary, the provided compiler pass will try to enhance existing Clients by adding a middleware to their HandlerStacks.

Usage

When sending a request to other systems, the tracing headers are automatically injected into the requests, thus enabling the full power of distributed tracing.

Development

Be sure to run

    composer run-script quality

every time before you push code changes. The tools run by this script are also run in the CI pipeline.