Skip to main content
Version: 4.6.1

Project

In NetFUNNEL, a Project is a core component for traffic control, serving as the top-level management unit that logically groups segments together.

Understanding Projects​

What is a Project?​

Think of a Project as your main workspace in NetFUNNEL. It's like having a dedicated office for each of your services - one project per service makes it easy to manage your traffic control needs.

Each project can use resources including the maximum number of concurrent users (PCCU) and how many segments you can create within it.

How Projects Fit Together​

Project 1
├── Segment 1 (Basic Control)
├── Segment 2 (Section Control)
└── Segment N

Project Relationships​

Project ↔ Segment​

Projects are like containers that hold related segments together. They share common settings and can be managed as a group, all identified by the same project key.

Project ↔ Service Domain​

Your service domains (like your website) connect to NetFUNNEL through the project key, allowing them to use the traffic control features.

Planning Your Projects​

When Should You Create Separate Projects?​

The main question is: "Do my services have different needs?" If yes, separate projects might be the way to go. Here are the most common scenarios:

When to Split Projects
  • Different traffic needs: One service needs 10,000 users, another needs 1,000
  • Different user groups: Customers vs. administrators vs. internal staff
  • Different locations: Main office vs. branch offices

Different Traffic Requirements​

If your services have very different traffic patterns, separate projects make sense.

Example: Online store

  • Main shopping site (shop.yourdomain.com) → Handles 10,000 concurrent users
  • Support portal (support.yourdomain.com) → Only needs 1,000 concurrent users

Different User Groups​

When you have distinct user types, separate projects help with organization.

Example: SaaS platform

  • Customer portal (sub1.yourdomain.com) → Your customers
  • Admin portal (sub2.yourdomain.com) → Your internal team

Different Locations or Teams​

Separate projects work well for different geographic locations or organizational units.

Example: University

  • Main campus (campus1.university.edu) → Main student body
  • Branch campus (campus2.university.edu) → Smaller branch location

Managing Projects​

Creating new projects is straightforward. You can create them directly in the NetFUNNEL console. Once created, you can rename them anytime.

Naming Your Projects (Make it Clear!)​

Good names that tell you what they do:

  • "E-commerce Main Site"
  • "Customer Support Portal"
  • "Admin Dashboard"
  • "Mobile App Production"

Avoid these confusing names:

  • "Project 1", "Test", "New Project"
  • Names that don't tell you what the service actually does
  • Names that are too generic or temporary

Pro Tip: When you have multiple environments, include that in the name:

  • "E-commerce Main Site - Production"
  • "E-commerce Main Site - Staging"
What You Need to Know
  • Creating projects: You can create them directly in the NetFUNNEL console
  • What you can change: Project names (deletion isn't supported)
Project Deletion

Once created, projects cannot be deleted. If you no longer need a project, refer to the Project Deactivation Guide.

Working with Project Keys​

What's a Project Key?​

Think of a Project Key as your project's ID card. When your NetFUNNEL agent talks to the NetFUNNEL server, it uses this key to say "Hey, I'm from this specific project!"

How Do Project Keys Work?​

Code-based Integration (You specify it in your code)​

In code-based integration, you explicitly specify the project key and segment key in your application code. This method gives you direct control over when and how NetFUNNEL traffic control is applied.

Android/iOS Integration:

Netfunnel.nfStart(
    projectKey = "your_project_key",    // Grab this from console
    segmentKey = "your_segment_key",     // Grab this from console
    callback = yourCallback,
    activity = this
)

Web Integration:

nfStart({
    projectKey: "your_project_key",
    segmentKey: "your_segment_key"
});

URL-trigger Integration (It figures it out automatically)​

With URL-trigger, NetFUNNEL is smart enough to automatically figure out which project key to use based on your URL pattern. You don't need to put anything in your code!

Where Can I Find My Keys?​

You can find your project keys in the NetFUNNEL console. For detailed instructions on where to find and how to copy your project keys, see the Interface Guide guide.