Ana içeriğe geç

Anomaly Detector

Overview

Automatic Anomaly Detection

Automatically detect abnormal situations in your API traffic

Performance Monitoring

Monitor anomalies in metrics such as response time and error rate

Traffic Analysis

Detect changes such as traffic increase/decrease early

Statistical Analysis

Perform statistical anomaly detection with EMA algorithm

Automatic Notifications

Receive instant notifications when anomalies are detected

Visual Reporting

Visualize historical anomaly data with charts

Anomaly Detector Settings Form
Anomaly Detector settings form - All configuration fields

What is Anomaly Detector?

Basic Concept

Anomaly Detector is a monitoring system that automatically detects deviations from normal behavior in your API traffic.

bilgi

Anomaly Detection, in its simplest sense, is a technique that enables finding unexpected situations or patterns in data. These unexpected situations or patterns are actually situations or patterns that do not conform to the expected behaviors of data. In the literature, these unexpected situations are called outliers (outlier values), exceptions (exceptional situations), or anomalies (outside the norm).

Example Scenario: Let's say you spend approximately 200-300 TL per month from your credit card. That is, in your bank's profile, you are a customer who makes low-budget expenditures every month. So what happens if one day you make a purchase of 1500 TL?

Actually, this situation indicates that you have deviated from your normal behavior and that you have suddenly become a customer who spends 1500 TL unexpectedly, while normally you are a customer who spends at most 200-300 TL. This situation is actually an anomaly behavior. If your bank uses anomaly detection techniques in this case, it predicts that this could be credit card fraud (Credit Card Fraud Detection) and sends you a message. This simple example is actually an anomaly detection example.

When to Use?
Performance Monitoring

Detecting abnormal increases in response times

Error Rate Monitoring

Detecting sudden rises in error rates

Traffic Analysis

Detecting changes such as traffic increase/decrease

SLA Tracking

Detecting deviations in service level agreements

Security Monitoring

Detecting suspicious traffic behaviors

Capacity Planning

Performing capacity planning by analyzing traffic trends

How Does It Work?
Configuration

Query, filter, conditions, and scheduling are determined

Scheduling

Analysis is performed automatically at specified times (e.g., every 5 minutes)

Data Collection

API traffic is analyzed using query and filter

Condition Check

Anomaly check is performed according to defined conditions:

  • Metric Check: Did the value exceed a certain threshold?
  • Rate Check: Did the value increase/decrease by a certain rate?
  • EMA Check: Is the value statistically abnormal?
Save Result

When an anomaly is detected, the result is saved

Notification

When an anomaly is detected, configured notifications are triggered

Quick Start

Creating Your First Anomaly Detector

Access from Menu

Click MonitoringAnomaly Detector from the Main Menu

Create New Detector

Click the "Create New" button

Fill in Basic Information
  • Name: A name for your detector (e.g., "Response Time Anomaly Detection")
  • Description: Optional description
  • Environment: Select the environment to be analyzed
Define Query and Filter

Define the API traffic to be analyzed with query and filter

Define Condition

Define anomaly detection conditions (Metric, Rate, or EMA)

Set Scheduling

Determine analysis frequency (e.g., Every 5 minutes)

Save

Click the "Save" button

Creating a New Anomaly Detector

Step 1: Basic Information

Name - Required

Enter a unique name for the anomaly detector. 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:

  • Response Time Anomaly Detection
  • Error Rate Increase Monitoring
  • Traffic Anomaly Detector
  • Critical API Performance Monitoring
Description - Optional

You can enter descriptive information about the anomaly detector:

  • Maximum 500 characters
  • Used to explain the purpose and scope of the detector
  • Displayed on the list page

Example Descriptions:

  • Created for response time anomaly detection of critical payment API
  • Used to monitor error rate increases across all APIs
  • Uses EMA algorithm to detect traffic anomalies
Environment - Required

Select the environment to be analyzed:

  • Select an environment from the environment list
  • The selected environment must have Elasticsearch integration active
  • Environments without integration are shown as disabled
Status - Default: Active

Determines the active/passive status of the detector:

  • Active: Detector runs, scheduled analyses are performed
  • Passive: Detector is stopped, no analysis is performed (historical data is preserved)

Step 2: Scheduling Settings

Determine how often the detector will run. Scheduling is done using Cron Expression.

Common Scheduling Examples

DescriptionCron ExpressionUse Case
Every 5 minutes0 */5 * ? * *For critical APIs (most common)
Every 15 minutes0 */15 * ? * *For normal APIs
Every hour0 0 * ? * *For test/development environments
Every day at 09:000 0 9 * ? *For daily reporting
ipucu

