Giter Club home page Giter Club logo

opentelemetry-php's Introduction

OpenTelemetry php library

Gitter Build Status codecov

Communication

Most of our communication is done on gitter.im in the opentelemetry-php channel.

Our meetings are held weekly on zoom on Wednesdays at 10:30am PST / 1:30pm EST.
A Google calendar invite with the included zoom link can be found here

Installation

The recommended way to install the library is through Composer:

1.) You'll need to add a

 "minimum-stability": "dev"

To your project's composer.json file, as this utility has not reached a stable release status quite yet.

2.) Install the dependency with composer:

$ composer require open-telemetry/opentelemetry

Development

We use docker and docker-compose to perform a lot of our static analysis and testing.

If you're planning to develop for this library, it'll help to install docker engine and docker-compose.
You can find installation instructions for these packages can be found here, under the Docker Engine and Docker Compose submenus respectively.

Examples

You can use the examples/AlwaysSampleTraceExample.php file to test out the reference implementation we have.

The PHP should execute by itself, but if you'd like a no-fuss way to test this out with docker and docker-compose, you can perform the following simple steps:

1.) Start the local zipkin server by running docker-compose up -d
2.) Install the necessary dependencies by running make install. This will install the composer dependencies and store them in /vendor
2.) Execute the example trace using make example.

Exported spans can be seen in zipkin at http://127.0.0.1:9411

Static Analysis

We use Phan for static analysis. Currently our phan configuration is just a standard default analysis configuration. You can use our phan docker wrapper to easily perform static analysis on your changes.

Execute make phan from your bash compatible shell.

Testing

To make sure the tests in this repo work as you expect, you can use the included docker test wrapper.

Execute make test from your bash compatible shell.

Caveats

The Span Links concept is not yet implemented.

opentelemetry-php's People

Contributors

bobstrecansky avatar nenad avatar beniamin avatar morrisonlevi avatar astorm avatar austinschoen avatar nekufa avatar gianarb avatar wizofgoz avatar sergeykanzhelev avatar victoravelar avatar lalex avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.