Fixes #966 Usage dashboard documentation #1646
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| --- | ||
| title: Usage Dashboard | ||
| weight: 300 | ||
| --- | ||
|
|
||
| # Usage Dashboard | ||
|
Contributor
There was a problem hiding this comment. I think we could make this section a bit clearer by stating that the usage is reported for the entire customer organization encompassing deployments across all geographies. |
||
|
|
||
| The Usage Dashboard provides detailed insights into your NGINX as a Service resource consumption. View hourly usage metrics to track costs, analyze patterns, and optimize your deployments. Use the dashboard to analyze daily traffic patterns, plan capacity requirements, and optimize geographic distribution across regions. | ||
|
|
||
| Use this dashboard to revie daily and monthly usage trends, monitor peak traffic hours to plan scaling strategies and compare performance across different regions to optimize deployment location. | ||
|
|
||
| ## Detailed Per-Deployment Analysis | ||
|
|
||
| This dashboard provides granular, per-deployment usage analysis beyond GCP Marketplace aggregate reports. View individual deployment consumption, namespace-specific usage, and hourly patterns for each deployment. | ||
|
Contributor
There was a problem hiding this comment.
Do we refer this anywhere in our service yet? If not, either:
Our goal is to provide a detailed view of usage patterns for a customer across their deployments. Google Cloud gets the usage data and generate reports and bills customers also, which leans into cost discussions from a user standpoint. |
||
|
|
||
| ## Viewing Your Usage Data | ||
|
|
||
| Access your usage dashboard to view consumption metrics across all your deployments. The dashboard displays hourly usage data that you can filter and analyze based on your needs. | ||
|
|
||
| ## Available Filters | ||
|
|
||
| ### Time Period Selection | ||
|
|
||
| Choose the time range for your usage analysis: | ||
|
|
||
| - **Start Date & Time**: Beginning of the period you want to analyze | ||
| - **End Date & Time**: End of the period you want to analyze | ||
|
|
||
| *Time periods can range from a single hour to several months, depending on your analysis needs. All times are displayed in UTC.* | ||
|
|
||
| ### Filtering Options | ||
|
|
||
| Narrow down your usage data using these filters. You can combine multiple filters to get more precise usage insights: | ||
|
|
||
| | Filter | Description | Use Case | | ||
| |--------|-------------|----------| | ||
| | **Namespace** | Filter by namespace | View usage for specific application environments (e.g., production, staging) | | ||
| | **Region** | Filter by cloud region | Analyze regional usage patterns | | ||
| | **Deployment** | Filter by specific deployment | Focus on individual deployment performance and consumption | | ||
|
Contributor
There was a problem hiding this comment. performance is a broad term. Let's not use it here or we should consider defining what it means here. I think you want to call out usage and consumption patterns. Some of what we will show here will fall under how a deployment is doing in terms of NCUs or data processed but performance will also bleed into RPS type metrics (or traffic) which is not what we are trying to show here. |
||
|
|
||
| ## Usage Metrics Explained | ||
|
|
||
| ### Hourly Data Points | ||
|
|
||
| Usage data is collected and displayed on an hourly basis. Each hour shows: | ||
|
|
||
| - **Timestamp**: The specific hour when usage was recorded | ||
| - **Location Details**: Namespace, region, and deployment information | ||
| - **Consumption Metrics**: Detailed usage measurements | ||
|
|
||
| ### Usage Meters | ||
|
|
||
| Your usage dashboard tracks several types of consumption: | ||
|
|
||
| | Meter Type | Description | | ||
| |------------|-------------| | ||
| | **Fixed** | Base service cost | | ||
| | **NCU (NGINX Compute Units)** | Processing capacity used | | ||
|
Contributor
There was a problem hiding this comment. let's reference our billing docs here for definitions please: https://docs.nginx.com/nginxaas/google/billing/overview/ |
||
| | **Data Processed** | Volume of data handled | | ||
|
|
||
| ## Usage Data Display | ||
|
|
||
| ### Navigation | ||
| For large datasets, the dashboard provides: | ||
|
Contributor
There was a problem hiding this comment. This is true regardless right, i.e., we will handle pagination if the data grows and aid with navigation? or does a customer need to do something for |
||
| - **Pagination**: Navigate through multiple pages of results | ||
| - **Page Size Options**: Choose how many records to display per page (up to 1,000) | ||
| - **Quick Navigation**: Jump between pages efficiently | ||
|
|
||
| ## Data Retention | ||
| Historical usage data is available for up to one year, allowing for comprehensive analysis and trend identification. | ||
|
Contributor
There was a problem hiding this comment. nit: consider highlighting the retention duration. |
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a good start!! I think we need to add a section here as to how a user can use the usage dashboard, i.e, call out a flow as to how a user comes into the console, browses over to their usage details page, sets a time-window, sets some filters and sees some data/dashboard.
This is the UI side of it and is important to call out. We do not really need screenshots but a flow of how to view usage data.