Documentation

Developers

API References
Data Subject Request API

Data Subject Request API Version 1 and 2

Data Subject Request API Version 3

Platform API

Platform API Overview

Accounts

Apps

Audiences

Calculated Attributes

Data Points

Feeds

Field Transformations

Services

Users

Workspaces

Warehouse Sync API

Warehouse Sync API Overview

Warehouse Sync API Tutorial

Warehouse Sync API Reference

Data Mapping

Warehouse Sync SQL Reference

Warehouse Sync Troubleshooting Guide

ComposeID

Warehouse Sync API v2 Migration

Bulk Profile Deletion API Reference

Calculated Attributes Seeding API

Custom Access Roles API

Data Planning API

Group Identity API Reference

Pixel Service

Profile API

Events API

mParticle JSON Schema Reference

IDSync

Client SDKs
AMP

AMP SDK

Android

Initialization

Configuration

Network Security Configuration

Event Tracking

User Attributes

IDSync

Screen Events

Commerce Events

Location Tracking

Media

Kits

Application State and Session Management

Data Privacy Controls

Error Tracking

Opt Out

Push Notifications

WebView Integration

Logger

Preventing Blocked HTTP Traffic with CNAME

Linting Data Plans

Troubleshooting the Android SDK

API Reference

Upgrade to Version 5

Direct Url Routing

Direct URL Routing FAQ

Web

Android

iOS

Cordova

Cordova Plugin

Identity

iOS

Initialization

Configuration

Event Tracking

User Attributes

IDSync

Screen Tracking

Commerce Events

Location Tracking

Media

Kits

Application State and Session Management

Data Privacy Controls

Error Tracking

Opt Out

Push Notifications

Webview Integration

Upload Frequency

App Extensions

Preventing Blocked HTTP Traffic with CNAME

Linting Data Plans

Troubleshooting iOS SDK

Social Networks

iOS 14 Guide

iOS 15 FAQ

iOS 16 FAQ

iOS 17 FAQ

iOS 18 FAQ

API Reference

Upgrade to Version 7

Flutter

Getting Started

Usage

API Reference

React Native

Getting Started

Identity

Roku

Getting Started

Identity

Media

Xbox

Getting Started

Identity

Unity

Upload Frequency

Getting Started

Opt Out

Initialize the SDK

Event Tracking

Commerce Tracking

Error Tracking

Screen Tracking

Identity

Location Tracking

Session Management

Xamarin

Getting Started

Identity

Web

Initialization

Configuration

Content Security Policy

Event Tracking

User Attributes

IDSync

Page View Tracking

Commerce Events

Location Tracking

Media

Kits

Application State and Session Management

Data Privacy Controls

Error Tracking

Opt Out

Custom Logger

Persistence

Native Web Views

Self-Hosting

Multiple Instances

Web SDK via Google Tag Manager

Preventing Blocked HTTP Traffic with CNAME

Facebook Instant Articles

Troubleshooting the Web SDK

Browser Compatibility

Linting Data Plans

API Reference

Upgrade to Version 2 of the SDK

Web

Alexa

Media SDKs

Android

iOS

Web

Quickstart
Android

Overview

Step 1. Create an input

Step 2. Verify your input

Step 3. Set up your output

Step 4. Create a connection

Step 5. Verify your connection

Step 6. Track events

Step 7. Track user data

Step 8. Create a data plan

Step 9. Test your local app

HTTP Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

iOS Quick Start

Overview

Step 1. Create an input

Step 2. Verify your input

Step 3. Set up your output

Step 4. Create a connection

Step 5. Verify your connection

Step 6. Track events

Step 7. Track user data

Step 8. Create a data plan

Java Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Node Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Python Quick Start

Step 1. Create an input

Step 2. Create an output

Step 3. Verify output

Web

Overview

Step 1. Create an input

Step 2. Verify your input

Step 3. Set up your output

Step 4. Create a connection

Step 5. Verify your connection

Step 6. Track events

Step 7. Track user data

Step 8. Create a data plan

Server SDKs

Node SDK

Go SDK

Python SDK

Ruby SDK

Java SDK

Tools

Linting Tools

Smartype

mParticle Command Line Interface

Guides
Partners

Introduction

Outbound Integrations

Outbound Integrations

Firehose Java SDK

Inbound Integrations

Kit Integrations

Overview

Android Kit Integration

JavaScript Kit Integration

iOS Kit Integration

Compose ID