Recommendations:

  • For critical APIs: Every 5 minutes
  • For normal APIs: Every 15-30 minutes
  • For test/development: Every hour

Step 3: Query and Filter Configuration

In this section, you define the API traffic to be analyzed.

Query - Required

Query defines the API traffic to be analyzed:

Select or Create Query

Click the "Select or Create Query" button

Query Selection or Creation

In the opened dialog:

  • You can select an existing query OR
  • Create a new query
Define Query Criteria
  • API Proxy: Which APIs will be analyzed?
  • HTTP Method: Which HTTP methods will be analyzed?
  • Endpoint: Which endpoints will be analyzed?
  • And more...

Query Examples:

  • Analyze all failed requests
  • Analyze all requests of a specific API proxy
  • Analyze response times of a specific endpoint
not

For detailed information about queries, see the Queries page.

Filter - Optional

Filter is used to further narrow down query results:

Select or Create Filter

Click the "Select or Create Filter" button

Filter Selection or Creation

In the opened dialog:

  • You can select an existing filter OR
  • Create a new filter
Define Filter Criteria
  • Date Range: Which time range will be analyzed?
  • Proxy List: Which proxies will be included?
  • Result Type: Successful/Failed/Blocked requests

Filter Examples:

  • Analyze traffic from the last 1 hour
  • Analyze only failed requests
  • Exclude specific proxies
not

For detailed information about filters, see the Filters page.

Step 4: Condition Definition

Conditions are the criteria used for anomaly detection. You can define multiple conditions. An anomaly is detected when at least one condition is met.

Condition Types

Anomaly Detector supports 4 different types of conditions:

Metric Value Check

Direct check of metric values - Did the value exceed a certain threshold?

Metric Increase/Decrease Rate

Metric increase/decrease rate check - Did the value increase/decrease by a certain rate?

EMA with Bollinger Bands

Use of EMA with bollinger bands - Is the value statistically abnormal?

Query/Filter Rate Check

Query/Filter rate check - Ratio of query results to filter results

Adding Conditions

  1. Click the "+" button to add a new condition

  2. Select the condition type (Metric / Rate / EMA / Query - Filter Rate)

  3. Fill in the condition parameters

    1. Metric Value Check

    Metric condition checks whether a metric value exceeds a certain threshold.

    Metric Value Check
    Example configuration of metric value check

    Configuration Fields:

    FieldDescription
    average ofIndicates which operation will be applied to the value in the next column. In this example, average value is selected.
    time api proxy totalSpecifies which metric field will be processed. In this example, API Proxy total time is selected.
    aboveSpecifies how the found metric will be compared with the next value.
    for ... timesSpecifies that this condition must be met for the last ... times.

    Supported Operators:

    • Above: Value > Threshold
    • Above or Equal: Value >= Threshold
    • Below: Value < Threshold
    • Below or Equal: Value <= Threshold
    • Between: Threshold1 < Value < Threshold2

    Example Scenario:

    • Metric Type: Average Response Time
    • Operator: Above
    • Threshold Value: 1000 ms
    • Repeat Count: 3
    • Meaning: Anomaly is detected when average response time exceeds 1000 ms and this situation is repeated 3 times.
    2. Metric Increase/Decrease Rate Check

    Rate condition checks whether a metric value increases or decreases by a certain rate.

    Metric Increase/Decrease Rate Check
    Example configuration of metric increase/decrease rate check

    Configuration Fields:

    FieldDescription
    average ofIndicates which operation will be applied to the value in the next column. In this example, average value is selected.
    time api proxy totalSpecifies which metric field will be processed. In this example, API Proxy total time is selected.
    increased bySpecifies what the behavior of the found metric will be. In this example, increase rate is selected.
    more thanSpecifies how the metric behavior will be compared with the previous value. In this example, greater than comparison is selected.
    averageSpecifies how the last values to be checked will be handled. In this example, it specifies that the "Average" of the last values to be checked should be taken.
    previous ... resultSpecifies that this condition must be met for the last ... times.

    How Does It Work?

    • Previous N results are compared with current result
    • Increase/decrease rate is calculated
    • This rate is compared with threshold value

    Example Scenario:

    • Metric Type: Total Request Count
    • Operator: Increase Rate
    • Rate Operator: Above
    • Threshold Value: 50%
    • Previous Result Count: 5
    • Meaning: Anomaly is detected when total request count increases by more than 50% compared to the last 5 analysis results.
    3. EMA with Bollinger Bands

    EMA (Exponential Moving Average) condition detects statistically abnormal values.

    EMA with Bollinger Bands
    Example configuration of EMA with bollinger bands

    Configuration Fields:

    FieldDescription
    average ofIndicates which operation will be applied to the value in the next column. In this example, average value is selected.
    time api proxy totalSpecifies which metric field will be processed. In this example, API Proxy total time is selected.
    EMASpecifies what operation will be performed with the selected metric value. In this example, EMA value is selected.
    above from upper bollinger bandSpecifies how the result of the applied EMA formula will be applied. In this example, values above the Upper Bollinger Band value are selected.
    is calculated withSpecifies how many previous values the EMA value will be calculated over. In this example, 10 values are selected.
    data points and standard deviation multiplier sensitivity ofSpecifies the sensitivity degree of EMA bollinger bands.

    How Does EMA Work?

    • EMA calculates an average value based on historical data
    • Upper and lower bands are created using standard deviation
    • Anomaly is detected when current value goes outside these bands

    Sensitivity Levels:

    • High Sensitivity (0.5-1.0): Detects more anomalies (more sensitive)
    • Medium Sensitivity (1.0-1.5): Balanced anomaly detection (recommended)
    • Low Sensitivity (1.5-2.0): Detects fewer anomalies (less sensitive)

    Example Scenario:

    • Metric Type: Average Response Time
    • EMA Operator: Outside
    • Data Point Count: 20
    • EMA Sensitivity: 1.5
    • Meaning: Response times that go outside the upper or lower bands of the EMA value calculated based on the last 20 analysis results are detected as anomalies.
    4. Query/Filter Rate Check

    Query/Filter rate check checks the ratio of query results to filter results.

    Query/Filter Rate Check
    Example configuration of query/filter rate check

    Configuration Fields:

    FieldDescription
    query/filter rate percentEnables expressing the ratio of only the filter result to the query result in the filter and query at runtime as a percentage.
    aboveSpecifies how the found metric will be compared with the next value.
    90Specifies the value to be compared with the metric.
    for ... timeSpecifies that this condition must be met for the last ... times.

    Example Scenario:

    • Query/Filter Rate: 90%
    • Operator: Above
    • Repeat Count: 3
    • Meaning: Anomaly is detected when the ratio of query results to filter results exceeds 90% and this situation is repeated 3 times.

Step 5: Action Configuration

Configure actions to be triggered when an anomaly is detected:

Adding Actions
Select Action

Click the "Select Action" button

Select Action Type

Supported action types:

  • Email: Sends email notification
  • API Call: Sends HTTP POST request
  • Webhook: Sends notification to webhook endpoint
  • And more...
Complete Action Configuration

Fill in the necessary information according to the action type

not

For detailed information about actions, see the Connectors page.

Step 6: Saving

After filling in all information:

  1. Make sure form validations pass:

    • ✅ Name entered and available
    • ✅ Environment selected
    • ✅ Query defined
    • ✅ At least one condition defined
    • ✅ Scheduling settings configured
  2. Click the "Save" button

  3. After the detector is saved, you are automatically redirected to the listing page

Monitoring and Reporting Results

Accessing Results Page

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

Results Page Sections

1. Results Table

Table showing detailed results of each analysis run:

Columns:

  • Date/Time: Date and time when the analysis run was performed
  • Condition Results: Result of each condition:
  • 🟢 Not Met (NOT MET): Condition not met (normal)
  • 🔴 Met (MET): Condition met (anomaly detected)
  • 🟠 Error (ERROR): Error occurred during analysis
  • General Result:
  • 🟢 Not Met: All conditions not met (normal)
  • 🔴 Met: At least one condition met (anomaly detected)
  • Operations: Menu button (⋮)
Operation Results
Anomaly Detector operation results page
2. Condition Charts

Charts showing values over time for each condition:

  • Metric Charts: Change of metric values over time
  • EMA Charts: EMA values and upper/lower bands
  • Anomaly Markers: Points where anomalies were detected on the chart
ipucu

It is also possible to see these values graphically in the Overview tab.

3. Viewing Result Details
  1. Click the menu button (⋮) in the table
  2. Select one of the following options:
  • View Error Message: View errors that occurred during analysis
  • View Condition Results: View detailed results of each condition
  • View Action Results: View notification sending status
  • Delete: Delete the result

Anomaly Detector Management

List Page Features

You can view and manage all your detectors on the detector list page.

Search and Filtering
  • Search by Name: Filter detectors by typing in the name field
  • Search by Description: Search by typing in the description field
  • Project Filter (in Admin mode): View detectors from multiple projects
  • Clear: Click the eraser icon to clear all filters
Table Columns
  • Name: Name of the detector (clickable, goes to results page)
  • Description: Detector description
  • Environment: Analyzed environment
  • Status: Active/Passive status (can be changed with toggle)
  • Project (in Admin mode): Project the detector belongs to
  • Operations: Menu button (⋮)
Operations Menu

You can perform the following operations by clicking the menu button (⋮) for each detector:

  1. Results: View analysis results of the detector
  2. Edit: Update detector settings
  3. Delete: Delete the detector
  4. Move to Global (if it's a project detector): Move the detector to global project
Changing Status

To change the active/passive status of the detector:

  1. Click the toggle in the Status column in the table
  2. Detector status is updated instantly
  3. Passive detectors do not run, but historical data is preserved

Best Practices

Naming Rules
  • Use descriptive names: Response Time Anomaly Detection
  • Add project/module prefix: E-Commerce - Error Rate Monitoring
  • Add environment information: Production - Traffic Anomaly Detector
Query and Filter Strategy
  • Use specific queries
  • Improve performance by filtering unnecessary data
  • Select appropriate date range (too wide ranges reduce performance)
Condition Configuration
  • Metric conditions: For simple threshold checks
  • Rate conditions: To detect changes
  • EMA conditions: For statistical anomaly detection
  • Reduce false positives by increasing repeat count
EMA Sensitivity Settings
  • High Sensitivity (0.5-1.0): For critical systems
  • Medium Sensitivity (1.0-1.5): For normal systems (recommended)
  • Low Sensitivity (1.5-2.0): For test systems

Frequently Asked Questions

How Often Does the Detector Run?

The frequency of detector runs depends on the Scheduling (Cron Expression) settings you specify when creating it. For example:

  • 0 */5 * ? * * → Every 5 minutes
  • 0 0 * ? * * → Every hour
  • 0 0 9 * ? * → Every day at 09:00
What Happens When the Detector is Set to Passive?

When the detector is set to passive:

  • No new analyses are performed
  • Existing scheduled jobs are cancelled
  • Historical results are preserved and can be viewed
  • Detector continues normal operation when set to active again
What is the Difference Between Metric, Rate, and EMA Conditions?
  • Metric Condition: Did the value exceed a certain threshold? (Simple threshold check)
  • Rate Condition: Did the value increase/decrease by a certain rate? (Change check)
  • EMA Condition: Is the value statistically abnormal? (Statistical analysis)
How Should EMA Sensitivity Be Set?

EMA sensitivity determines how sensitive anomaly detection will be:

  • High Sensitivity (0.5-1.0): Detects more anomalies (more sensitive)
  • Medium Sensitivity (1.0-1.5): Balanced anomaly detection (recommended)
  • Low Sensitivity (1.5-2.0): Detects fewer anomalies (less sensitive)

Recommendation: Start with medium sensitivity (1.0-1.5), adjust based on results.

What is the Purpose of Repeat Count?

Repeat count is used to reduce false positives:

  • Repeat Count: 1: Anomaly is detected when condition is met once
  • Repeat Count: 3: Anomaly is detected when condition is met 3 times consecutively

Recommendation: Use low repeat count (1-2) for critical systems, high repeat count (3-5) for normal systems.

Can I Use Multiple Conditions?

Yes, you can use multiple conditions. Anomaly is detected when at least one condition is met. For example:

  • Condition 1: Response time > 1000 ms
  • Condition 2: Error rate > 10%
  • Result: Anomaly is detected when either of the two conditions is met
What is the Difference Between Query and Filter?
  • Query: Defines the API traffic to be analyzed (which APIs, which methods, etc.)
  • Filter: Further narrows down query results (date range, result type, etc.)

Troubleshooting

Detector Not Running

Possible Causes:

  1. Detector may be in passive status → Check status toggle
  2. Scheduling settings may be wrong → Check cron expression
  3. Environment may not have Elasticsearch integration → Check environment settings
  4. Query may be incorrectly configured → Check query settings

Solution:

  • Set detector status to active
  • Check scheduling settings
  • Check environment Elasticsearch integration
  • Check query configuration
All Results in 'Error' Status

Possible Causes:

  1. Query incorrectly configured
  2. Filter incorrectly configured
  3. Elasticsearch connection issue
  4. No data

Solution:

  • Check query configuration
  • Check filter configuration
  • Check Elasticsearch connection
  • Check if data exists
Too Many False Positives

Possible Causes:

  1. Threshold values too low
  2. Repeat count too low
  3. EMA sensitivity too high

Solution:

  • Increase threshold values
  • Increase repeat count
  • Decrease EMA sensitivity
Too Few Anomalies Detected

Possible Causes:

  1. Threshold values too high
  2. EMA sensitivity too low
  3. Repeat count too high

Solution:

  • Decrease threshold values
  • Increase EMA sensitivity
  • Decrease repeat count

Additional Resources