> ## Documentation Index
> Fetch the complete documentation index at: https://docs.germainux.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Stats Monitoring for Salesforce Cloud (Configure)

> GermainUX uses the Salesforce REST API to collect operational, performance, usage, and configuration statistics.

Components
[`Engine`](https://docs.germainux.com/main/germain-ux-engine)
[`Mobile App`](https://docs.germainux.com/main/germain-ux-mobile-app)
[`RUM Ext`](https://docs.germainux.com/main/germain-ux-rum-extension)
[`RUM JS`](https://docs.germainux.com/main/germain-ux-rum-js)

Availability
2017.1 or later

> [card] [Collected Statistics](#collected-statistics)
>
> Default statistics and extra queries

> [card] [Configure the Monitoring Frequency](#configure-the-monitoring-frequency)
>
> Hourly collection by default

> [card] [Add a Statistics Query](#add-a-statistics-query)
>
> Custom org-specific REST metrics

> [card] [Examples](#examples)
>
> Sample statistics configurations

## Overview

GermainUX uses the Salesforce REST API to collect operational, performance, usage, and configuration statistics. These metrics help teams monitor Salesforce activity, identify trends, detect abnormal behavior, and investigate performance or adoption issues.

## Collected Statistics

By default, GermainUX collects statistics for:

| Category | Statistics |
| - | - |
| Apex and automation | Apex actions, Flow custom actions, external-service actions, scheduled jobs, and Flow interviews |
| Lightning performance | Navigation performance by browser and page |
| Lightning adoption | User sessions and switches between Lightning Experience and Salesforce Classic |
| Processes | Approval processes and workflow rules |
| Salesforce data | Record counts |

Additional REST API queries can be configured to collect organization-specific Salesforce metrics.

## Enable Monitoring

Salesforce statistics monitoring is enabled during the initial Salesforce deployment:

**1. Open Germain Workspace**

**2. Start the Salesforce Application wizard**

**3. Configure and complete the Salesforce monitoring deployment**

## Configure the Monitoring Frequency

By default, GermainUX collects Salesforce statistics once per hour.

### During the Initial Deployment

1. Open the **Salesforce Application** wizard.
2. Click **Show Advanced**.
3. Set the **Stats Monitoring Interval**.
4. Complete the deployment.

   ![Salesforce Stats Monitoring settings](https://mintcdn.com/germain-ux/BTxCucYnGj_ffpsA/images/main/salesforce-stats-monitoring/image-20230330-110153.png?fit=max\&auto=format\&n=BTxCucYnGj_ffpsA\&q=85\&s=beb7359efa921c77af5afba9e3656a70)

### After Deployment

To change the execution frequency of an existing monitor:

**1. Open Germain Workspace**

**2. From the left menu, go to Germain**

**3. Select the State tab**

**4. Search for components with the type name Salesforce Stats Monitor**

**5. Select the component you want to update**

**6. Modify its Execution Schedule**

**7. Save the configuration**

![Execution Schedule configuration for SFDC Instance Status component](https://mintcdn.com/germain-ux/BTxCucYnGj_ffpsA/images/main/salesforce-stats-monitoring/image-20230329-120617.png?fit=max\&auto=format\&n=BTxCucYnGj_ffpsA\&q=85\&s=62fd5dc10969956f57c47b3df375b5c4)

## Disable Monitoring

To stop collecting all Salesforce statistics:

**1. Open Germain Workspace**

**2. From the left menu, go to Germain**

**3. Select the State tab**

**4. Search for components with the type name Salesforce Stats Monitor**

**5. Disable the applicable component using the toggle in the Enabled column**

## Disable an Individual Statistics Query

Individual REST API queries can be disabled without stopping the entire Salesforce Stats Monitor:

**1. Open Germain Workspace**

**2. From the left menu, go to System → Engine → Component Types**

**3. Search for the component type named Salesforce Stats Monitoring**

**4. Locate the query under Scenario Targets**

**5. Disable the query using its toggle**

**6. Save the configuration**

![Stats Monitoring for Salesforce Cloud (Configure): Disable an Individual Statistics Query](https://mintcdn.com/germain-ux/BTxCucYnGj_ffpsA/images/main/salesforce-stats-monitoring/image-20230330-110821.png?fit=max\&auto=format\&n=BTxCucYnGj_ffpsA\&q=85\&s=3e2b9fd5829f3217d45d99506d1a7ccc)

## Add a Statistics Query

Additional Salesforce REST API queries can be added to collect metrics specific to your organization.

Contact the GermainUX team for assistance configuring a new statistics query.

## Analyze the Collected Data

### KPIs

Use the configured **Salesforce Stats KPIs** to monitor collected statistics, establish baselines, detect deviations, and trigger alerts or automated actions.

### Dashboard

Navigate to:

Germain Workspace
Dashboards
All
Salesforce Stats

The dashboard provides an aggregated view of the collected Salesforce statistics and supports drill-through analysis.

## Examples

The existing examples should remain on the page:

| Example | Details |
| - | - |
| **Apex Class and Trigger Monitoring** |  ![Apex Class and Trigger Monitoring](https://mintcdn.com/germain-ux/BTxCucYnGj_ffpsA/images/main/salesforce-stats-monitoring/image-20230330-102410.png?fit=max\&auto=format\&n=BTxCucYnGj_ffpsA\&q=85\&s=bfc1cf4fa4c3cfdc7fbe4123135287a1) |
| **Apex Class Details in the Analysis Dashboard** |  ![Apex Class Content on RCA](https://mintcdn.com/germain-ux/BTxCucYnGj_ffpsA/images/main/salesforce-stats-monitoring/image-20230330-102518.png?fit=max\&auto=format\&n=BTxCucYnGj_ffpsA\&q=85\&s=cd4f4e7adcf935a630c1f36e7044802f) |

## Related Documentation

> [card] [Dashboard & Reports](https://docs.germainux.com/main/dashboard-and-report.md)
>
> Dashboard & Reports

> [card] [AI](https://docs.germainux.com/main/ai-driven-insights.md)
>
> Insights & Recommendations

> [card] [Analytics](https://docs.germainux.com/main/analytics.md)
>
> More Analytics Features

> [card] [Automation](https://docs.germainux.com/main/automation.md)
>
> More Automation Features

## Get Help

> [card] [Contact GermainUX Support](https://docs.germainux.com/main/support.md)
>
> The GermainUX team helps you get up and running faster, empower your team, turn data into actionable insights, and optimize performance to deliver measurable business outcomes.

> [card] Can't find what you need?
>
> Search all GermainUX docs with **Ctrl + K**, or use the feedback buttons at the bottom of this page to tell us what is missing.

The content of this document is proprietary to GERMAIN SOFTWARE.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.