Wavefront supports a suite of open source SDKs that developers can use to instrument applications for observability. The instrumented application collects and sends metrics, histograms, and/or trace data to Wavefront for storage and visualization. The SDKs are available for most popular programming languages, and are available in GitHub.
Watch this video to listen to our co-founder Clement Pang talk about how Wavefront expands application monitoring with its observability SDKs:
What Do You Want to Collect?
Wavefront observability SDKs let you instrument your application to collect and send different kinds of observability data. For the most gain with the least amount of work:
- Start with Wavefront SDKs for instrumenting frameworks, if your application uses any of the supported frameworks.
- Introduce other Wavefront SDKs to augment areas of your code that are not be handled by a supported framework.
|SDK Type||SDK Description||Supported Languages|
|OpenTracing SDK||Implements the OpenTracing specification. Lets you define, collect, and report custom trace data from any part of your application code.
Automatically derives RED metrics from the reported spans.
|Metrics SDK||Implements a standard metrics library. Lets you define, collect, and report custom business metrics and histograms from any part of your application code.|
|Framework SDK||Reports predefined traces, metrics, and histograms from the APIs of a supported app framework. Lets you get started quickly with minimal code changes.|
|Sender SDK||Lets you send raw values to Wavefront for storage as metrics, histograms, or traces, e.g., to import CSV data into Wavefront.|
SDKs For Collecting Trace Data
Wavefront provides SDKs that implement the OpenTracing specification for creating, sampling, and reporting spans and traces. You use these SDKs to instrument critical areas in your code to send custom trace data to Wavefront:
- You can use a Wavefront OpenTracing SDK alone, to instrument an entire application.
- You can use a Wavefront OpenTracing SDK along with a framework SDK, to instrument any functions that are not handled by the instrumented framework.
Wavefront provides OpenTracing SDKs for:
A Wavefront OpenTracing SDK derives RED metrics from the spans that are sent from the instrumented application. These RED metrics show the request Rate, Errors, and Duration that are obtained from the reported spans. These out-of-the-box metrics are derived from your spans automatically, with no additional configuration or instrumentation on your part. You can view the RED metrics for each service’s operations in predefined charts.
Sample use cases:
Suppose your application is already instrumented with a 3rd party distributed tracing system. If that 3rd party system is OpenTracing-compliant, you can replace it with the Wavefront OpenTracing SDK in the same language.
Suppose you have a microservice with a critical backend operation that writes to a proprietary database. Even though you’ve used a framework-specific SDK to instrument the RESTful APIs of the microservice, you’d like to see if anything is holding up the database write operation. You can use an OpenTracing SDK to instrument the operation so that it adds spans to the microservice’s traces.
SDKs For Collecting Metrics and Histograms
Wavefront provides SDKs that implement standard metrics libraries in popular programming languages. You use these SDKs to instrument critical areas in your code, to collect and send custom business metrics and histograms to Wavefront:
- You can use a metrics SDK alone, to instrument an entire application to report the metrics of your choice.
- You can use a metrics SDK and a framework SDK to instrument any functions that are not handled by the instrumented framework.
Wavefront provides metrics SDKs for Java, .Net/C#, and Python:
Different metrics SDKs provide different capabilities:
- Some SDKs let you instrument functions with (cumulative) counters, delta counters, meters, gauges, timers, and histograms. These SDKs require some code changes beyond setting up helper objects. In particular, you’ll need to instantiate objects for each type of metric you want to collect, and modify each function of interest.
- Some SDKs automatically collect and report metrics and histograms from your application’s runtime system. The specific metrics depend on the programming language.
Sample use case:
- Suppose you have a microservice with a critical backend operation that writes to a proprietary database. Even though you’ve used a framework-specific SDK to instrument the RESTful APIs, you’d also like to track how many database writes are performed. You can use a metrics SDK to instrument the write operation with a counter.
SDKs That Instrument Frameworks
Most cloud-based applications consist of microservices that are built with component frameworks for managing inbound requests and outbound responses. Wavefront provides SDKs that instrument the APIs of many common microservices frameworks. If your application is built with a supported framework, you can use the corresponding Wavefront SDK to collect telemetry data from the framework’s APIs, with minimal code changes.
Wavefront provides SDKs that instrument the Java and .Net/C# Frameworks:
A framework SDK gets you up and running with minimal effort:
- Setup is simple. You either edit a configuration file or instantiate a few helper objects in your code. No further coding is required.
- The SDK automatically defines the metrics, histograms, and trace data to be collected. You simply run the recompiled application to start the flow of telemetry data to Wavefront.
- Wavefront provides predefined charts and dashboards to help you visualize and drill down through the telemetry data.
Sample use case:
- Suppose you have a Java microservice that uses a Jersey-compatible framework for building RESTful web services. After you instrument your microservice with the Wavefront SDK for Jersey, your application collects predefined metrics, histograms, and trace data from the Jersey-compatible framework and sends the data to Wavefront. You can then use the following charts to view RED metrics, which measure the microservice’s request Rate, number of Errors, and Duration. (SDKs for other frameworks might collect latencies, payload sizes, runtime information, and so on.)
SDKs for Sending Raw Data to Wavefront
Some Wavefront SDKs enable you to send raw values to Wavefront for ingestion as metrics, histograms, or trace data. You normally use these “sender” SDKs indirectly when you use other Wavefront SDKs that depend on them. However, you might use a sender SDK directly, for example, to create a utility that obtains existing values from a data store or CSV file, and sends those values to Wavefront.
Wavefront provides sender SDKs for:
A sender SDK is built into each of the other observability SDKs to enable applications to communicate with Wavefront in one of two ways:
- Send data directly to the Wavefront service (direct ingestion). This technique gets you up and running with minimal preparation, but is best suited for small-scale uses.
- Send data to a Wavefront proxy, which then forwards the data to the Wavefront service. This technique is recommended for large-scale deployments, because the proxy provides resilience to internet outages, control over data queuing and filtering, and more.