Data Hosting Locations

Glossary

Migrate from Segment to mParticle

Migrate from Segment to mParticle

Migrate from Segment to Client-side mParticle

Migrate from Segment to Server-side mParticle

Segment-to-mParticle Migration Reference

Rules Developer Guide

API Credential Management

The Developer's Guided Journey to mParticle

Guides

Getting Started

Create an Input

Start capturing data

Connect an Event Output

Create an Audience

Connect an Audience Output

Transform and Enhance Your Data

Platform Guide
The New mParticle Experience

The new mParticle Experience

The Overview Map

Observability

Observability Overview

Observability User Guide

Observability Span Glossary

Introduction

Data Retention

Connections

Activity

Live Stream

Data Filter

Rules

Tiered Events

mParticle Users and Roles

Analytics Free Trial

Troubleshooting mParticle

Usage metering for value-based pricing (VBP)

Analytics

Introduction

Setup

Sync and Activate Analytics User Segments in mParticle

User Segment Activation

Welcome Page Announcements

Settings

Project Settings

Roles and Teammates

Organization Settings

Global Project Filters

Portfolio Analytics

Analytics Data Manager

Analytics Data Manager Overview

Events

Event Properties

User Properties

Revenue Mapping

Export Data

UTM Guide

Query Builder

Data Dictionary

Query Builder Overview

Modify Filters With And/Or Clauses

Query-time Sampling

Query Notes

Filter Where Clauses

Event vs. User Properties

Group By Clauses

Annotations

Cross-tool Compatibility

Apply All for Filter Where Clauses

Date Range and Time Settings Overview

Understanding the Screen View Event

Analyses

Analyses Introduction

Segmentation: Basics

Getting Started

Visualization Options

For Clauses

Date Range and Time Settings

Calculator

Numerical Settings

Segmentation: Advanced

Assisted Analysis

Properties Explorer

Frequency in Segmentation

Trends in Segmentation

Did [not] Perform Clauses

Cumulative vs. Non-Cumulative Analysis in Segmentation

Total Count of vs. Users Who Performed

Save Your Segmentation Analysis

Export Results in Segmentation

Explore Users from Segmentation

Funnels: Basics

Getting Started with Funnels

Group By Settings

Conversion Window

Tracking Properties

Date Range and Time Settings

Visualization Options

Interpreting a Funnel Analysis

Funnels: Advanced

Group By

Filters

Conversion over Time

Conversion Order

Trends

Funnel Direction

Multi-path Funnels

Analyze as Cohort from Funnel

Save a Funnel Analysis

Explore Users from a Funnel

Export Results from a Funnel

Cohorts

Getting Started with Cohorts

Analysis Modes

Save a Cohort Analysis

Export Results

Explore Users

Saved Analyses

Manage Analyses in Dashboards

Users

Getting Started

User Activity Timelines

Time Settings

Export Results

Save A User Analysis

Journeys

Getting Started

Event Menu

Visualization

Ending Event

Save a Journey Analysis

Dashboards

Dashboards––Getting Started

Manage Dashboards

Organize Dashboards

Dashboard Filters

Scheduled Reports

Favorites

Time and Interval Settings in Dashboards

Query Notes in Dashboards

User Aliasing

Analytics Resources

The Demo Environment

Keyboard Shortcuts

Tutorials

Analytics for Marketers

Analytics for Product Managers

Compare Conversion Across Acquisition Sources

Analyze Product Feature Usage

Identify Points of User Friction

Time-based Subscription Analysis

Dashboard Tips and Tricks

Understand Product Stickiness

Optimize User Flow with A/B Testing

User Segments

APIs

User Segments Export API

Dashboard Filter API

IDSync

IDSync Overview

Use Cases for IDSync

Components of IDSync

Store and Organize User Data

Identify Users

Default IDSync Configuration

Profile Conversion Strategy

Profile Link Strategy

Profile Isolation Strategy

Best Match Strategy

Aliasing

Data Master
Group Identity

Overview

Create and Manage Group Definitions

Introduction

Catalog

Live Stream

Data Plans

Data Plans

Blocked Data Backfill Guide

Personalization
Predictive Audiences

Predictive Audiences Overview

Using Predictive Audiences

Predictive Attributes

Predictive Attributes Overview

Create Predictive Attributes

Assess and Troubleshoot Predictions

Use Predictive Attributes in Campaigns

Introduction

Profiles

