Skip to main content

User Panel

This article contains API examples, for full API documentation for your version of the User Panel navigate to the API Swagger documentation which can be found at:
https://user-panel-url/api/docs

User Panel Team Billing and Usage Statistics Guide

This guide provides an overview of how the user panel displays team billing information, pricing policies, and resource consumption statistics. It explains how to interpret the data and use it for cost management and resource optimization.

The user panel is your primary interface for managing cloud resources, teams, and billing information. It provides detailed insights into:

1. Team resource consumption and associated costs

2. Workspace-specific billing information

3. Applied pricing policies and their impact on billing

4. Historical usage trends and statistics

Team Billing Dashboard

Accessing Team Billing

The team billing dashboard provides a comprehensive overview of your team's resource consumption and associated costs:

GET /team-billing/{team_id}/{start_date}/{end_date}/{interval}

Parameters:

- team_id: Your team's unique identifier

- start_date: Beginning of the billing period

- end_date: End of the billing period

- interval: Granularity of the data (e.g., "day", "month")

Understanding Billing Components

The team billing dashboard displays several key components:

1. Total Billing: The total cost for the selected period

2. Resource Breakdown: Costs broken down by resource type:

   - CPU usage (core-hours)

   - RAM usage (GB-hours)

   - Storage usage (GB-hours)

   - Network traffic (MB)

   - GPU usage (GPU-hours and TFLOPS)

3. Currency Information: The currency code and symbol used for billing

4. Applied Pricing Policy: The pricing policy currently assigned to your team

Workspace-Specific Billing

For teams with multiple workspaces, you can view billing information grouped by workspace:

GET /team-billing/group-by-workspace/{team_id}/{start_date}/{end_date}/{interval}

Understanding Resource Usage Statistics

Team Metrics

Team metrics provide insights into your team's resource consumption patterns:

Daily Metrics

Daily team metrics include:

- Average RAM consumption (MB)

- Average CPU utilization (%)

- Average GPU utilization (%)

- Average GPU RAM utilization (MB)

- Total TFLOPS consumed

These metrics are aggregated from hourly data and provide a day-level view of resource consumption.

Hourly Metrics

Hourly team metrics provide more granular insights into resource consumption patterns throughout the day, helping you identify peak usage periods and optimize resource allocation.

Instance-Specific Statistics

For each instance in your team, the system collects detailed statistics:

Instant Statistics

Collected at frequent intervals (typically every minute), these statistics include:

- RAM usage (GB)

- Disk usage (GB)

- CPU count and utilization

- GPU usage hours and TFLOPS

- Network traffic (in/out) for public and private networks

- IOPS for boot and additional disks

- Power state (On/Off)

Aggregated Statistics

These instant statistics are aggregated into hourly and daily statistics for easier analysis and billing calculations.

Pricing Policies and Cost Management

Understanding Your Pricing Policy

Each team is assigned a pricing policy that determines the cost of resource consumption. The pricing policy includes:

1. Resource Rates: Cost per unit for each resource type:

   - CPU: Cost per core-hour

   - RAM: Cost per GB-hour

   - Storage: Cost per GB-hour

   - Network: Cost per MB transferred

   - GPU: Cost per GPU-hour and/or TFLOPS

2. Inclusive Amounts: Free resource allocations included with your plan

   - CPU: Amount per core per hour included

   - RAM: Amount per GB per hour included

   - Storage: Amount per GB per hour included

   - Network: Amount per MB per hour included

   - GPU: Amount per GPU Pool oer hour and/or TFLOPS per hour included

3. Currency: The currency used for billing calculations

You can view your team's assigned pricing policy in the team details section:

{

  "policy_info": {

    "pricing_policy": {

      "id": "policy-uuid",

      "name": "Standard Pricing"

    }

  }

}

Understanding Inclusive Amounts

Inclusive amounts represent the "free tier" or included resources that come with your pricing policy. These are resources you can use without incurring additional charges:

How Inclusive Amounts Work

1. Resource Allocation: Each pricing policy includes specific amounts of resources (CPU, RAM, storage, etc.) costs per hour that are provided at no additional cost.

2. Billing Application: When calculating your bill:

   - The system first applies your usage against the inclusive amounts

   - Only usage exceeding the inclusive amounts is charged at the standard rate

   - Unused inclusive amounts do not roll over to the next billing period

Example of Inclusive Amounts

If your pricing policy includes the pricing policy equivalent to

- 100 CPU cores

- 200 GB of RAM

- 500 GB of storage

And your actual usage is:

- 150 CPU cores

- 180 GB of RAM

- 600 GB of storage

Your billable usage for an hour would be:

- 50 CPU cores (150 - 100)

- 0 GB of RAM (180 < 200, fully covered by inclusive amount)

- 100 GB of storage (600 - 500)

Cost Estimation for New Resources

Before creating new instances, you can estimate the cost using the instance billing estimate feature via API, this is also used in the User Panel UI to guide users when creating new instances:

POST /calculate-instance-billing-estimate

Pricing Policy Management

Full Administrators can manage pricing policies through the User panel:

1. Create Pricing Policies: Define new pricing structures

2. Assign Policies to Teams: Associate teams with specific pricing policies

3. Update Resource Prices: Modify prices for individual resources

Understanding Billing Calculations

Resource Usage Calculation

Billing is calculated based on resource usage over time:

1. CPU Billing

   CPU Cost = CPU Hours × CPU Price per Hour

2. RAM Billing:

   RAM Cost = RAM Hours × RAM Price per GB-Hour

3. Storage Billing:

   Storage Cost = Disk Hours × Storage Price per GB-Hour

4. Network Billing:

   Network Cost = Network Traffic (MB) × Network Price per MB

5. GPU Billing:

   GPU Cost = GPU Usage Hours × GPU Price per Hour

Billing Periods

Billing is calculated based on the actual usage during the specified period:

1. Hourly Billing: Resources are billed based on actual usage hours.

2. Daily Aggregation: Hourly usage is aggregated into daily totals for easier analysis.

Pricing Policies and Billing Calculation

Pricing Policy Structure

Pricing policies define how resources are billed. Each policy includes:

1. Resource Pricing: Cost per unit for CPU, RAM, storage, etc.

2. Currency Information: Currency code and symbol

3. Team Association: Which teams the policy applies to

Billing Calculation Process

The billing calculation process involves several steps:

1. Policy Determination: The system identifies the pricing policy applicable to a team

2. Resource Usage Calculation: It retrieves statistics for the specified time period

3. Cost Calculation: It applies the pricing policy to the resource usage

4. Aggregation: It aggregates costs by resource type, instance, workspace, etc.

Billing Calculation for Different Resources

Instance Billing

For each instance, the system calculates:

- CPU cost = CPU hours × CPU price per hour

- RAM cost = RAM hours × RAM price per GB-hour

- Storage cost = Disk hours × Storage price per GB-hour

- Network cost = Network traffic × Network price per MB

GPU Pool Billing

GPU Pool billing is calculated based on:

- GPU Pool usage hours

- TFLOPS consumed

- vRAM consumed

Additional Resource Billing

The system also calculates billing for:

- GPU cards

- Network traffic

Troubleshooting Billing Issues

1. Unexpected Costs: If you notice unexpected costs, check for:

   - Recently created resources

   - Changes in resource utilization

   - Changes in pricing policy

2. Missing Billing Data: If billing data appears incomplete, verify:

   - The selected date range

   - The status of the instances during that period

3. Discrepancies Between Estimates and Actual Costs: These may be due to:

   - Changes in resource utilization

   - Differences between estimated and actual usage patterns

   - Updates to pricing policies