Docs » µAPM Getting Started

µAPM Getting Started 🔗

Important

The original µAPM product, released in 2019, is now called µAPM Previous Generation (µAPM PG). In the documentation, µAPM now refers to the product released on March 31, 2020.

If you are using µAPM Previous Generation (µAPM PG), see µAPM PG Getting Started.

Our recommended best practice is for you to deploy the SignalFx Smart Agent on each instance that will host an instrumented application. The Smart Agent provides host attributes on spans and also supports infrastructure correlation with SignalFx Infrastructure Monitoring service. In addition, it offloads responsibilities from the instrumentation including buffering and retry logic.

Next, use our auto-instrumentation libraries to configure your applications, so that all trace spans will be reported to the local Smart Agent using Zipkin’s B3 context propagation format. The Smart Agent will send traces directly to the µAPM ingest endpoint.

Optionally, you can configure the Smart Agent to send trace information to the OpenTelemetry Collector. The OpenTelemetry Collector provides cluster attributes on spans and also supports pre-processing spans, for example, to redact attributes before sending them to SignalFx. You may also choose to configure the Smart Agent to send directly to the µAPM ingest endpoint.

The Smart Agent and OpenTelemetry Collector are available as statically linked x86_64 ELF (Linux) binaries and therefore have no library dependencies. For ease of deployment and orchestration, they are also available as Docker container images.

To summarize, the recommended best practice for getting started with µAPM are as follows:

  1. Install the Smart Agent on each instance that will host an instrumented application.

  2. Instrument your applications based on your language.

    Note

    If you have already instrumented your application with a supported open-source span format, then all you need to do is point it to a local SignalFx Smart Agent. However, we do recommend you use Zipkin’s B3 context propagation format.

  3. Optionally deploy the OpenTelemetry Collector.

Once you have completed the instrumentation and data collection tasks, your traces will show up in the SignalFx UI. For information about working with the µAPM screens and dashboards, see µAPM Example: Finding the Root Cause of a Problem.