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

# Alarm

> You can automatically monitor critical situations in the system, send notifications when specified threshold values are exceeded, and continuously track Kubernetes, Elasticsearch, certificate, and log sources.

## Overview

<CardGroup cols={2}>
  <Card title="Kubernetes Monitoring" icon="server">
    Monitor pod and node health statuses
  </Card>

  <Card title="Elasticsearch Monitoring" icon="database">
    Track cluster health and resource usage
  </Card>

  <Card title="Resource Monitoring" icon="gauge">
    Monitor CPU and disk usage rates
  </Card>

  <Card title="Certificate Management" icon="certificate">
    Track SSL and JWK certificate durations
  </Card>

  <Card title="Log Monitoring" icon="file-lines">
    Monitor application log counts
  </Card>

  <Card title="Automatic Notifications" icon="bell">
    Receive instant notifications when threshold values are exceeded
  </Card>
</CardGroup>

## What is Alarm?

### Basic Concept

Alarm is a monitoring system that continuously checks specific conditions in your system and sends notifications when these conditions are met.

<AccordionGroup>
  <Accordion title="When to Use?">
    <CardGroup cols={2}>
      <Card title="System Health Monitoring" icon="heart-pulse">
        Monitoring pod, node, and Elasticsearch health statuses
      </Card>

      <Card title="Resource Usage Monitoring" icon="chart-line">
        Tracking CPU and disk usage rates
      </Card>

      <Card title="Certificate Management" icon="certificate">
        Tracking SSL and JWK certificate durations
      </Card>

      <Card title="Log Management" icon="file-lines">
        Monitoring application log counts
      </Card>

      <Card title="Proactive Warning" icon="shield-check">
        Receiving warnings before problems occur
      </Card>

      <Card title="Automatic Notification" icon="bell">
        Receiving automatic notifications in critical situations
      </Card>
    </CardGroup>
  </Accordion>

  <Accordion title="How Does It Work?">
    <Steps>
      <Step title="Configuration">
        Trigger type, threshold value, scheduling, and notifications are determined
      </Step>

      <Step title="Scheduling">
        Automatic checks are performed at specified times (e.g., every hour)
      </Step>

      <Step title="Check">
        A specific metric or status is checked according to the trigger type
      </Step>

      <Step title="Threshold Check">
        If there is a threshold value, it is checked whether the checked value exceeded the threshold value
      </Step>

      <Step title="Notification">
        When the threshold is exceeded or status changes, configured notifications are triggered
      </Step>

      <Step title="Recording">
        All checks are recorded in history
      </Step>
    </Steps>
  </Accordion>
</AccordionGroup>

## Quick Start

### Creating Your First Alarm

<Steps>
  <Step title="Access from Menu">
    Click **Main Menu** → **Monitoring** → **Alarm**
  </Step>

  <Step title="Create New Alarm">
    Click the **"Create New"** button
  </Step>

  <Step title="Fill in Basic Information">
    * **Name**: A name for the alarm (e.g., "Elasticsearch CPU Monitoring")
    * **Description**: Optional description
  </Step>

  <Step title="Select Trigger Type">
    Select the trigger type (e.g., Elasticsearch CPU Percentage)
  </Step>

  <Step title="Enter Threshold Value">
    Enter the threshold value (e.g., 80)
  </Step>

  <Step title="Set Scheduling">
    Determine the check frequency (e.g., Every hour)
  </Step>

  <Step title="Save">
    Click the **"Save"** button
  </Step>
</Steps>

## Creating New Alarm

<img src="https://mintcdn.com/apinizer/LoT_QidIA2t_0Oih/images/monitor/alarm/01-alarm-ayarlar-formu.png?fit=max&auto=format&n=LoT_QidIA2t_0Oih&q=85&s=f75f0a25e482a0ec48806442c2115468" alt="Alarm Creation Settings Form" width="1000" height="800" style={{ borderRadius: '0.5rem' }} data-path="images/monitor/alarm/01-alarm-ayarlar-formu.png" />

### Step 1: Basic Information

