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

Steps

  1. Download the export.ndjson 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 export.ndjson file
        • Select "Check for existing bbjects" → "Automatically overwrite conflicts"
      5. Click on "Import" button.

Add links into Aspire UI

Add the following environment variables before starting the Manager nodes:

Environment variablevalue
aspire_dashboards_enabledtrue
aspire_dashboards_basehttp://kibana_host_or_ip:5601/app/dashboards#/view/
aspire_dashboards_mainReplace 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