auxmoney/opentracing-bundle-php-http-httplug-bundle

Symfony Opentracing bundle extension for php-http/HttplugBundle

This package is auto-updated.

Last update: 2024-10-31 00:17:33 UTC


README

test GitHub release (latest SemVer) Codacy Badge Code Climate maintainability Scrutinizer code quality (GitHub/Bitbucket) GitHub

This bundle adds automatic header injection for php-http/httplug-bundle clients to the OpentracingBundle.

Installation

Prerequisites

This bundle is only an additional plugin and should not be installed independently. See OpentracingBundle and HttplugBundle first prior to install this package.

Require dependencies

After you have installed the OpentracingBundle and HttplugBundle:

    composer req auxmoney/opentracing-bundle-php-http-httplug-bundle

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:

    # Symfony 3: AppKernel.php
    $bundles[] = new Auxmoney\OpentracingHttplugBundle\OpentracingHttplugBundle();
    # Symfony 4+: bundles.php
    Auxmoney\OpentracingHttplugBundle\OpentracingHttplugBundle::class => ['all' => true],

Configuration

No configuration is necessary, the provided compiler pass will decorate PluginClientFactory in order to add the OpentracingPlugin (where tracing headers injection happens) to all existing Httplug clients.

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.