<AccordionGroup>
  <Accordion title="Name - Required">
    Enter a unique name for the alarm. This name:

    * Must be unique within the project
    * Cannot start with a space
    * The system automatically checks the availability of the name

    **Good Name Examples:**

    * `Elasticsearch CPU Monitoring`
    * `Kubernetes Pod Health Status`
    * `SSL Certificate Duration Tracking`
    * `Application Log Count Monitoring`
  </Accordion>

  <Accordion title="Description - Optional">
    You can enter descriptive information about the alarm:

    * Maximum 1000 characters
    * Used to explain the purpose and scope of the alarm
    * Displayed on the list page

    **Example Descriptions:**

    * `Created to monitor CPU usage of Elasticsearch cluster`
    * `Used to track health status of Kubernetes pods`
    * `Configured to warn before SSL certificates expire`
  </Accordion>

  <Accordion title="Status - Default: Active">
    Determines the active/passive status of the alarm:

    * **Active**: Alarm runs, scheduled checks are performed
    * **Passive**: Alarm is stopped, no checks are performed (historical data is preserved)
  </Accordion>
</AccordionGroup>

### Step 2: Trigger Type and Threshold Value

#### Trigger Types

Determines when the alarm will be triggered. Select one of the following trigger types:

<CardGroup cols={2}>
  <Card title="Kubernetes" icon="server">
    * Pod Health Status
    * Node Health Status
    * K8S Node CPU Percentage
  </Card>

  <Card title="Elasticsearch" icon="database">
    * Health Status
    * CPU Percentage
    * Disk Percentage
    * Logs in Database
  </Card>

  <Card title="Certificate" icon="certificate">
    * SSL Certificate Remaining Duration
    * JWK Certificate Remaining Duration
  </Card>

  <Card title="Application Log" icon="file-lines">
    * Application Log Count
  </Card>
</CardGroup>

<AccordionGroup>
  <Accordion title="Kubernetes Trigger Types">
    **Pod Health Status**: Checks the health status of Kubernetes pods. Alarm is triggered when any pod becomes unhealthy. Does not require threshold value.

    **Node Health Status**: Checks the health status of Kubernetes nodes. Alarm is triggered when any node becomes unhealthy. Does not require threshold value.

    **K8S Node CPU Percentage**: Checks the CPU usage percentage of Kubernetes nodes. Alarm is triggered when CPU usage percentage exceeds the threshold value. Requires threshold value (e.g., 80 = 80%).
  </Accordion>

  <Accordion title="Elasticsearch Trigger Types">
    **Elasticsearch Health Status**: Checks the health status of Elasticsearch cluster. Alarm is triggered when cluster becomes unhealthy. Does not require threshold value. Requires connection definition.

    **Elasticsearch CPU Percentage**: Checks the CPU usage percentage of Elasticsearch cluster. Alarm is triggered when CPU usage percentage exceeds the threshold value. Requires threshold value (e.g., 80 = 80%). Requires connection definition.

    **Elasticsearch Disk Percentage**: Checks the disk usage percentage of Elasticsearch cluster. Alarm is triggered when disk usage percentage exceeds the threshold value. Requires threshold value (e.g., 90 = 90%). Requires connection definition.

    **Elasticsearch Logs in Database**: Checks whether Elasticsearch logs are in the database. Alarm is triggered when logs are in the database. Does not require threshold value.
  </Accordion>

  <Accordion title="Certificate Trigger Types">
    **SSL Certificate Remaining Duration**: Checks the remaining duration of SSL certificates. Alarm is triggered when remaining duration is less than the threshold value. Requires threshold value (e.g., 30 = 30 days).

    **JWK Certificate Remaining Duration**: Checks the remaining duration of JWK certificates. Alarm is triggered when remaining duration is less than the threshold value. Requires threshold value (e.g., 30 = 30 days).
  </Accordion>

  <Accordion title="Application Log Trigger Types">
    **Application Log Count**: Checks the count of a specific application log type. Alarm is triggered when log count exceeds the threshold value. Requires threshold value (e.g., 10000 = 10,000 records). Log type must be selected.

    **Supported Log Types:**

    * Manager Logs
    * Gateway Logs
    * Cache Logs
    * Integration Logs
    * Portal Logs
    * Audit Logs Manager
    * Audit Logs ACL
    * And more...
  </Accordion>
</AccordionGroup>

#### Threshold Value

Threshold value determines when the alarm will be triggered. Different units are used according to the trigger type:

