[Index]

Model: data/MetricDatabaseCollectionStats

Database Statistics

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

The sysadmin user has access to the Database Statistics menu (menu model: data/MetricDatabaseCollectionStats) that shows the weekly and monthly collection metrics internal database collections.

Note

The Configuration menu allows for SNMP alerts to be configured if thresholds are reached in total Data Size and Index Size.

Stores aggregate metrics for database collection statistics grouped by week or month.

Model Details: data/MetricDatabaseCollectionStats

Title Description Details
Year *
  • Field Name: year
  • Type: String
  • MaxLength: 4
Grouping * The period over which the metric aggregation relates to. Valid options are "Month" and "Week".
  • Field Name: grouping
  • Type: String
  • MaxLength: 5
  • Choices: ["Week", "Month"]
Group Number Unique identifier for a aggregation period. Example: if grouping is by month, a value of 1 implies January.
  • Field Name: group_number
  • Type: String
  • MaxLength: 2
Group Start Date The start date for this aggregation group.
  • Field Name: group_start_date
  • Type: String
  • Format: date
Group End Date The end date for this aggregation group.
  • Field Name: group_end_date
  • Type: String
  • Format: date
Top Collections by Data Size Array of top collections by data size.
  • Field Name: top_collections_by_data_size.[n]
  • Type: Array
Name * Name of a database collection.
  • Field Name: top_collections_by_data_size.[n].name
  • Type: String
  • MaxLength: 256
Average Data Size (bytes) Calculated average of all data size samples (in bytes) over the duration of the group.
  • Field Name: top_collections_by_data_size.[n].avg_data_size
  • Type: Integer
Top Collections by Index Size Array of top collections by index size.
  • Field Name: top_collections_by_index_size.[n]
  • Type: Array
Name * Name of a database collection.
  • Field Name: top_collections_by_index_size.[n].name
  • Type: String
  • MaxLength: 256
Average Index Size (bytes) Calculated average of all index size samples (in bytes) over the duration of the group.
  • Field Name: top_collections_by_index_size.[n].avg_index_size
  • Type: Integer
Top Collections by Number of Documents Array of top collections by document count.
  • Field Name: top_collections_by_num_docs.[n]
  • Type: Array
Name * Name of a database collection.
  • Field Name: top_collections_by_num_docs.[n].name
  • Type: String
  • MaxLength: 256
Average Number of Documents Calculated average of all number of documents over the duration of the group.
  • Field Name: top_collections_by_num_docs.[n].avg_num_docs
  • Type: Integer