APIs for User Monitoring and Replay

GermainUX RUM JS provides JavaScript APIs that let developers control Real User Monitoring and create custom data points for application-specific actions, metrics, transactions, and logs.

The APIs are organized into two categories:

⚙️ Monitoring Control API

⏯️ Start Monitoring

User Monitoring normally starts automatically after germainapm.js is downloaded and initialized on the monitored application.

Use start() when monitoring was previously stopped or when your application needs to start it programmatically.

germainApm.start(
    settings: MonitoringSettings,
    onAllTabs?: boolean
): void;

🛑 Stop Monitoring

Use stop() to remove the active monitoring instrumentation from the application.

This method:

germainApm.stop(onAllTabs?: boolean): void;

🗑️ Uninstall Monitoring

Use uninstall() to stop monitoring, flush data available in the browser cache, and optionally remove the stored monitoring state.

Internally, this method calls germainApm.stop(onAllTabs).

germainApm.uninstall(
    clearSessionState?: boolean,
    onAllTabs?: boolean
): void;

A custom logout handler should use:

germainApm.uninstall(true, true);

Monitoring can start again after a full server-side page load, hard navigation, or browser refresh.

👥 Custom Data API

The Custom Data API lets developers capture application-specific behavior that GermainUX does not collect automatically.

You can create:

✨ Create an Event

Use createEvent() to record a custom UX event.

germainApm.api.createEvent(
    name: string,
    details?: Record<string, any>
): void;

Example:

germainApm.api.createEvent('Product Added to Wishlist', {
    productId: 'SKU-123',
    category: 'Shoes'
});

This creates a data point under the Browser Event KPI.

📏 Create a Metric

Use createMetric() to record a custom numeric measurement.

germainApm.api.createMetric(
    name: string,
    value: number,
    details?: Record<string, any>
): void;

Example:

germainApm.api.createMetric('Search Result Count', 12, {
    searchTerm: 'running shoes'
});

This creates a data point under the Browser Metric KPI.

⏱️ Create a Transaction

Use custom transactions to measure the duration of an application action or business operation.

GermainUX supports two methods:

• Provide a known duration.

• Calculate the duration between start and end markers.

🔖 Create a Transaction with a Known Duration

germainApm.api.createTransaction(
    name: string,
    duration: number,
    details?: Record<string, any>
): void;

Example:

germainApm.api.createTransaction('Quote Generated', 2.45, {
    quoteId: 'Q-18425'
});

🔁 Calculate a Transaction Duration

Call startTransaction() when the operation begins:

germainApm.api.startTransaction(
    name: string,
    details?: Record<string, any>
): void;

Call endTransaction() when it finishes:

germainApm.api.endTransaction(
    name: string,
    details?: Record<string, any>
): void;

Example:

germainApm.api.startTransaction('login-txn');

// Application login operation

germainApm.api.endTransaction('login-txn');

The completed duration is recorded under the Browser Transaction KPI.

📄 Create a Log

Use germainApm.log() to add a custom internal monitoring log.

germainApm.log(
    level: 'TRACE' | 'INFO' | 'WARN' | 'ERROR' | 'NONE',
    message: string,
    obj?: Object
): void;

Logs can be accessed through:

germainApm.rootWindow.state.debugLog

To collect logs as GermainUX data points, configure the following properties in the Monitoring Profile’s Init Script:

Collected logs are available under the Germain Agent Debug KPI.

🐛 Log a Caught Exception

try {
    // Application logic
} catch (ex) {
    germainApm.log('ERROR', 'Function ABC failed.', ex);
}

🔍 Create a Trace Log

germainApm.log('TRACE', 'My trace information', {
    timestamp: Date.now(),
    details: 'Additional context'
});