| Trigger Type                       | Unit    | Example Value | Description                                  |
| ---------------------------------- | ------- | ------------- | -------------------------------------------- |
| K8S Node CPU Percentage            | %       | 80            | When CPU usage exceeds 80%                   |
| Elasticsearch CPU Percentage       | %       | 80            | When CPU usage exceeds 80%                   |
| Elasticsearch Disk Percentage      | %       | 90            | When disk usage exceeds 90%                  |
| SSL Certificate Remaining Duration | Days    | 30            | When remaining duration is less than 30 days |
| JWK Certificate Remaining Duration | Days    | 30            | When remaining duration is less than 30 days |
| Application Log Count              | Records | 10000         | When log count exceeds 10,000                |

<Tip>
  **Threshold Value Recommendations:**

  * **CPU Monitoring**: Between 70-80%
  * **Disk Monitoring**: Between 80-90%
  * **Certificate Tracking**: Between 30-60 days
  * **Log Count**: According to system capacity
</Tip>

#### Connection Definition

Some trigger types require Elasticsearch connection:

**Trigger Types Requiring Connection:**

* Elasticsearch Health Status
* Elasticsearch CPU Percentage
* Elasticsearch Disk Percentage

**Trigger Types Not Requiring Connection:**

* Kubernetes trigger types
* Certificate trigger types
* Application log trigger types

<Note>
  Elasticsearch connection is selected from connections created on the **Connection Management** page. Connection must be active and accessible.
</Note>

### Step 3: Scheduling Settings

Determine how frequently the alarm will be checked. Scheduling is done using **Cron Expression**.

#### Common Scheduling Examples

| Description        | Cron Expression  | Use Case                                      |
| ------------------ | ---------------- | --------------------------------------------- |
| Every hour         | `0 0 * ? * *`    | For general monitoring (most common)          |
| Every 30 minutes   | `0 */30 * ? * *` | For critical systems                          |
| Every 15 minutes   | `0 */15 * ? * *` | For very critical systems                     |
| Every day at 09:00 | `0 0 9 * ? *`    | For daily reporting                           |
| Every 5 minutes    | `0 */5 * ? * *`  | For situations requiring very frequent checks |

<Tip>
  **Recommendations:**

  * **General Monitoring**: Every hour
  * **Critical Systems**: Every 15-30 minutes
  * **Certificate Tracking**: Every day at 09:00
  * **Resource Monitoring**: Every 30 minutes
</Tip>

### Step 4: Notification Recipients

Configure recipients who will receive notifications when the alarm is triggered:

<AccordionGroup>
  <Accordion title="Adding Notifications">
    <Steps>
      <Step title="Add to Actions Table">
        Click the **"Add"** button in the **Actions** table
      </Step>

      <Step title="Select Notification Type">
        Supported notification types:

        * **Email**: Sends email notification
        * **Webhook**: Sends HTTP POST request
        * **Slack**: Sends message to Slack channel
        * **SMS**: Sends SMS notification
        * **System Notification**: Sends in-system notification
        * And more...
      </Step>

      <Step title="Complete Notification Configuration">
        Fill in the required information according to the notification type
      </Step>
    </Steps>

    <Note>
      For detailed information about actions, see the [Connectors](/en/integrations/connectors/overview) page.
    </Note>
  </Accordion>

  <Accordion title="Notification Management">
    **Notification Table Columns:**

    * **Name**: Notification name
    * **Type**: Notification type (Email, Webhook, Slack, etc.)
    * **Status**: Active/Passive status
    * **Description**: Notification description

    **Notification Operations:**

    * **Edit**: Select "Edit" from the menu to update notification information
    * **Delete**: Select "Delete" from the menu to remove the notification
    * **Active/Passive**: You can activate/deactivate the notification with toggle
  </Accordion>
</AccordionGroup>

### Step 5: Saving

After filling in all information:

1. Make sure form validations pass:
   * ✅ Name entered and available
   * ✅ Trigger type selected
   * ✅ Threshold value entered (if required)
   * ✅ Connection definition selected (if required)
   * ✅ Scheduling settings configured

2. Click the **"Save"** button

3. After the alarm is saved, you will be automatically redirected to the listing page

