Configure an Elasticsearch index pattern for Kibana - SmartPlant Foundation - IM Update 48 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

Before you can start using Kibana, you need to tell it which Elasticsearch indices you want to explore. The first time you access Kibana, you are prompted to define an index pattern that matches the name of one or more of your indices.

Before you can create an index pattern, you must perform an action in SmartPlant Foundation (using the Desktop Client or Web Client) that generates logging activity.

  1. Create an index pattern.

    1. Browse to the Kibana site.

      You are prompted to configure an index pattern.

    2. Check the Index contains time-based events option.

    3. For the Index name or pattern, enter asterisk (*).

    4. For the Time-field name, select timestamp.

    5. Click Create.

  2. Import the Default Dashboard.

    1. Navigate to Management > Saved Objects.

    2. Click the Dashboards tab and click Import.

    3. Navigate to [product_installation_location]\SPFServerManager\ElasticData and select the Dashboard.json file.

    4. Click Open.

Once Kibana is configured, you can browse to the Kibana site and access the dashboards. The following sample dashboards are delivered:

  • Error - Visualizes errors generated.

  • SQL - Displays SQL statements that run longer than the configured duration.

  • Usage metrics - Displays data on users and their activity.

  • Performance metrics - Displays information on top-running actions.