> ## 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. # Deploying GermainUX Monitoring for MuleSoft: A Step-by-Step Guide > This approach lets MuleSoft flows send request status, failures, response times, and other integration telemetry to GermainUX for analytics and alerting. Components [`Engine`](/main/germain-ux-engine) [`JS Profiler`](/main/germain-ux-js-profiler) [`RPA Bot Recorder`](/main/germain-ux-rpa-bot-recorder) [`RUM JS`](/main/germain-ux-rum-js) Availability 2017.1 or later > **[Deployment Architecture](#deployment-architecture)** > > How telemetry reaches GermainUX > **[Obtain the GermainUX Data Ingestion Endpoint](#3-obtain-the-germainux-data-ingestion-endpoint)** > > Find your ingestion URL > **[Capture Failure Information](#6-capture-failure-information)** > > Send error context only > **[Review Data Privacy](#review-data-privacy)** > > Limit payload data sent **Deploy Monitoring for MuleSoft** > [!NOTE] > > Deploy GermainUX monitoring for MuleSoft by sending API and integration telemetry from MuleSoft to the **GermainUX Data Ingestion APIs**. ## Overview This approach allows MuleSoft flows to send operational information such as request status, failures, response times, and other integration-specific telemetry to GermainUX for real-time analytics and alerting. ## Deployment Architecture A typical deployment follows this flow: Application MuleSoft Flow GermainUX Data Ingestion API GermainUX Analytics / Alerts MuleSoft continues to execute the integration workflow while relevant operational telemetry is transmitted to GermainUX. ## 1. Identify the MuleSoft APIs & Flows to Monitor Determine which MuleSoft APIs or integration flows require monitoring. Focus on integrations that are important to: * Application availability * Critical business workflows * Data exchange * Customer-facing transactions * Internal operational processes For each flow, identify the telemetry that should be sent to GermainUX. ## 2. Determine the Telemetry to Send Typical MuleSoft telemetry can include: * API name * Integration or flow name * Request status * Success / failure status * HTTP response code * Response time > **Show all 10** > > * Error details > * Request volume > * Throughput > * Application-specific context Send only the data required for the monitoring and analytics use case. ## 3. Obtain the GermainUX Data Ingestion Endpoint Identify the GermainUX Data Ingestion API endpoint for your environment. The MuleSoft runtime must be able to communicate with the GermainUX ingestion endpoint. Use **HTTPS** for production communication. ## 4. Configure Authentication Configure the authentication required by the GermainUX Data Ingestion API. Store credentials securely within the MuleSoft environment using the approved secret or credential-management mechanism. Do not hard-code production credentials directly into MuleSoft flows. ![Deploying GermainUX Monitoring for MuleSoft: A Step-by-Step Guide: 4. Configure Authentication](https://mintcdn.com/germain-ux/hPK2RwO7wyn44bNw/images/main/deploying-germainux-monitoring-for-mulesoft-a-step-by-step-guide/mulesoft2.png?fit=max\&auto=format\&n=hPK2RwO7wyn44bNw\&q=85\&s=669e0ccfd7fb29708dc15b08ec8bb4bb) ## 5. Add GermainUX Ingestion to the MuleSoft Flow In **MuleSoft Anypoint Studio**, add the appropriate logic to send monitoring telemetry to GermainUX. A typical flow can send telemetry after processing an API request or integration transaction. For example: Receive API Request Execute Integration Determine Status Send Telemetry to GermainUX Continue / Complete Flow Send monitoring information for both successful and failed processing where operational visibility is required. ![Deploying GermainUX Monitoring for MuleSoft: A Step-by-Step Guide: 5. Add GermainUX Ingestion to the MuleSoft Flow](https://mintcdn.com/germain-ux/hPK2RwO7wyn44bNw/images/main/deploying-germainux-monitoring-for-mulesoft-a-step-by-step-guide/mulesoft.png?fit=max\&auto=format\&n=hPK2RwO7wyn44bNw\&q=85\&s=c72fd94df98ae88bbade2f3b919b6c3e) ## 6. Capture Failure Information Configure the MuleSoft flow to send relevant error information when processing fails. Depending on the integration, this can include: * Error type * Error message * HTTP response code * Failed flow or operation * Response time * Downstream service * Application-specific context Avoid sending sensitive payload content unless it is specifically required and approved. ## 7. Validate Data Ingestion Execute representative MuleSoft transactions. Test both: * Successful requests * Failed requests Verify in GermainUX that: * Telemetry is received * Events are associated with the correct API or integration * Status values are correct * Response times are captured where configured * Error details are available when failures occur * Data appears in the expected analytics ## 8. Validate Production Behavior Before broad production deployment, validate: * Connectivity to the GermainUX ingestion endpoint * Authentication * Failure handling * Retry behavior * Monitoring overhead * Data volume * Sensitive-data exclusions The monitoring integration should not interfere with the primary MuleSoft business transaction. ## Review Data Privacy Review all telemetry sent from MuleSoft to GermainUX. Do not send unnecessary: * Authentication credentials * Tokens * Personal information * Payment information * Sensitive business data * Full request or response payloads Send only the operational context required for monitoring and troubleshooting. ## Next Steps Once MuleSoft telemetry is successfully ingested into GermainUX: **1. Configure the monitored facts and dimensions** **2. Configure KPIs** **3. Create dashboards and reports** **4. Configure SLAs and alerts** **5. Configure automation where appropriate** See **Configure Monitoring for MuleSoft** for configuration instructions. ## Get More Information The exact deployment depends on the MuleSoft APIs, flows, telemetry, security requirements, and GermainUX ingestion configuration used in your environment. The GermainUX team can help determine the appropriate ingestion architecture and monitoring scope. Please contact us [for any help.](/main/support.md) ## Get Help > **[Contact GermainUX Support](/main/support.md)** > > The Germain Team can help you set this up. > **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.