Fixes #966 Usage dashboard documentation #1646
Conversation
github-actions
bot
added
the
documentation
|
🎉 Thank you for your contribution! It appears you have not yet signed the F5 Contributor License Agreement (CLA), which is required for your changes to be incorporated into an F5 Open Source Software (OSS) project. Please kindly read the F5 CLA and reply on a new comment with the following text to agree: I have hereby read the F5 CLA and agree to its terms You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot. |
✅ Deploy Preview will be available once build job completes!
|
|
|
||
| # Usage Dashboard | ||
|
|
||
| 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. Common use cases include cost analysis, performance monitoring, and regional strategy planning. |
There was a problem hiding this comment.
can you track costs? or just usage and analyze usage patterns?
There was a problem hiding this comment.
and optimize geographic distribution across regions.
Can you please elaborate what you might be trying to say here^^
There was a problem hiding this comment.
just usage, will update it to be usage.
| |--------|-------------|----------| | ||
| | **Namespace** | Filter by Kubernetes namespace | View usage for specific application environments (e.g., production, staging) | | ||
| | **Region** | Filter by cloud region | Analyze regional usage patterns and costs | | ||
| | **Deployment** | Filter by specific deployment | Focus on individual deployment performance and consumption | |
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.
| | Meter Type | Description | | ||
| |------------|-------------| | ||
| | **Fixed** | Base service cost | | ||
| | **NCU (NGINX Compute Units)** | Processing capacity used | |
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/
|
|
||
| ## 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. |
There was a problem hiding this comment.
beyond GCP Marketplace aggregate reports
Do we refer this anywhere in our service yet? If not, either:
- We should define what these aggregate reports are properly and where a user can locate these.
- Or steer away from it and focus on usage data only.
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.
| - **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. No newline at end of file |
There was a problem hiding this comment.
nit: consider highlighting the retention duration.
| ## Usage Data Display | ||
|
|
||
| ### Navigation | ||
| For large datasets, the dashboard provides: |
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 large datasets?
| @@ -0,0 +1,68 @@ | |||
| --- | |||
There was a problem hiding this comment.
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.
| weight: 300 | ||
| --- | ||
|
|
||
| # Usage Dashboard |
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.
janakimeyyappan
force-pushed
the
add_usage_dashboard_docs
branch
from
d01df58 to
103ef6a
Compare
Usage dashboard feature documentation
Update public facing documentation outlining how a user can leverage console usage reporting, documents the different filters used to get usage info and info about usage data retention.