Skip to content

splunk get-catalog-metrics-rollup

Use this endpoint to retrieve lists of metric indexes and their rollup summaries for a given metric index.

Description

Retrieve lists of metric indexes and their rollup summaries.

Synopsis

splunk get-catalog-metrics-rollup
    --site <site>
    [--count <count>]
    [--sort_key <sort_key>]
    [--sort_dir <sort_dir>]

Arguments

site - (string)

     Site where this command will be executed
     Example: --site "site-1"
     Default: input.site      Attributes: required

count - (int)

     Limit the number of results returned. Set 0 to return all results.
     Example: --count 0
     Default: 0      Attributes: optional

sort_key - (string)

     Field name to use for sorting.
     Example: --sort_key "updated"
     Default: updated      Attributes: optional

sort_dir - (string)

     Response sort order.
     Example: --sort_dir "sort_dir-1"
     Default: _None_      Attributes: optional

     Validation:
         allowed values: asc, desc

Examples

Input: 

!splunk get-catalog-metrics-rollup
Output: 
UPDATED                     AUTHOR  NAME        APPNAME                   
1970-01-01T05:30:00+05:30   nobody  _metrics    splunk_monitoring_console
Input: 
x= !splunk get-catalog-metrics-rollup
Output: 
{
   "links": {
     "create": "/servicesNS/admin/-/catalog/metricstore/rollup/_new",
     "_reload": "/servicesNS/admin/-/catalog/metricstore/rollup/_reload",
     "_acl": "/servicesNS/admin/-/catalog/metricstore/rollup/_acl"
   },
   "origin": "https://localhost:8089/servicesNS/admin/-/catalog/metricstore/rollup",
   "updated": "2023-02-07T15:04:44+05:30",
   "generator": {
     "build": "dd0128b1f8cd",
     "version": "9.0.3"
   },
   "entry": [
     {
       "name": "_metrics",
       "id": "https://localhost:8089/servicesNS/nobody/splunk_monitoring_console/catalog/metricstore/rollup/_metrics",
       "updated": "1970-01-01T05:30:00+05:30",
       "links": {
         "alternate": "/servicesNS/nobody/splunk_monitoring_console/catalog/metricstore/rollup/_metrics",
         "list": "/servicesNS/nobody/splunk_monitoring_console/catalog/metricstore/rollup/_metrics",
         "_reload": "/servicesNS/nobody/splunk_monitoring_console/catalog/metricstore/rollup/_metrics/_reload",
         "edit": "/servicesNS/nobody/splunk_monitoring_console/catalog/metricstore/rollup/_metrics",
         "remove": "/servicesNS/nobody/splunk_monitoring_console/catalog/metricstore/rollup/_metrics",
         "enable": "/servicesNS/nobody/splunk_monitoring_console/catalog/metricstore/rollup/_metrics/enable"
       },
       "author": "nobody",
       "acl": {
         "app": "splunk_monitoring_console",
         "can_change_perms": true,
         "can_list": true,
         "can_share_app": true,
         "can_share_global": true,
         "can_share_user": false,
         "can_write": true,
         "modifiable": true,
         "owner": "nobody",
         "perms": {
           "read": [
             "admin"
           ],
           "write": [
             "admin"
           ]
         },
         "removable": false,
         "sharing": "app"
       },
       "content": {
         "appName": "splunk_monitoring_console",
         "defaultAggregation": "avg",
         "dimensionListType": "excluded",
         "disabled": true,
         "eai:acl": null,
         "metricList": "spl.intr.resource_usage.Hostwide.data.cpu_system_pct, spl.intr.resource_usage.Hostwide.data.cpu_user_pct",
         "metricListType": "included",
         "minSpanAllowed": 300,
         "summaries": {
           "0": {
             "rollupIndex": "_metrics_rollup",
             "span": "1d"
           }
         }
       }
     }
   ],
   "paging": {
     "total": 1,
     "perPage": 30,
     "offset": 0
   },
   "messages": []
 }

Access Control

To use this command, you need access to the following:

Field Value
Action "read"
Service Type "splunk"
Service Instance
Namespace
Object Type "metric"
Object ID

Please see Access Control for details.