Skip to content

Latest commit

 

History

History
94 lines (70 loc) · 4 KB

README.md

File metadata and controls

94 lines (70 loc) · 4 KB

SignalFx Distributed Tracing Instrumentation

Instrumentation Agnostic

SignalFx Distributed Tracing intends to be instrumentation agnostic; supporting & ingesting variety of popular open instrumentation libraries including OpenTracing, Zipkin & OpenCensus. So long as the tracer configured to send spans to SignalFx ingest endpoint uses the Zipkin v1/2 JSON wire format or Jaeger Thrift format, we will accept spans irrespective of how they were instrumented - via one of the above mentioned open libraries or a homegrown one. Our goal is to build on the shoulders of giant communities rather than re-invent the wheel with proprietary libraries/agents and give customers choice to decide what works for them without worrying about vendor lock-in.

OpenTracing    Jaeger Tracing    ZipKin    OpenCensus

For customers who have not yet instrumented their code, our default recommendation is to use OpenTracing to instrument since it has a growing ecosystem of library owners & frameworks instrumenting their code with it & use Jaeger tracer libraries to export spans to us - both of these are CNCF projects with a rapidly growing community behind them.

How should I go about instrumenting my application for distributed tracing?

RPC layer(s) and service/web framework(s) are the best places to start when thinking about how to go about instrumentating your application - both of these will likely have a large coverage area and touch a significant number of transaction paths to give you baseline tracing coverage and visualize an end-to-end trace with a service-map.

Next you should identify services critical to your business and look for areas not covered by rpc or service/web frameworks. Within these services, identify high value transactions and critical paths - instrument enough of these.

Examples

This repository contains a set of simple example applications that demonstrate using SignalFx with various open source tracers. They are broken down by language/platform.

Java

Python

Go

  • Jaeger Go: our recommended tracer for Golang.

NodeJS

  • Jaeger Node
  • Zipkin JS Tracer: Zipkin's instrumentation library for Javascript (currently supports a broader range of instrumentations than the Jaeger Node tracer and supports running in a browser).

Service Meshes

  • Istio: use the SignalFx mixer adapter to automatically send metrics and trace spans for inter-container traffic.
  • Envoy: the Envoy proxy can be configured to report trace spans to SignalFx.