# Hosting Reports

Our team generates a "Hosting Report" with database metrics that will be added to the SCC Vault automatically on the 1st and 15th of every month.

The column headers for the export are:
- **Database**: Name of the database.
- **DatabaseSizeGB**: Size of the database in gigabytes.
- **InstitutionName**: Name of the institution.
- **DisciplineName**: The name of the discipline.- 
- **CollectionName**: Name of the specific collection.
- **NumCollectionObjects**: Total number of CO records in the collection.
- **LatestCollectionObjectCreated**: Date when the last CO was added.
- **MostCommonCataloger**: Name of the cataloger with the most COs in the collection.

[You can view all hosting reports here.](https://drive.google.com/drive/folders/1JvmTe6Kn-S05q1jQX9WZmpETvaqUzndw?usp=drive_link)

As of 2025-05-13, this is run on the North America report runner EC2 instance using a cronjob.

```bash
HostName ec2-54-163-71-241.compute-1.amazonaws.com
User ubuntu
```

To set this configuration up, you need to clone the [github.com/grantfitzsimmons/run_query](https://github.com/grantfitzsimmons/run_query) repository on each server, located in the ~/run_query/ directory. For each, you need to follow the installation instructions to setup the veritual environment, install the requirements, and create an `.env` file. See those instructions in the [README.md](https://github.com/grantfitzsimmons/run_query/blob/main/README.md) in that repository.

To run the `orchestration.py` script on a central system, it must have SSH access into the servers you wish to get reports for. Each system that will have a report generated for it can specify a `REGION` value in the `.env` file. This is used when constructing the report name (e.g. `swiss`, `northamerica`, `canada`, etc). You can read more about this configuration in the ["Run Remotely"](https://github.com/grantfitzsimmons/run_query#run-remotely) section of the README.

To generate a report on the size of all databases without concern for individual collections, you can switch branches:

```
ubuntu:~/run_query$ git switch size
```

After running `python3 orchestration.py`, it will instead generate a report for the region named `{region_name}_sizes_{YYYY_MM_DD}.csv` instead of simply `{region_name}_{YYYY_MM_DD}.csv`.