[Feature][Seatunnel-Web] Add OpenMetrics Support for Seatunnel-web

[shashwatsai]

Search before asking

• I had searched in the feature and found no similar feature requirement.

Description

Description

Seatunnel-web is a crucial component in our deployment architecture. However, it currently lacks the ability to export metrics in the OpenMetrics format. It is essential to have metrics related to JVM performance, availability, and key API activities such as the number of login requests and jobs submitted.

While the seatunnel-engine already exports telemetry data with valuable metrics, it is vital for Seatunnel-web to provide observability features as well. This will enable us to raise necessary alerts in cases of resource utilization exceeding thresholds, test connection failures, or unavailability issues.

Proposed Solution

1. Implement Metrics Export: Enable Seatunnel-web to export metrics in the OpenMetrics format. This should include:

   • JVM metrics (e.g., memory usage, garbage collection)
   • Availability metrics (e.g., uptime, response times)
   • API call metrics (e.g., login requests, job submissions)

2. Integrate with Monitoring Tools: Ensure compatibility with monitoring and alerting tools that support OpenMetrics, such as Prometheus and Grafana.

3. Resource Utilization Alerts: Configure alerts for resource utilization thresholds to proactively address performance bottlenecks.

4. Connection and Availability Monitoring: Implement monitoring for test connection failures and overall service availability to ensure robust deployment.

Impact

By implementing these changes, Seatunnel-web will enhance its observability capabilities, allowing for better monitoring, alerting, and overall performance management. This will contribute to more reliable and efficient operations within our deployment.

---

Example

Number of user login

Usage Scenario

Usage Scenario:

Observability of Seatunnel-web Component

Once Seatunnel-web is deployed, the administrator requires essential metrics to monitor its availability and usage by consumers effectively. These metrics are critical for ensuring the smooth operation and reliability of the Seatunnel-web component. The following scenarios highlight the key areas where observability is necessary:

1. Monitoring Availability:

   • Uptime Metrics: Track the uptime of the Seatunnel-web component to ensure it is running continuously without unexpected downtimes.
   • Response Time Metrics: Measure the response times of various API endpoints to detect any performance degradation.
   • Error Rates: Monitor the rate of errors or failed requests to identify and address issues promptly.

2. Resource Utilization:

   • JVM Metrics: Collect and analyze JVM metrics such as memory usage, garbage collection times, and thread counts to ensure optimal performance and resource management.
   • CPU and Memory Utilization: Monitor the CPU and memory usage of the Seatunnel-web component to prevent resource bottlenecks and ensure efficient utilization.

3. API Usage Monitoring:

   • Login Requests: Track the number of login requests to monitor user activity and detect potential security issues.
   • Job Submissions: Monitor the number of jobs submitted through the Seatunnel-web interface to understand usage patterns and ensure that the system can handle the load.

4. Alerting and Notifications:

   • Threshold Alerts: Configure alerts for key metrics such as CPU usage, memory utilization, and response times. These alerts will notify the administrator when predefined thresholds are crossed, allowing for proactive intervention.
   • Connection Failures: Detect and alert on test connection failures to ensure that Seatunnel-web can reliably connect to necessary services and databases.

5. Integration with Monitoring Tools:

   • Prometheus and Grafana: Export metrics in the OpenMetrics format to integrate seamlessly with monitoring tools like Prometheus and Grafana. This integration will enable the creation of detailed dashboards and visualizations, providing a comprehensive view of the Seatunnel-web component's health and performance.

By implementing robust observability for the Seatunnel-web component, administrators can ensure its availability, reliability, and efficient usage, ultimately leading to a better experience for end-users and more effective management of the deployment.

Related issues

No response

Are you willing to submit a PR?

• Yes I am willing to submit a PR!

Code of Conduct

• I agree to follow this project's Code of Conduct

[shashwatsai]

CC: @Hisoka-X , @arshadmohammad, please let us know, if we can assign this to ourselves.