Splunk® IT Service Intelligence

Install and Upgrade Manual

Splunk IT Service Intelligence (ITSI) version 4.11.x reached its End of Life on December 6, 2023. See the Splunk Software Support Policy for details. For information about upgrading to a supported version, see Before you upgrade IT Service Intelligence.
This documentation does not apply to the most recent version of Splunk® IT Service Intelligence. For documentation on the most recent version, go to the latest release.

Share data in Splunk IT Service Intelligence

When Splunk IT Service Intelligence is deployed on Splunk Enterprise, the Splunk platform sends usage data to Splunk Inc. ("Splunk") to help improve Splunk IT Service Intelligence in future releases. For information about how to opt in, and how the data is collected, stored, and governed, see Share data in Splunk Enterprise.

ITSI is packaged with Splunk App for Infrastructure (SAI) for all versions before ITSI 4.9.0. For information about the data that SAI collects, see Share data in Splunk App for Infrastructure in the Install and Upgrade Splunk App for Infrastructure manual. For all versions after ITSI 4.9.0, SAI is no longer packaged with ITSI.

What data is collected

Splunk IT Service Intelligence collects the following basic usage information:

Component Description Example
app.ITSI.performanceMetrics Reports the time taken for a specific method to finish and non-identifiable supporting parameters to clean up the data (measured per 24 hours). 
{
   app: itsi
   component: app.ITSI.performanceMetrics
   data: {
     averageTime: 1.6168572306632996
     cumulativeTime: 6.467428922653198
     medianTime: 1.1328552961349487
     method: itoa_object.get_bulk
     numberOfObjects: 1012
     numberOfTransactions: 4
     p90Time: 2.975279831886292
   }
   deploymentID: 616ee3e9-532b-5b32-8679-0e58f7d3d336
   eventID: 9157E0BA-1A2A-48CC-A738-66AB5E5DEE33
   executionID: 38A07E6C-2CA7-4B6A-88DB-CB8ED52776D7
   optInRequired: 3
   timestamp: 1592906482
   type: aggregate
   visibility: [
     support
     anonymous
   ]
}
app.ITSI.entityTypes Reports the number of entities for each entity type (custom entity types are hashed). 
{
   app: itsi
   component: app.ITSI.entityTypes
   data: {
     countOfAssociatedEntities: 10
     entityTypeIds: a0745f7ed88cfac6058d1d4cfb57bc71127a28ad7c6756004142a90aab5ee99f
   }
   deploymentID: 417a2431-e14d-5550-b3dc-8d72442dc74a
   eventID: 51F77E4B-D866-49FB-B2F5-463258AC9FC7
   executionID: 661BB29D-A390-4B40-B17C-E5EFF48EE183
   optInRequired: 3
   timestamp: 1592820124
   type: aggregate
   visibility: [
     anonymous
     support
   ]
}
app.ITSI.entityTypeToEntityRatio Ratio of in-use entity types to entities. 
{
   app: itsi
   component: app.ITSI.entityTypeToEntityRatio
   data: {
     entityTypeToEntityRatio: 0.0007955449482895784
     numberOfEntities: 5028
     numberOfEntityTypes: 4
   }
   deploymentID: 616ee3e9-532b-5b32-8679-0e58f7d3d336
   eventID: BAC39F03-20BB-4D88-969F-072A9237581A
   executionID: 38A07E6C-2CA7-4B6A-88DB-CB8ED52776D7
   optInRequired: 3
   timestamp: 1592906593
   type: aggregate
   visibility: [
     support
     anonymous
   ]
}
app.ITSI.serviceToEntityRatio Reports the ratio of in-use services to entities. 
{
   app: itsi
   component: app.ITSI.serviceToEntityRatio
   data: {
     numberOfEntities: 128
     numberOfServices: 8
     serviceToEntityRatio: 0.0625
   }
   deploymentID: 639ae7f7-0af0-5a0f-b053-65a3662f230a
   eventID: 6A71F467-B4FE-4D4C-99F4-4F324DD01B72
   executionID: EC2EE972-58C2-441F-97B9-8921453AC341
   optInRequired: 3
   timestamp: 1592820188
   type: aggregate
   visibility: [
     anonymous
     support
   ]
}
app.ITSI.kpiToEntityRatio Reports the ratio of in-use KPIs to entities. 
{
   app: itsi
   component: app.ITSI.kpiToEntityRatio
   data: {
     kpiToEntityRatio: 0.20689655172413793
     numberOfEntities: 87
     numberOfKpis: 18
   }
   deploymentID: 121370bf-b9ce-54c5-96e0-f99a03242ef5
   eventID: 3341F59D-8290-4683-B4A9-3F7C09458CB3
   executionID: CC1CAA21-78DD-46C5-BEAA-5BFD690100E3
   optInRequired: 3
   timestamp: 1592733807
   type: aggregate
   visibility: [
     anonymous
     support
   ]
}
app.ITSI.sharedBaseSearchToEntityRatio Reports the ratio of in-use shared base searches to entities. 
{
   app: itsi
   component: app.ITSI.sharedBaseSearchToEntityRatio
   data: {
     numberOfEntities: 25080
     numberOfSharedBaseSearches: 5
     sharedBaseSearchToEntityRatio: 0.00019936204146730463
   }
   deploymentID: 616ee3e9-532b-5b32-8679-0e58f7d3d336
   eventID: 8F418716-926D-4D67-B31A-3732DBC4EC21
   executionID: 38A07E6C-2CA7-4B6A-88DB-CB8ED52776D7
   optInRequired: 3
   timestamp: 1592906664
   type: aggregate
   visibility: [
     support
     anonymous
   ]
}
app.ITSI.serviceAssociatedEntityToServiceUnassociatedEntityRatio Reports the number of entities by service association. 
{
   app: itsi
   component: app.ITSI.serviceAssociatedEntityToServiceUnassociatedEntityRatio
   data: {
     numberOfServiceAssociatedEntities: 5016
     numberOfServiceUnassociatedEntities: 12
     serviceAssociatedEntityToServiceUnassociatedEntityRatio: 418
   }
   deploymentID: 616ee3e9-532b-5b32-8679-0e58f7d3d336
   eventID: 965EC96C-33E4-44E2-B885-77CE071D3EEC
   executionID: 38A07E6C-2CA7-4B6A-88DB-CB8ED52776D7
   optInRequired: 3
   timestamp: 1592906664
   type: aggregate
   visibility: [
     anonymous
     support
   ]
}
app.ITSI.knowledgeObjectsCounts Reports the number of public and private knowledge objects, such as glass tables and service analyzers. 
{
   app: itsi
   component: app.ITSI.knowledgeObjectsCounts
   data: {
     knowledgeObjects: {
       correlationSearches: {
         totalCount: 28
       }
       deepDives: {
         privateCount: 0
         publicCount: 10
         totalCount: 10
       }
       entities: {
         totalCount: 128
       }
       entityTypes: {
         totalCount: 19
       }
       eventManagementStates: {
         privateCount: 0
         publicCount: 4
         totalCount: 4
       }
       glassTables: {
         privateCount: 0
         publicCount: 18
         totalCount: 18
       }
       homeViews: {
         privateCount: 0
         publicCount: 12
         totalCount: 12
       }
       kpiBaseSearches: {
         totalCount: 69
       }
       kpiTemplates: {
         totalCount: 34
       }
       kpiThresholdTemplates: {
         totalCount: 119
       }
       maintenanceWindows: {
         totalCount: 0
       }
       notableEventAggregationPolicies: {
         totalCount: 11
       }
       serviceTemplates: {
         totalCount: 7
       }
       services: {
         dependServicesCount: 51
         kpis: {
           adhocCount: 10
           dataModelCount: 0
           metricsCount: 0
           sharedBaseSearchCount: 169
           totalCount: 179
         }
         servicesLinkedToATemplate: 40
         servicesNotInGlobal: 0
         totalCount: 51
       }
       teams: {
         totalCount: 5
       }
     }
   }
   deploymentID: 639ae7f7-0af0-5a0f-b053-65a3662f230a
   eventID: 34AB30A9-31CD-4A86-8ACD-5E9FA0B63E1E
   executionID: 4A6D3ACE-1143-4678-85D6-C61ACC26BD79
   optInRequired: 3
   timestamp: 1592809231
   type: aggregate
   visibility: [
     anonymous
     support
   ]
}
app.session.ITSI.pageLoad Reports the time taken for a React component to load with associated metadata. 
{
   component: app.session.ITSI.pageLoad
   data: {
     app: itsi
     loadTime: 18398.775000008754
     metadata: {
       activeTabId: EVENT_DATA_SEARCH
       isInitialAppMount: true
     }
     mode: development
     page: entity_detail
   }
   deploymentID: 2b623070-88c3-51a2-bed6-8dd666600c60
   eventID: 768b9773-57c9-9549-5527-9346c7568899
   experienceID: 8268d610-95d7-5a6d-4e3e-c5ad9f561a5b
   optInRequired: 3
   timestamp: 1592356630
   userID: 5f4dba230c6b7e300aec79ea85261914c069f777452a207f26b56fb185892b27
   version: 4
   visibility: anonymous,support
}
app.session.pageView Reports the pages a user has visited. 
{
   component: app.session.pageview
   data: {
     app: itsi
     page: notable_event_aggregation_policy_detail_view
   }
   deploymentID: 0e55c2be-a373-5e5f-b9cf-34f0977566e1
   eventID: e4df5657-d13f-8f66-3958-21f0e4247439
   experienceID: 6cac0958-68e6-5a3b-631a-c7f407794280
   optInRequired: 3
   timestamp: 1592850392
   userID: 36966f73a802b0f3e37b385983f3d21d556b0c9d5e2e4bcd9163526bafe12320
   version: 4
   visibility: anonymous,support
}
app.session.udf.telemetry Reports information about visualizations and configurations that users implement in beta glass tables. 
component: app.session.udf.telemetry
   data: { [-]
     app: itsi
     definition: { [-]
       inputs: { [-]
         input1: { [-]
           options: { [-]
             items: 3
           }
           titleLength: 6
           type: input.dropdown
         }
       }
       layout: { [-]
         globalInputs: [ [-]
           input1
         ]
         options: { [-]
           height: 750
           width: 1300
         }
         structure: [ [-]
           { [-]
             item: viz_eGQh2uAJ
             position: { [-]
               h: 730
               w: 1280
               x: 10
               y: 10
             }
             type: block
           }
           { [-]
             item: viz_2WcVmXz0
             position: { [-]
               h: 450
               w: 770
               x: 260
               y: 20
             }
             type: block
         ]
         type: absolute
       }
       titleLength: 26
       visualizations: { [-]
         viz_2WcVmXz0: { [-]
           options: { [-]
             preserveAspectRatio: true
             src: true
           }
           type: viz.img
         }
         viz_5HKW2R1q: { [-]
           options: { [-]
             legend.placement: top
           }
           titleLength: 29
           type: viz.line
         }
       }
     }
     definitionInfo: { [-]
       componentCounts: { [-]
         dataSourceTypeCounts: { [-]
           ds.test: 11
         }
         inputTypeCounts: { [-]
           input.dropdown: 1
         }
         vizTypeCounts: { [-]
           abslayout.line: 6
           viz.img: 1
           viz.line: 2
           viz.rectangle: 1
           viz.singlevalue: 8
           viz.table: 1
           viz.text: 3
         }
       }
       numDataSources: 11
       numInputs: 1
       numViz: 22
     }
     page: boston_marathon__absolute__k0wxyjod/edit
     pageAction: dashboard.initialize
     udfVersion: 5.2.0
   }
   deploymentID: e5fc210a-8e27-54b6-b50e-306304917a3f
   eventID: 40c251b1-09ad-cb2d-cb64-c503c8e91695
   experienceID: 10fa783d-65c5-0ece-9808-416f92ccfd48
   timestamp: 1569281682
   userID: 0b9a7eef9855fe028ae96a4eeea30356bdd66dfeeae10002503a6e7dd9be0e92
   version: 3
   visibility: anonymous,support
app.ITSI.entityLifecycleManagement Number of entity lifecycle management policies having auto retire feature enabled on the Splunk system. 
{
   "timestamp":1648091047,
   "component":"app.ITSI.entityLifecycleManagement",
   "executionID":"64FB8F4D-5BB9-4D0E-9549-5E5FFFD883C8",
   "data":{
      "countOfRetirableEntities":0,
      "countOfEntityTypesUnderManagement":3,
      "countOfDisabledEntityManagementPolicies":9,
      "countOfEnabledEntityManagementPolicies":1,
      "countOfEntitiesUnderManagement":2,
      "countOfRetiredEntities":2,
      "countOfAutoRetireEntityManagementPolicies":1,
      "avgPolicyRunTime":4.65,
      "avgPolicyLookbackPeriod":26
   },
   "optInRequired":3,
   "visibility":[
      "anonymous",
      "support"
   ],
   "eventID":"0F66ABC6-83C4-4CD2-B762-415D2B2474DD",
   "type":"aggregate",
   "deploymentID":"91182b71-8c10-5019-8daa-6722bac9bc27",
   "app":"itsi"
}
app.ITSI.knowledgeObjectsCounts Count of ITSI knowledge objects. 
{
  "timestamp": 1633320026,
  "component": "app.ITSI.knowledgeObjectsCounts",
  "executionID": "ECF66CEF-00EC-4EB3-817A-C0CF6A24C24F",
  "data": {
    "knowledgeObjects": {
      "contentPacks": {
        "": 1
      },
      "correlationSearches": {
        "totalCount": 5
      },
      "deepDives": {
        "privateCount": 0,
        "publicCount": 0,
        "totalCount": 0
      },
      "entities": {
        "totalCount": 140
      },
      "entityManagementPolicies": {
        "totalCount": 0
      },
      "entityManagementRules": {
        "totalCount": 1
      },
      "entityTypes": {
        "totalCount": 10
      },
      "eventManagementStates": {
        "privateCount": 0,
        "publicCount": 0,
        "totalCount": 0
      },
      "glassTables": {
        "privateCount": 0,
        "publicCount": 0,
        "totalCount": 0
      },
      "homeViews": {
        "privateCount": 0,
        "publicCount": 1,
        "totalCount": 1
      },
      "kpiBaseSearches": {
        "totalCount": 41
      },
      "kpiTemplates": {
        "totalCount": 33
      },
      "kpiThresholdTemplates": {
        "totalCount": 33
      },
      "maintenanceWindows": {
        "totalCount": 0
      },
      "notableEventAggregationPolicies": {
        "totalCount": 5
      },
      "serviceTemplates": {
        "totalCount": 4
      },
      "services": {
        "dependServicesCount": 0,
        "kpis": {
          "adhocCount": 12,
          "calculationWindowUsage": {
            "customWindow": {
              "calculationWindowValueCount": {
                "calculation_window_120_min": 1,
                "calculation_window_240_min": 4,
                "calculation_window_60_min": 5
              },
              "totalCount": 10
            },
            "predefinedWindow": {
              "calculationWindowValueCount": {
                "calculation_window_15_min": 2,
                "calculation_window_5_min": 1
              },
              "totalCount": 3
            }
          },
          "dataModelCount": 0,
          "metricsCount": 0,
          "sharedBaseSearchCount": 1,
          "totalCount": 13
        },
        "servicesLinkedToATemplate": 0,
        "servicesNotInGlobal": 0,
        "totalCount": 3
      },
      "teams": {
        "totalCount": 1
      }
    }
  },
  "optInRequired": 3,
  "visibility": [
    "anonymous",
    "support"
  ],
  "eventID": "FAA1804F-F2C5-47A1-B06B-DED1CB31F252",
  "type": "aggregate",
  "deploymentID": "91182b71-8c10-5019-8daa-6722bac9bc27",
  "app": "itsi"
}
Last modified on 01 August, 2022
About Splunk IT Service Intelligence   Plan your ITSI deployment

This documentation applies to the following versions of Splunk® IT Service Intelligence: 4.11.0, 4.11.1, 4.11.2, 4.11.3, 4.11.4, 4.11.5, 4.11.6, 4.12.0 Cloud only, 4.12.1 Cloud only, 4.12.2 Cloud only, 4.13.0, 4.13.1, 4.13.2, 4.13.3

Acrobat logo Download manual
Acrobat logo Download this page

Was this topic useful?







You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters