Skip to main content
Version: 4.6.1

Welcome to NetFUNNEL Docs

Welcome to the NetFUNNEL 4 documentation. This comprehensive guide will help you understand, integrate, and effectively use NetFUNNEL to protect your applications and ensure optimal user experience.

What is NetFUNNEL?​

NetFUNNEL is a Virtual Waiting Room (VWR) solution that prevents system overload by managing traffic surges and queuing users instead of showing error pages.

Through real-time traffic analysis and control, NetFUNNEL helps service operators efficiently manage IT resources and maintain stable service performance. Unlike traditional APM (Application Performance Monitoring) tools that focus on monitoring and analysis after failures occur, NetFUNNEL prevents system overload in advance by controlling traffic flow and providing a managed waiting experience. It optimizes resources for each service and can be used together with APM to enable multi-dimensional service operations, thereby preventing failures in advance and providing a stable service environment.

The NetFUNNEL Difference​

Proactive Prevention, Not Reactive Monitoring

  • Before failures: Real-time traffic analysis and control prevents system overload
  • During traffic surges: Virtual Waiting Room queues users instead of showing error pages
  • Resource optimization: Efficiently manages limited resources while maintaining user experience

Key Features​

🎯 Virtual Waiting Room (VWR)​

Prevent system overload by adjusting the Limited Inflow during traffic surges. Instead of meaningless error pages, visitors can understand the service provision status in the Waiting Room, and service providers can efficiently manage limited resources and provide a better experience.

  • Multiple Types: Basic Waiting Room, Pre-waiting Room, Post-waiting Room, and Block Room
  • Customizable Themes: 5 theme types (Modal, Module, Banner, Notice Emphasis, Image Emphasis)
  • Brand Customization: Logo, images, colors, and content
  • Queue Information: Queue position and estimated wait time display
  • Live Messages: Real-time text updates (maximum 20 characters)

📊 Real-time Monitoring​

Visualize key metrics such as queue size, entry requests, and wait time in real-time, allowing you to grasp the service status at a glance and respond immediately without complex numerical interpretation.

  • Two View Modes: Default View (numerical comparison) and Classic View (visual funnel animation)
  • Project-level & Segment-level: Monitor at both project and segment granularity
  • Real-time Dashboards: Live traffic visualization and metrics tracking
  • Historical Data: Comprehensive reporting and analytics

🔧 Easy Integration​

Choose the integration method that fits your needs:

  • URL-Triggered Integration (UTI): No code changes required - configure trigger rules in console
  • Code-based Integration (CBI): Precise control with JavaScript, Android, or iOS SDKs
  • Multi-platform Support: Web, mobile (Android/iOS), and API integrations

🎨 Customization​

Instead of loading screens, provide customized waiting rooms that contain images/content, making customers' waiting time more meaningful.

Core Concepts​

Project​

The top-level concept for performing inflow control in your license (subscription). NetFUNNEL integrates and manages services by project unit. Each project has a unique Project Key used for API access and traffic control.

Segment​

A work unit for applying and managing Basic Control/Section Control for traffic control. Each segment has a unique segment key.

  • Basic Control: Controls entry speed for specific actions or URLs

    • Key returned quickly after action completes
    • Supports both URL-Triggered Integration and Code-based Integration
    • Supports Variable Type for automatic capacity adjustment

  • Section Control: Maintains fixed capacity for entire sections

    • Key held until section exit (entire process completes)
    • Code-based Integration only
    • Fixed Type only (constant capacity limit)

Waiting Room​

A space where users wait instead of directly accessing the server during traffic surges. It operates differently depending on the situation and traffic control requirements.

  • Basic Waiting Room: Standard waiting functionality for sequential entry
  • Pre-waiting Room: Pre-reservation functionality for early access
  • Post-waiting Room: Post-completion handling for users finishing their session
  • Block Room: Entry restriction functionality for denied access

Getting Started​

For First-Time Users​

  1. Understanding NetFUNNEL - Learn the basics and core concepts
  2. Getting Started with NetFUNNEL - Set up your account and console
  3. Core Concepts - Understand key terminology and concepts

For Developers - Quick Integration​

Web Applications​

Start with our JavaScript Agent Quickstart to get up and running in 5-10 minutes.

Mobile Applications​

For Console Users​

Integration Methods​

URL-Triggered Integration​

Best for: Landing pages, promotions, page-level protection

  • Setup: Configure trigger rules in console (no code changes)
  • User Experience: Redirect to waiting room, then return to target page
  • Key Management: Automatic key return by default
  • Use Cases: Campaign pages, event URLs, external link protection

Code-based Integration​

Basic Control​

Best for: Button clicks, API calls, precise control

  • Controls: Entry speed (how fast users can enter)
  • Key Management: Key returned quickly after action completes
  • User Experience: Modal waiting room on current screen
  • Use Cases: Login, checkout, payment processing, API throttling

Section Control​

Best for: Multi-step processes, checkout flows

  • Controls: Fixed concurrent capacity (fixed number of users in section)
  • Key Management: Key held until section exit (entire process completes)
  • User Experience: Modal waiting room on current screen
  • Use Cases: Multi-step checkout, registration flows, booking processes

Learn more: Integration Methods Overview

Learning Resources​

Sample Projects​

Practice with our Sample Projects:

  • Web Application (Vanilla JavaScript MPA) - Basic web app template
  • Android Application (Single Activity) - Basic Android app template
  • iOS Application (Swift Single View) - Basic iOS app template

Documentation Structure​

Advanced Features​

  • BotManager Basic - Block abnormal and excessive requests
  • EUM (End User Monitoring) - Monitor end-user experience
  • Queue Position Retention - Restore queue position after disconnection
  • Entry Pass - Guaranteed immediate entry without re-waiting
  • Entry Key Invalidation - Force re-queuing for specific conditions
  • Pre/Post Waiting Room Reservation - Schedule waiting rooms before and after events

Need Help?​

  • Documentation: Browse our comprehensive guides
  • Console: Access your NetFUNNEL dashboard
  • Support: Contact our technical support team

Ready to begin? Choose your path above and follow our step-by-step guides!