Docs » Get started with SignalFx µAPM » First steps to set up SignalFx µAPM

First steps to set up SignalFx µAPM 🔗

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.

Configure your environment for µAPM and instrument applications to export trace data to SignalFx. Use trace data to analyze application performance, alert on metrics for trace data, and correlate trace data with logs and other resources.

These steps provide more information about exporting trace data to SignalFx and analyzing application performance with µAPM.

1. Prepare your environment 🔗

Deploy the Smart Agent in each instance that hosts an application you want to instrument. Use the Smart Agent to include additional context in trace data and enable infrastructure correlation. Add context to trace data by including tags for individual spans in a trace. You can search for and break down performance by these span tags.

Configure the Smart Agent to send trace data directly to a SignalFx ingest endpoint or to an OpenTelemetry Collector. If you deploy an OpenTelemetry Collector, you can centrally manage trace context from multiple Smart Agents by including span tags, modify or obfuscate trace data attributes, and monitor trace data network volume.

To learn about µAPM deployment architectures, see SignalFx µAPM architecture overview.

To configure the Smart Agent for µAPM, see Deploy a SignalFx Smart Agent for µAPM.

To configure an OpenTelemetry Collector for µAPM, see Deploy an OpenTelemetry Collector for SignalFx µAPM.

2. Instrument applications 🔗

Use a SignalFx tracing library to automatically instrument code and deploy an OpenTracing-compatible tracer to capture and report trace data. You can automatically instrument many popular libraries and frameworks for these languages:

You can also manually instrument code and deploy an OpenTracing-compatible tracer to capture and report trace spans. For more information, see the OpenTracing API on GitHub.

µAPM also supports receiving traces from these sources:

3. Break down service performance by indexing span tags 🔗

Index span tags to generate custom request, error, and duration (RED) metrics for services. RED metrics for indexed span tags are known as Troubleshooting MetricSets. Indexing span tags to generate Troubleshooting MetricSets enables you to analyze service performance by specific characteristics and attributes of each service.

For more information, see Drill down into service performance with indexed tags and MetricSets in SignalFx µAPM.

4. Create detectors to alert on application performance 🔗

Configure detectors to alert on service metrics with µAPM Metrics Alert Rules. Detectors help keep you aware of performance degradation or other issues with specific services. Alert on latency or error rate for specific endpoints associated with a service. Detectors can include runbooks or tips for recipients to act on.

For more information, see Configure detectors and alerts in SignalFx µAPM.

For an example that shows you how to identify root causes with µAPM, see Find the root cause of a problem with SignalFx µAPM.

5. Correlate trace data with logs and other resources 🔗

Use global data links to associate µAPM services, traces, and spans with SignalFx dashboards, logging tools, and custom URLs.

For more information, see Connect SignalFx µAPM to logs and other resources.