https://github.com/auxmoney/opentracingbundle-guzzle

Guzzle extension for the auxmoney/OpentracingBundle-core
https://github.com/auxmoney/opentracingbundle-guzzle

auxmoney distributed-tracing guzzle guzzlehttp opentracing opentracing-bundle symfony symfony-bundle

Last synced: 2 months ago
JSON representation

Guzzle extension for the auxmoney/OpentracingBundle-core

• Host: GitHub
• URL: https://github.com/auxmoney/opentracingbundle-guzzle
• Owner: auxmoney
• License: mit
• Created: 2020-01-06T14:52:32.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-11-06T20:08:48.000Z (3 months ago)
• Last Synced: 2024-11-10T10:06:51.132Z (3 months ago)
• Topics: auxmoney, distributed-tracing, guzzle, guzzlehttp, opentracing, opentracing-bundle, symfony, symfony-bundle
• Language: PHP
• Homepage:
• Size: 284 KB
• Stars: 5
• Watchers: 5
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# auxmoney OpentracingBundle - Guzzle

[![test](https://github.com/auxmoney/OpentracingBundle-Guzzle/workflows/test/badge.svg)](https://github.com/auxmoney/OpentracingBundle-Guzzle/actions?query=workflow%3Atest)

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/auxmoney/OpentracingBundle-Guzzle)](https://github.com/auxmoney/OpentracingBundle-Guzzle/releases/latest)

![Codacy Badge](https://api.codacy.com/project/badge/Grade/aab701199e104bb6bdb247a4bdf7f5f2)

![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/auxmoney/OpentracingBundle-Guzzle)

![Scrutinizer code quality (GitHub/Bitbucket)](https://img.shields.io/scrutinizer/quality/g/auxmoney/OpentracingBundle-Guzzle)

![GitHub](https://img.shields.io/github/license/auxmoney/OpentracingBundle-Guzzle)

This bundle adds automatic header injection for Guzzle clients to the [OpentracingBundle](https://github.com/auxmoney/OpentracingBundle-core).

## Installation

### Prerequisites

This bundle is only an additional plugin and should not be installed independently. See

[its documentation](https://github.com/auxmoney/OpentracingBundle-core#installation) for more information on installing the OpentracingBundle first.

### Require dependencies

After you have installed the OpentracingBundle:

* require the dependencies:

```bash

    composer req auxmoney/opentracing-bundle-guzzle

```

### Enable the bundle

If you are using [Symfony Flex](https://github.com/symfony/flex), you are all set!

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

* add bundle to your application:

```php

    # Symfony 3: AppKernel.php

    $bundles[] = new Auxmoney\OpentracingGuzzleBundle\OpentracingGuzzleBundle();

```

```php

    # Symfony 4+: bundles.php

    Auxmoney\OpentracingGuzzleBundle\OpentracingGuzzleBundle::class => ['all' => true],

```

## Configuration

No configuration is necessary, the provided compiler pass will try to enhance existing `Client`s by adding a middleware to their `HandlerStack`s.

## 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

```bash

    composer run-script quality

```

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