> This page is for Self-Hosted, version v3.0 (default). > For other versions, use one of these documentation indexes: > - v3.0 (default): https://docs.nvidia.com/run-ai/self-hosted/v3.0/llms.txt > - v2.26: https://docs.nvidia.com/run-ai/self-hosted/v2.26/llms.txt > - v2.25: https://docs.nvidia.com/run-ai/self-hosted/v2.25/llms.txt > - v2.24: https://docs.nvidia.com/run-ai/self-hosted/v2.24/llms.txt > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.nvidia.com/run-ai/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/run-ai/_mcp/server. # Reports This section explains the procedure of managing reports in NVIDIA Run:ai. Reports allow users to access and organize large amounts of data in a clear, CSV-formatted layout. They enable users to monitor resource consumption, analyze trends, and make data-driven decisions to optimize their AI workloads effectively. ## Report Types Currently, only consumption reports are available, which provides insights into the consumption of resources such as GPU, CPU, and CPU memory across organizational units. ## Reports Table The Reports table can be found under **Analytics** in the NVIDIA Run:ai platform. The Reports table provides a list of all the reports defined in the platform and allows you to manage them.
Users are able to access the reports they have generated themselves. Users with project viewing permissions throughout the tenant can access all reports within the tenant. The Reports table comprises the following columns: | Column | Description | | ----------------- | ------------------------------------------------------------------------- | | Report | The name of the report | | Description | The description of the report | | Status | The different lifecycle phases and representation of the report condition | | Type | The type of the report – e.g., consumption | | Created by | The user who created the report | | Creation time | The timestamp of when the report was created | | Collection period | The period in which the data was collected | ### Reports Status The following table describes the reports' condition and whether they were created successfully: | Status | Description | | ------------- | -------------------------------------------------- | | Ready | Report is ready and can be downloaded as CSV | | Pending | Report is in the queue and waiting to be processed | | Failed | The report couldn’t be created | | Processing... | The report is being created | ### Customizing the Table View * Filter - Click ADD FILTER, select the column to filter by, and enter the filter values * Search - Click SEARCH and type the value to search by * Sort - Click each column header to sort by * Column selection - Click COLUMNS and select the columns to display in the table ## Creating a New Report Before you start, make sure you have a project. To create a new report: 1. Click **+NEW REPORT** 2. Enter a **name** for the report (if the name already exists, you will need to choose a different one) 3. Optional: Provide a description of the report 4. Set the report’s data collection period * Start date - The date at which the report data commenced * End date - The date at which the report data concluded 5. Set the report segmentation and filters * Filters - Filter by project or department name * Segment by - Data is collected and aggregated based on the segment 6. Click **CREATE REPORT** ## Deleting a Report You can delete a single report, or select multiple reports to delete them together. 1. Select one or more reports you want to delete, using the checkbox in each row 2. Click **DELETE** 3. On the dialog, review the number of reports to be deleted, then click **DELETE** to confirm If any of the selected reports fail to delete, an error message identifies the first failed report and the total number of reports that failed. ## Downloading a Report **Note** To download, the report must be in status “Ready”. Download acts on a single report at a time — if more than one report is selected, the **DOWNLOAD CSV** button is disabled. 1. Select the report you want to download 2. Click **DOWNLOAD CSV** ## Enabling Reports for Self-Hosted Accounts Reports must be saved in a storage solution compatible with S3. To activate this feature for self-hosted accounts, the storage needs to be linked to the account. The configuration should be incorporated into ConfigMap and Secret objects within the Control Plane. **Breaking change from version 2.24:** The access key is stored in the Secret under the key `S3.ACCESS_KEY` (with a dot), replacing the previous `S3_ACCESS_KEY` (with an underscore) used in earlier versions. When upgrading from a version prior to 2.24, rename this key in the Secret accordingly. 1. Edit the `runai-backend-org-unit-service` ConfigMap and add the following lines: ```bash kubectl edit cm runai-backend-org-unit-service -n runai-backend ``` ```bash S3_ENDPOINT: S3_ACCESS_KEY_ID: S3_USE_SSL: "true" S3_BUCKET: ``` 2. Edit the `runai-backend-org-unit-service` Secret and add the following to the `data` section (value must be base64-encoded): ```bash kubectl edit secret runai-backend-org-unit-service -n runai-backend ``` ```bash S3.ACCESS_KEY: ``` 3. Edit the `runai-backend-metrics-service` ConfigMap and add the following lines: ```bash kubectl edit cm runai-backend-metrics-service -n runai-backend ``` ```bash S3_ENDPOINT: S3_ACCESS_KEY_ID: S3_USE_SSL: "true" ``` 4. In the same ConfigMap, under the `config.yaml` section, add the following right after `log_level: "Info"`: ```yaml reports: s3_config: bucket: "" ``` 5. Edit the `runai-backend-metrics-service` Secret and add the following to the `data` section (value must be base64-encoded): ```bash kubectl edit secret runai-backend-metrics-service -n runai-backend ``` ```bash S3.ACCESS_KEY: ``` 6. Restart the deployments: ```bash kubectl rollout restart deployment runai-backend-metrics-service runai-backend-org-unit-service -n runai-backend ``` 7. Refresh the page to see **Reports** under Analytics in the NVIDIA Run:ai platform. ## Using API To view the available actions, go to the [Reports](https://docs.nvidia.com/run-ai/self-hosted/v3.0/reference/rest-api/endpoints/organizations/reports/list-reports) API reference.