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

Monolog extension for the auxmoney/OpentracingBundle-core
https://github.com/auxmoney/opentracingbundle-monolog

auxmoney distributed-tracing monolog opentracing opentracing-bundle symfony symfony-bundle

Last synced: about 1 month ago
JSON representation

Monolog extension for the auxmoney/OpentracingBundle-core

• Host: GitHub
• URL: https://github.com/auxmoney/opentracingbundle-monolog
• Owner: auxmoney
• License: mit
• Created: 2020-01-06T14:52:15.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-05T09:35:04.000Z (over 1 year ago)
• Last Synced: 2024-10-14T18:21:13.963Z (about 1 month ago)
• Topics: auxmoney, distributed-tracing, monolog, opentracing, opentracing-bundle, symfony, symfony-bundle
• Language: PHP
• Homepage:
• Size: 170 KB
• Stars: 3
• Watchers: 6
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# auxmoney OpentracingBundle - Monolog

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

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

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

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

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

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

This bundle adds a monolog processor to the [OpentracingBundle](https://github.com/auxmoney/OpentracingBundle-core) to automatically enrich 

log contexts with the current span context.

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

```

### 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\OpentracingMonologBundle\OpentracingMonologBundle();

```

```php

    # Symfony 4+: bundles.php

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

```

## Configuration

No configuration is necessary, the Monolog bundle extension will automatically load the provided `Processor` by tag.

## Usage

Whenever a message is logged, the content is extended with extra information of the span context.

```

    [2020-01-10 11:38:03] php.INFO: .... {"exception":"[object] (ErrorException(code: 0) ...."} {"opentracing-context":"{\"UBER-TRACE-ID\":\"15e880402e1a194715e880402e19a3e0:15e880402e19a3e0:0:1\"}"}

```

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