Migrate to the new entity schema in Splunk App for Infrastructure
When you restart splunkd
after upgrading to version 2.1.0 or later of the Splunk App for Infrastructure (SAI) from a pre-2.1.0 version, the entity migration upgrade to the new entity schema automatically begins. The migration replaces collectors.conf
with entity_classes.conf
. The new configuration file includes entity classes that are responsible for entity discovery under the new schema. Don't restart splunkd
during the automatic migration process.
What happens during the migration
You don't have to do anything for SAI to roll out the new entity schema. While SAI is migrating to the new schema, you can't access any content in the app.
SAI carries out these actions during the migration to the new entity schema:
- Logs everything to the
_internal
index. - Backs up all
/local/
conf files and all local metadata files inmetadata/local.meta
. - Creates a tarball that contains all the backup files at
$SPLUNK_HOME/etc/apps/splunk_app_infrastructure/migration_backup
. - Disables all saved searches and modular inputs that belong to SAI.
- Disables SAI's REST API, and returns an HTTP 503 status code to all requests.
When the migration is complete, SAI enables all saved searches and modular inputs that belong to it, and enables its REST API.
Delete the old key value store after a successful migration
After the migration is successful, you can delete the key value store (KV store) for the previous entity schema.
What to do if there's a migration failure
There are a couple things that could cause errors during the migration to the new entity schema:
- The new KV store for the new schema could take longer to initialize than SAI expects.
- Orphaned alerts fail the pre-migration process.
You can check the logs with the following search to see if anything went wrong:
index=_internal sourcetype="splunk_app_infrastructure" source=sai_migration_controller.log*
Upgrade to a new version of Splunk App for Infrastructure that's monitoring Windows systems | VMware data collection planning and requirements |
This documentation applies to the following versions of Splunk® App for Infrastructure (Legacy): 2.1.0, 2.1.1 Cloud only, 2.2.0 Cloud only, 2.2.1, 2.2.3 Cloud only, 2.2.4, 2.2.5
Feedback submitted, thanks!