Calculated Attributes

Calculated Attributes Overview

Using Calculated Attributes

Create with AI Assistance

Calculated Attributes Reference

Audiences

Audiences Overview

Real-time Audiences

Standard Audiences

Journeys

Journeys Overview

Manage Journeys

Download an audience from a journey

Audience A/B testing from a journey

Journeys 2.0

Warehouse Sync

Data Privacy Controls

Data Subject Requests

Default Service Limits

Feeds

Cross-Account Audience Sharing

Approved Sub-Processors

Import Data with CSV Files

Import Data with CSV Files

CSV File Reference

Glossary

Video Index

Analytics (Deprecated)
Settings

Debug Console

Data Warehouse Delay Alerting

Identity Providers

Single Sign-On (SSO)

Setup Examples

Introduction

Developer Docs

Introduction

Integrations

Introduction

Rudderstack

Google Tag Manager

Segment

Data Warehouses and Data Lakes

Advanced Data Warehouse Settings

AWS Kinesis (Snowplow)

AWS Redshift (Define Your Own Schema)

AWS S3 Integration (Define Your Own Schema)

AWS S3 (Snowplow Schema)

BigQuery (Snowplow Schema)

BigQuery Firebase Schema

BigQuery (Define Your Own Schema)

GCP BigQuery Export

Snowplow Schema Overview

Snowflake (Snowplow Schema)

Snowflake (Define Your Own Schema)

APIs

Dashboard Filter API (Deprecated)

REST API

User Segments Export API (Deprecated)

SDKs

SDKs Introduction

React Native

iOS

Android

Java

JavaScript

Python

Object API

Developer Basics

Aliasing

Observability User Guide

The Trace Activity page in the Observability tool is where you can view active traces, search for specific traces, or create new trace configurations for your production environment data.

To learn more about the information that traces that provide, see trace details.

To find the Observability tool in the mParticle UI:

  1. Log in to your mParticle account.
  2. From the Overview page, select Observability within the Oversight suite.
  3. This brings you to the Trace Activity page.

View all trace activity

The Trace Activity page displays a list of all recent traces for your development data, and any traces you have configured for your production data.

To view the details for a specific trace, click the purple ID under the Trace ID column.

Trace status

You can access a trace from Observability as soon as mParticle begins receiving and processing data, but it’s important to note that a trace can’t provide complete information about a data flow until all data in the trace has been fully processed. This typically occurs within 30 minutes.

Traces that are ready to be used for troubleshooting will display a “Complete” Trace Status on the Trace Details Page. Traces for data flows that are still being processed have a Trace Status of “In Progress”.

Sort and filter trace activity

You can filter your results by time frame by clicking the button labeled “Last 12 hours” and selecting one of the predefined date ranges or entering a custom range.

To further sort and filter your results, click Sort and Filters to view the following options:

Sort traces

Use the Order dropdown menu to sort your traces from most recent to oldest, or oldest to most recent.

Filter traces

Under Filters, select any of the following criteria to limit the traces displayed:

  • Trace Type:

    • Event: displays only traces for the Events API
    • Identity: displays only traces for the IDSync API
  • Result:

    • Success: displays only traces where all data was processed without any issues.
    • Insight: includes traces that experienced an interruption in data flow resulting from a configuration setting (such as a Rule or Filter).
    • Needs Attention: displays only traces that include an error message.
    • Warning: includes traces where an issue was encountered during data processing that could be resolved with a retry.
  • Environment:

    • Production: displays only traces for data in your Production environment
    • Development: displays only traces for data in your Development environment
  • mPID: filters results based on the MPID associated with a call to the IDSync API
  • Inputs: filters results based on one of your configured data inputs
  • Outputs: filters results based on one of your configured data outputs

After selecting your desired sorting and filter options, click Apply. This refreshes the Trace Activity page to display only filters matching your selected criteria.

Trace details

After opening the details page for a specific trace, you will see the following information:

Trace summary

  • Trace ID: the unique ID for the trace.
  • Trace Configuration ID: the ID of the trace configuration that the trace belongs to.
  • mParticle ID: any MPID that is associated with the trace.
  • Trace Status: either “In Progress” or “Complete”. The trace status indicates whether a trace contains enough information for it to be useful when troubleshooting your data flow. Traces that are “In Progress” indicate that the data being traced is still being processed. For more information, see Trace status.
  • Trace Start Time: the date and time (in UTC) when the data was initially received by the mParticle platform.
  • Duration: the total time elapsed during the trace.

