To address the surge in enterprise data volume and the increased complexity of system monitoring, API7 Enterprise has fully upgraded the alerting functionality in version 3.2.16.4. The new version introduces contact points that allow users to integrate with external platforms, ensuring that critical notifications are delivered efficiently.
Introduction to New Features
1. Support for Contact Points (Webhook/Email)
A contact point represents an external endpoint, and each contact can be configured with one notification channel, including Email and Webhook. You can configure SMTP services at the organizational level to enable email notifications or use Webhook to send alert messages to external systems such as Microsoft Teams, Discord, Lark, or Slack. Additionally, when referencing contact points, you can customize the notification content, including email subject, body, or Webhook request payloads, to meet the requirements of different external platforms.
2. Alerting Feature Optimization
We have fully optimized the alerting policies to make them more flexible and easier to manage. Each alert policy now supports multiple trigger conditions and alert messages are sent based on these conditions. New labels and descriptions have been added to alert policies to make management and identification more intuitive. Furthermore, we have introduced more granular permission management to ensure that only authorized users can view and operate specific alert policies.
How to Use New Alerting Features?
Configuring SMTP Service
1.Log in to the API7 Enterprise dashboard and navigate to the "SMTP" tab under the "organization" settings page. You can see an "Enable" button here. Click it to start configuring the SMTP server.
2.Fill in the necessary configuration information for the SMTP server, including the server address, port, username, and password.
3.Once configured, save the settings. After enabling, all emails related to API7 Enterprise will be sent via this SMTP server.
Creating and Managing Contacts
On the dashboard, go to the "Contact Points" menu under the "Organization" section to access the contact point list.
Click the "+ Add Contact Point" button to create a new one. During the setup, you need to configure the basic information and choose the relevant notification channel, Webhook, or Email.
Configuring Alert Policies
1.In the left menu of the dashboard, click on the "Policies" under the "Alerts" section to create a new alert policy. First, fill in the basic information for the policy, such as the name and description. Besides the basic information, alert policies also include the following two key attributes:
Severity: This indicates the urgency of the alert. You can set it to high, medium, or low based on business requirements and the importance of the monitored target. The severity can be included in the alert message to help you quickly identify and respond to critical alerts.
Check Interval: This determines how often the system checks whether the monitoring conditions trigger an alert. You can flexibly adjust this interval based on the monitored objects and business needs.
2.Next, add trigger conditions to the alert policy. You can define multiple trigger conditions and specify the condition types based on your business needs. The system will automatically trigger the alert when specific conditions are met.
3.In the alert policy, select the contact points you previously created and configure custom alert message content for them. The alert message content supports using Go Template syntax, allowing you to insert variables such as severity, event type, or trigger time into the message.
4.Save the alert policy configuration, and the policy will be enabled by default. The system will then start monitoring the trigger conditions based on the check interval and automatically send notifications to the designated contact points when the conditions are met.
5.On the API7 Enterprise dashboard, you can view the alert history to see which alerts have been triggered and which notifications have been sent. If an alert fails to be sent successfully, you can check the notification logs on the contact points details page, which include detailed logs of notification sending and responses. This helps troubleshoot the issue and take appropriate action.
Conclusion
The new features in API7 Enterprise are designed to significantly enhance your gateway's monitoring and response capabilities. By integrating contact points and refining alert policies, you gain more precise control over how and when alerts are delivered. This ensures that critical information is never overlooked, allowing you to efficiently navigate complex and dynamic business environments. We value your feedback on your user experience, as it provides valuable insights that will drive ongoing product optimization and improvements, ultimately offering you an even more seamless and powerful experience.
Top comments (0)