++ed by:
KEEDI VEESH

2 PAUSE users
1 non-PAUSE user.

Author image Theo van Hoesel
and 1 contributors

NAME

OpenTracing::Manual - A quick overview about Perl5 and OpenTracing

WARNING

The OpenTracing module on CPAN is NOT COMPLIANT with anything remotely to OpenTracing.IO or the OpenTracing::Interface.

DO NOT USE THE OPENTRACING PACKAGE

DESCRIPTION

This Manual is a quick overview of what is available in Perl related to the OpenTracing API related Interface Definition.

This manual targets three different audiences:

Application developers and Devops

Those that want to add instrumentation and tracing to their appilication or micro services.

See OpenTracing::Manual::Instrumentation.

Framework or Integration Developers

Those writing integrations for frameworks, such that those can easily extract tracing information from incoming request or inject that into outgoing requests.

See OpenTracing::Manual::Integration.

Tracing service Implementation providers

Those that want to have the Perl Implementation communicate with their tracing service provider.

See OpenTracing::Manual::Implementation.

INTRODUCTION TO DISTRIBUTED AND OPENTRACING

From the OpenTracing IO website:

OpenTracing is comprised of an API specification, frameworks and libraries that have implemented the specification, and documentation for the project. OpenTracing allows developers to add instrumentation to their application code using APIs that do not lock them into any one particular product or vendor.

Distributed tracing, also called distributed request tracing, is a method used to profile and monitor applications, especially those built using a microservices architecture. Distributed tracing helps pinpoint where failures occur and what causes poor performance.

See also: OpenTracing Overview.

For a very condensed overview of how to use OpenTracing see: "SYNOPSIS" in OpenTracing::Interface

THE OPENTRACING ECOSYSTEM FOR PERL

Included is a list of Perl Modules and those that are on the horizon, see the OpenTracing::Manual::Ecosystem.

"The OpenTracing API Specification" in OpenTracing::Manual::Ecosystem.

The specification itself, and related modules.

"Frameworks and Integrating OpenTracing" in OpenTracing::Manual::Ecosystem.

Distributed Tracing is all about connecting services and microservices together, the following modules will handle the edges of the application and services and bootstrap tracer implementations.

"Instrumenting a Application" in OpenTracing::Manual::Ecosystem.

Once an application is running and the framwork has taken care of most of the bootstrapping, the following modules help to can more detailed spans.

"Implementations" in OpenTracing::Manual::Ecosystem.

A list of various Implementations that are compliant with the OpenTracing API.

"Development and Testing" in OpenTracing::Manual::Ecosystem.

Modules that might be of interest when developping integrations or implementations.

"Planned work" in OpenTracing::Manual::Ecosystem.

The following modules will be needed for easier instrumentation of an application or better framework integration and distributed tracing.

"The Roadmap" in OpenTracing::Manual::Ecosystem.

Since all the work has been done for Peceptyx, no further development will be done on the following, unless ...

SEE ALSO

OpenTracing::Interface

A role that defines the Tracer interface.

OpenTracing::Manual::Instrumentation

For Application developers and Devops.

OpenTracing::Manual::Integration

For Framework or Integration Developers

OpenTracing::Manual::Implementation

For Tracing Service Implementations

OpenTracing::Manual::Ecosystem

An overview of the OpenTracing puzzle pieces.

OpenTracing Overview

The OpenTracing API standard.

AUTHOR

Theo van Hoesel <tvanhoesel@perceptyx.com>

COPYRIGHT AND LICENSE

'OpenTracing API for Perl' is Copyright (C) 2019 .. 2020, Perceptyx Inc

This library is free software; you can redistribute it and/or modify it under the terms of the Artistic License 2.0.

This library is distributed in the hope that it will be useful, but it is provided "as is" and without any express or implied warranties.

For details, see the full text of the license in the file LICENSE.