Setup details

  • Inputs: the name of the input configuration where the data originated.
  • Output Configurations: the configured outputs for the data.
  • Data plans: any active data plans that were used during processing.
  • Environment: indicates whether the data flowed through your development or production environment.

Trace result

For each trace, you will see either Success, Insight, Needs Attention, or Warning displayed under “Result” along with any applicable messages under “Additional information”. You can use this information to determine whether an issue encountered during the trace was intentional or accidental, and what steps you may need to take to resolve any issues.

Message Description
Success Your data was ingested, processed, and forwarded without encountering any issues.
Insight Your data flow was interrupted due to a configuration setting (such as a Rule or Filter). These interruptions may or may not be intentional, depending on your configuration and desired behavior. Referring to any insights can be helpful in identifying unintended consequences of a configuration setting.
Warning Indicates that an issue was encountered during data processing that could be resolved with a retry.
Needs Attention An error was encountered during the trace that cannot be resolved with a retry.

In some cases, you might see additional information with instructions to contact mParticle Support or your mParticle Account Representative, who can help you determine the root cause of an error or issue.

It’s possible for one process to trigger other related processes in the mParticle platform. Any related processes that are traced will be listed here.

For example, when mParticle ingests a batch of event data or a request to make a bulk update to your data, each subsequent data flow will have its own unique trace, which you can find and access here.

Timeline view

The Timeline View provides a visual picture of how your data flows through the mParticle platform, broken into different spans, with each span representing a different stage of data processing.

Hover your cursor over the span in the timeline to see its exact start and end times.

To view details for a specific span, click on the span within the timeline and review the information panel at the bottom of the UI.

Not all spans will be presented sequentially, and some will appear to occur at the same time.

This is because mParticle executes different processes in parallel, to reduce the amount of time it takes to process your data. Most gaps between spans on your timeline are likely due to networking delays or internal processes that are not traced.

Span details

The Span Details view provides more granular information about a particular span. The details shown will vary depending on the span category.

To learn more about each span category, view the Span Glossary.

About trace IDs

Each individual trace is uniquely identified by a 36 character Trace ID resembling 66e0c0cd9bb8998a579595e42bae7077.

Trace IDs are essential for pinpointing specific data processing traces. You can find them in two primary ways:

1) Find a trace ID in an API response

Trace IDs are included with all responses to calls to the Events and IDSync APIs.

To find a trace ID in an API response:

  1. Search your API response for the header titled X-MP-Trace-Id. The value of this header is the trace ID for the corresponding API call.

2) Find a trace ID in Live Stream

  1. Log into your mParticle account and navigate to Activity > Live Stream.
  2. Select any event row.
  3. In the right hand sidebar, you will find the trace ID associated with that event.

Search for a trace using a trace ID

To search for a specific trace on the Trace Activity page:

  1. Find and copy the trace ID from an API response or Live Stream as described in About trace IDs.
  2. Log into your mParticle account and navigate to Oversight > Observability.
  3. From the Trace Activity page, enter your trace ID in the search bar and click Search.

Open a trace from Live Stream

You can also view trace details for a data flow directly from the mParticle Live Stream.

  1. Log into your mParticle account and navigate to Activity > Live Stream.
  2. Select the event row you want to view the trace for.
  3. In the right hand side bar, you will find the trace ID associated with that event.
  4. Click on the Trace ID to open up the Trace Details page in the Observability suite.

Create a trace configuration

Trace configurations define the criteria for what production data you want traced.

To begin tracing data in your production environment, create a new trace configuration:

  1. Navigate to Observability > Trace Configurations, and click Create Trace Configuration.

    This opens the Add Tracing Configuration window:

  2. Under Inputs, select the connected data input you want to trace.
  3. Use the date and time picker to select the Start Date & Time and Duration for your trace. Traces will only be generated after the start time and for the duration you specify.
  4. Click Submit.

After clicking Submit, you will see your new tracing configuration listed on the Trace Configurations page, along with some general information about the trace configuration and one of the following statuses:

Active: traces are actively being generated for data ingested from the configured input. Pending: the start time set for the trace configuration is in the future. Once the scheduled start time is reached, the status will change to Active. Completed: the scheduled duration for the trace has elapsed and data is no longer being traced. Canceled: you have canceled the trace configuration

Was this page helpful?

    Last Updated: November 27, 2024