## Monitoring and Reporting Results

### Accessing History Page

1. Click on the alarm name in the alarm list OR
2. Select **"Results"** option from the operations menu (⋮)

### History Page Sections

<AccordionGroup>
  <Accordion title="1. History Table">
    Table showing detailed results of each check run:

    **Columns:**

    * **Operation Date**: Date and time when the check was performed
    * **Result Type**: Check result:
      * 🟢 **Threshold Not Exceeded (THRESHOLD\_NOT\_EXCEEDED)**: Threshold value not exceeded (normal)
      * 🔴 **Threshold Exceeded (THRESHOLD\_EXCEEDED)**: Threshold value exceeded (alarm triggered)
      * 🟠 **Error Occurred (AN\_ERROR\_OCCURRED)**: Error occurred during check
    * **Operations**: Menu button (⋮)
  </Accordion>

  <Accordion title="2. Viewing Result Details">
    1. Click the **menu button** (⋮) in the table
    2. Select one of the following options:
       * **Detail**: View result details
       * **Delete**: Delete the result

    **Detail Dialog:**

    * **Summary**: Summary of the check result
    * **Detail**: Detailed information about the check result
  </Accordion>

  <Accordion title="3. Header Section">
    * **Date Range Selector**: Filter history records by a specific date range
    * **Refresh Button**: Manually refresh history
    * **Delete All Button**: Delete all history records
    * **Alarm Information**: Alarm name and description
  </Accordion>
</AccordionGroup>

## Alarm Management

<img src="https://mintcdn.com/apinizer/LoT_QidIA2t_0Oih/images/monitor/alarm/02-alarm-ozeti.png?fit=max&auto=format&n=LoT_QidIA2t_0Oih&q=85&s=4f2f6800b5662ae9f3d34e520cecb3ba" alt="Alarm Summary" width="1000" height="800" style={{ borderRadius: '0.5rem' }} data-path="images/monitor/alarm/02-alarm-ozeti.png" />

### List Page Features

On the alarm list page, you can view and manage all your alarms.

<AccordionGroup>
  <Accordion title="Search and Filtering">
    * **Search by Name**: Filter alarms by typing in the name field
    * **Search by Description**: Search by typing in the description field
    * **Trigger Type Filter**: Filter by trigger type
    * **Status Filter**: Filter by Active/Passive status
    * **Clear**: Click the eraser icon to clear all filters
  </Accordion>

  <Accordion title="Table Columns">
    * **Name**: Alarm name (clickable, goes to history page)
    * **Description**: Alarm description
    * **Trigger Type**: Alarm trigger type
    * **Threshold**: Threshold value and unit (if any)
    * **Status**: Active/Passive status (can be changed with toggle)
    * **Operations**: Menu button (⋮)
  </Accordion>

  <Accordion title="Operations Menu">
    For each alarm, click the menu button (⋮) to perform the following operations:

    1. **Results**: View alarm history records
    2. **Edit**: Update alarm settings
    3. **Delete**: Delete the alarm
  </Accordion>

  <Accordion title="Changing Status">
    To change the active/passive status of the alarm:

    1. Click the toggle in the **Status** column in the table
    2. Alarm status is updated instantly
    3. Passive alarms do not run, but their historical data is preserved
  </Accordion>
</AccordionGroup>

## Best Practices

<CardGroup cols={2}>
  <Card title="Naming Conventions" icon="tag">
    * Use descriptive names: `Elasticsearch CPU Monitoring`
    * Add environment/project prefix: `Production - SSL Certificate Tracking`
    * Specify trigger type: `K8S Node CPU Monitoring`
  </Card>

  <Card title="Threshold Value Strategy" icon="sliders">
    * CPU Monitoring: Between 70-80%
    * Disk Monitoring: Between 80-90%
    * Certificate Tracking: Between 30-60 days
    * Log Count: According to system capacity
  </Card>

  <Card title="Scheduling Strategy" icon="clock">
    * Critical Systems: Every 15-30 minutes
    * General Monitoring: Every hour
    * Certificate Tracking: Every day at 09:00
    * Resource Monitoring: Every 30 minutes
  </Card>

  <Card title="Notification Management" icon="bell">
    * Critical Alarms: Email + SMS notification
    * General Alarms: Email notification is sufficient
    * Webhook: Send notifications to your integration systems
    * Notification Spam: Avoid notification spam with appropriate scheduling
  </Card>
