Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device.
Atlassian cookies and tracking notice, (opens new window)
Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Confluence

Aspire 5
Results will update as you type.
  • What is Aspire?
  • Getting Started
    • Installing Using Helm Charts
    • Aspire Registration and Licensing
    • Enable HTTPS
    • How to Install Aspire
      • Quickstart Guide with Docker (HTTPS)
      • How to Set Up Aspire On-Premise
      • Kubernetes Deployments
      • Install Kibana Dashboards
      • Advanced - Configuring Aspire Maven Repository
      • Install and Configure Elasticsearch and OpenSearch
      • Quickstart Guide with Docker Desktop
    • Prerequisites
    • Production Minimum Recommended Settings
    • Supported Versions
  • Generative AI
  • Crawling Features
  • Rest API Usage
  • Configuration
  • How-to articles
  • Connectors
  • Publishers
  • Workflows
  • Aspire Tools
    Calendars

You‘re viewing this with anonymous access, so some content might be blocked.
/
Install Kibana Dashboards
Updated Aug 25

    Install Kibana Dashboards

      Introduction

      Aspire 5 logs and metrics are directly pushed into Elasticsearch. To visualize them, a base set of dashboards has been created. These dashboards can be extended to support your monitoring needs.

      • 1 Introduction
      • 2 Steps
      • 3 Add links into Aspire UI
        • 3.1 Main Dashboard Link
        • 3.2 Individual Seed Metrics Dashboard Link
      • 4 Create Kibana Dashboards with script
        • 4.1 Prerequisites
        • 4.2 Import Dashboards
        • 4.3 Import with a Custom Index Prefix
        • 4.4 Generate Without Importing
        • 4.5 Kibana 9 Compatibility
        • 4.6 Kibana 9.2.3 Test Environment

      Steps

      1. Download the file (export of dashboards)

      2. Import the file on Kibana

        1. CURL method

          curl -u [elastic_user]:[elastic_pass] -F 'file=@/path/to/export.ndjson' -H 'kbn-xsrf:reporting' "http://kibana_host_or_ip:5601/api/saved_objects/_import?overwrite=true"
        2. Directly on Kibana

          1. Open the Menu on the Left

          2. Go to Management → Stack Management

          3. Go to Kibana → Saved Objects

          4. Click on Import, select the export.ndjson file

            • Select "Check for existing objects" → "Automatically overwrite conflicts"

          5. Click on the "Import" button.

      Add links into Aspire UI

      Add the following environment variables before starting the Manager nodes:

      Environment variable

      value

      Environment variable

      value

      aspire_dashboards_enabled

      true

      aspire_dashboards_base

      http://kibana_host_or_ip:5601/app/dashboards#/view/

      aspire_dashboards_main

      Replace with the GUID from the Aspire Dashboard (in Kibana).

      aspire_dashboards_metrics

      <Replace with the GUID from the Seed Status Dashboard (In Kibana)>?_g=(filters:!(),refreshInterval:(pause:!t,value:0),time:(from:now-24h,to:now))&_a=(description:'',filters:!(('$state':(store:appState),meta:(alias:!n,disabled:!f,index:'106de620-c3ca-11eb-9a7f-bd24f960d263',key:audit.seedId,negate:!f,params:(query:'${seedId}'),type:phrase),query:(match_phrase:(audit.seedId:'${seedId}')))),fullScreenMode:!f,options:(hidePanelTitles:!f,useMargins:!t),query:(language:kuery,query:''),tags:!(),timeRestore:!f,title:'Aspire%20-%20Document%20Statistics',viewMode:view)

      Note the bold text on the metrics dashboard; Aspire will replace the following variables:

      • ${seedId}

        • The Seed ID

      Aspire will automatically generate the URLs and links to the dashboards on each Seed.

      Main Dashboard Link

      Individual Seed Metrics Dashboard Link

      Create Kibana Dashboards with script

      Use create_kibana_dashboards.sh to generate and import Aspire's Kibana 9 dashboard objects. The script creates data views that match Aspire's Elasticsearch index prefix, then imports the dashboards with existing objects overwritten.

      Prerequisites

      • Bash, Node.js, and curl

      • A running Kibana instance

      • The export-template.ndjson, prepare-kibana923-export.mjs, and create_kibana_dashboards.sh files in the same directory

      For authenticated Kibana, provide credentials through KIBANA_AUTH in user:password format.

      Import Dashboards

      From the directory containing the script:

      ./create_kibana_dashboards.sh

      This creates export.ndjson and imports it into http://localhost:5601. When no custom prefix is configured, the generated data views are:

      aspire-settings aspire-queue aspire-audit aspire-log

      Import with a Custom Index Prefix

      The script resolves the index prefix in this order:

      1. --prefix PREFIX

      2. ASPIRE_INDEX_PREFIX

      3. -Daspire.noSql.elastic.index.prefix=... from JAVA_TOOL_OPTIONS

      4. aspire

      For example, use the same JVM system property supplied to Aspire:

      JAVA_TOOL_OPTIONS="-Daspire.noSql.elastic.index.prefix=a55" \ KIBANA_URL="http://localhost:5610" \ ./create_kibana_dashboards.sh

      This generates and imports data views for:

      a55-settings a55-queue a55-audit a55-log

      Alternatively, specify the prefix explicitly:

      ./create_kibana_dashboards.sh \ --prefix customer55 \ --kibana-url "https://kibana.example.com"

      For basic authentication:

      KIBANA_AUTH="elastic:password" \ ./create_kibana_dashboards.sh --prefix customer55

      Generate Without Importing

      Use --no-upload to review or distribute the generated export without changing Kibana:

      ./create_kibana_dashboards.sh \ --prefix customer55 \ --output ./export-customer55.ndjson \ --no-upload

      Kibana 9 Compatibility

      The generator preserves all saved-object IDs and dashboard references. It changes only:

      • The four Aspire data-view titles so they use the selected index prefix.

      • addTimeMarker to false for the legacy Queue Status and Workers Load visualizations.

      The latter is required because Kibana 9 migrates these legacy visualizations to Lens, where their inherited current-time marker is invalid.

      Kibana 9.2.3 Test Environment

      The isolated Compose environment uses Elasticsearch and Kibana 9.2.3:

      ASPIRE_INDEX_PREFIX=a55 \ docker compose -f ../docker-compose-kibana923.yml up -d

      It exposes Kibana at http://localhost:5610. Import the matching dashboards with:

      JAVA_TOOL_OPTIONS="-Daspire.noSql.elastic.index.prefix=a55" \ KIBANA_URL="http://localhost:5610" \ ./create_kibana_dashboards.sh

      The Compose environment applies the same ASPIRE_INDEX_PREFIX value to the Aspire settings uploader, manager, and worker, ensuring the generated data views and Elasticsearch indexes stay aligned.

      Copyright © 2024 Accenture

      Contact Us: SCAAssetsSupport@accenture.com

      {"serverDuration": 44, "requestCorrelationId": "6579cba3001f415e92153de45cf8c55c"}