Configure Monitoring for SOAP

⚙️ Configuring SOAP Monitoring with GermainUX: Steps and Best Practices

Configure GermainUX to periodically execute a SOAP request, validate the response, measure performance, and detect availability or functional issues.

⚙️ 1. Create a SOAP Monitor

Sign in to GermainUX Workspace.

Go to:

Germain Workspace > Left Menu > Wizards

Open the HTTP, web-service, or SOAP monitoring wizard available in your GermainUX version.

Workspace labels and the exact wizard name may vary by GermainUX version and component type.

Create a new monitoring component.

💻 2. Select the Engine

Select the GermainUX node and Engine that will execute the SOAP request.

Choose an Engine that:

📍 3. Configure the Endpoint

Enter the SOAP service endpoint.

For example:

https://service.example.com/OrderService

Select the HTTP method required by the SOAP service.

For most SOAP operations:

POST

Use the exact endpoint specified by the service or WSDL.

📄 4. Configure SOAP Version and Headers

Configure the HTTP and SOAP headers required by the service.

Depending on the service, these can include:

📃 SOAP 1.1

SOAP 1.1 commonly uses:

Content-Type: text/xml

and may require:

SOAPAction

📃 SOAP 1.2

SOAP 1.2 commonly uses:

Content-Type: application/soap+xml

Always use the values required by the monitored service.

📝 5. Configure the SOAP Request

Enter the XML request body required for the operation.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:svc="http://example.com/service">
    <soapenv:Header/>
    <soapenv:Body>
        <svc:GetServiceStatus>
            <svc:ServiceName>OrderService</svc:ServiceName>
        </svc:GetServiceStatus>
    </soapenv:Body>
</soapenv:Envelope>

Configure the appropriate:

Use a request that is safe to execute repeatedly.

🔒 6. Configure Authentication

Select the authentication configuration required by the service.

Depending on the service and GermainUX version, supported connection settings can include:

Sensitive credentials and tokens should use GermainUX authentication settings instead of being embedded directly in the SOAP envelope whenever supported.

🛡️ 7. Configure Proxy and Certificates

If the SOAP service is accessible through a proxy, configure the required proxy settings.

If mutual TLS or another client-certificate mechanism is required, configure the appropriate certificate.

Verify certificate expiration and trust configuration before enabling the monitor.

⏰ 8. Configure Timeout

Define how long GermainUX should wait for the SOAP transaction to complete.

The timeout should be long enough for normal service behavior while still allowing GermainUX to identify abnormal response times.

A timeout can indicate:

✅ 9. Configure HTTP Response Validation

Define the HTTP status expected from a successful request.

For example:

200

Do not rely exclusively on the HTTP status to determine whether the SOAP operation succeeded.

A SOAP service can return an HTTP response while the actual business operation has failed.

🔍 10. Configure SOAP Response Validation

Configure conditions that determine whether the returned SOAP response is valid.

Validation can include:

For example, GermainUX can verify that:

Expected

<status>SUCCESS</status>

is present.

And that:

Unexpected

<soap:Fault>

is not present.

The validation should represent the actual functional success of the monitored operation.

11. Configure SOAP Fault Detection

Configure the monitor to identify SOAP Fault responses.

SOAP Faults can indicate:

Capture the available fault information as diagnostic evidence when appropriate and permitted.

📊 12. Select the KPI

Select the KPI used to store the monitoring result.

Depending on your GermainUX configuration, SOAP monitoring can populate KPIs such as:

Configure the KPI appropriate for the monitoring objective.

🔁 13. Configure Monitoring Frequency

Define how frequently the SOAP request should execute.

The appropriate interval depends on:

For example:

Every 5 minutes

GermainUX executes the SOAP request every five minutes and evaluates the result.

Critical services may require more frequent monitoring.

Avoid an execution frequency that creates unnecessary load on the monitored service.

🧮 14. Configure Measures

SOAP monitoring measures can include:

These measures can be used for dashboards, reports, SLAs, rules, and historical analysis.

🧭 15. Configure Pivots

Analyze SOAP monitoring results using dimensions such as:

This enables teams to compare SOAP behavior across services and environments.

🏆 16. Configure SLAs

Configure SLAs for conditions requiring attention.

Examples include:

Availability

SOAP Service Availability < 99.9%

Response Time

Response Time > 2 seconds

Failure

SOAP Request = Failed

SOAP Fault

SOAP Fault = Detected

Functional Validation

Expected Response = Missing

Thresholds should reflect the expected behavior and business importance of the service.

🤖 17. Configure Rules and Automated Analysis

Use GermainUX Rules for more advanced conditions.

Examples:

Rules can combine SOAP monitoring data with other GermainUX telemetry.

🔔 18. Configure Alerts and Watches

When a SOAP condition meets an SLA or Rule, GermainUX can:

For example:

SOAP request fails 3 consecutive times → Alert Integration Team

or:

SOAP Fault detected → Collect additional diagnostics → Notify Application Support

📈 19. Configure Dashboards

Create dashboards to monitor:

For critical integrations, combine SOAP data with related application, server, database, network, and business-process KPIs.

✅ 20. Validate the Configuration

After saving the component, execute or wait for a SOAP monitoring cycle.

Confirm that:

1. The Engine executes the request.

2. The SOAP endpoint receives the request.

3. Authentication succeeds.

4. A response is returned.

5. Response time is recorded.

6. HTTP status is recorded.

7. Response validation executes.

8. SOAP Faults are detected when applicable.

9. The correct KPI is generated.

10. The result appears in GermainUX.

11. SLA status is evaluated.

12. Alerts or Watches operate as expected.

🔧 Troubleshooting

⛔ SOAP Request Does Not Execute

Verify:

📡 Endpoint Cannot Be Reached

Verify:

🔑 Authentication Fails

Verify:

❗ HTTP Request Succeeds but Monitor Reports a Failure

Verify the configured response-validation conditions.

The HTTP transaction may succeed while the SOAP operation returns:

🐛 SOAP Fault Is Returned

Review the available:

⏱️ Response Time Is High

Correlate the SOAP transaction with other monitored data, including:

SOAP monitoring measures the end-to-end request. Additional monitoring is required to identify internal server-side execution bottlenecks.

ℹ️ Get More Information

GermainUX can help determine which monitoring, analytics and automation capabilities are appropriate for your SOAP environment.

Contact GermainUX Support.