</CardGroup>

## Frequently Asked Questions

<AccordionGroup>
  <Accordion title="How Often Does Alarm Run?">
    The frequency of alarm execution depends on the **Scheduling** (Cron Expression) settings you determined when creating it. For example:

    * `0 0 * ? * *` → Every hour
    * `0 */30 * ? * *` → Every 30 minutes
    * `0 0 9 * ? *` → Every day at 09:00
  </Accordion>

  <Accordion title="What Happens When Alarm is Deactivated?">
    When alarm is deactivated:

    * No new checks are performed
    * Existing scheduled jobs are cancelled
    * History records are preserved and can be viewed
    * Alarm continues normal operation when reactivated
  </Accordion>

  <Accordion title="How is Threshold Value Determined?">
    Threshold value should be determined according to your system's normal operating conditions:

    * **CPU Monitoring**: 20-30% above normal CPU usage
    * **Disk Monitoring**: 80-90% of disk capacity
    * **Certificate Tracking**: Before certificate renewal time (e.g., 30 days)
    * **Log Count**: According to system capacity
  </Accordion>

  <Accordion title="Can I Add Multiple Notifications?">
    Yes, you can add multiple notifications. Each notification:

    * Can be a different type (Email, SMS, Webhook, etc.)
    * Can be sent to different recipients
    * Can be independently activated/deactivated
  </Accordion>

  <Accordion title="How Long Are History Records Kept?">
    History records are kept until manually deleted. To clean old records:

    * You can use the "Delete All" button on the history page
    * Or you can clean records regularly
  </Accordion>

  <Accordion title="What Happens When Alarm is Deleted?">
    When alarm is deleted:

    * Alarm definition is deleted from database
    * All history records are deleted
    * Scheduled jobs are cancelled
    * Historical data is permanently lost

    <Warning>
      **Warning**: Deletion cannot be undone!
    </Warning>
  </Accordion>
</AccordionGroup>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Alarm Not Working">
    **Possible Causes:**

    1. Alarm may be in passive status → Check status toggle
    2. Scheduling settings may be wrong → Check cron expression
    3. Elasticsearch connection may not exist or be inaccessible → Check connection settings
    4. Threshold value may be incorrectly configured → Check threshold value

    **Solution:**

    * Activate alarm status
    * Check scheduling settings
    * Check Elasticsearch connection
    * Check threshold value
  </Accordion>

  <Accordion title="All Results Are in 'Error Occurred' Status">
    **Possible Causes:**

    1. Elasticsearch connection does not exist or is inaccessible
    2. Kubernetes cluster is inaccessible
    3. System resources are insufficient
    4. Configuration error

    **Solution:**

    * Check Elasticsearch connection
    * Check Kubernetes cluster connection
    * Check system resources
    * Check alarm configuration
  </Accordion>

  <Accordion title="Too Many Notifications Coming">
    **Possible Causes:**

    1. Threshold value is too low
    2. Scheduling is too frequent
    3. Multiple notifications are active

    **Solution:**

    * Increase threshold value
    * Reduce scheduling frequency
    * Deactivate unnecessary notifications
  </Accordion>

  <Accordion title="Notifications Not Coming">
    **Possible Causes:**

    1. Notification is in passive status
    2. Notification configuration is incorrect
    3. Email/SMS service is not working

    **Solution:**

    * Activate notification status
    * Check notification configuration
    * Check Email/SMS service settings
  </Accordion>
</AccordionGroup>

## Additional Resources

<CardGroup cols={2}>
  <Card title="Connectors" icon="bolt" href="/en/integrations/connectors/overview">
    Notification and action configuration
  </Card>

  <Card title="Scheduled Jobs" icon="clock" href="/en/admin/scheduled-jobs">
    Cron expression and scheduling settings
  </Card>

  <Card title="Connection Management" icon="network-wired" href="/en/integrations/connection-management/overview">
    Elasticsearch connection management
  </Card>

  <Card title="Kubernetes Monitoring" icon="server" href="#">
    Kubernetes pod and node monitoring
  </Card>
</CardGroup>