Setting up the index patterns in Kibana

Set up index patterns to display logs for a specific Component Pack for HCL Connections microservice only, resulting in faster search times against the microservice logs.

About this task

Elasticsearch stores data from the Component Pack logs, organizing the data with indices (indexes) created by Logstash. The data includes indices for logs collected from each Component Pack microservice, as well as the services provided by Kubernetes. You can display logs for a specific microservice only, resulting in faster search times against a the microservice logs.

Procedure

Create the following index patterns for the deployed applications within the Kibana Management dashboard.

  1. Open the Kibana dashboard.
    Open a browser and navigate to the appropriate URL for your environment:
    • non-HA: https://Component_Pack_Kubernetes_master:32333
    • HA: https://HA_load_balancer_host_name/IP:32333
  2. First create the default "all data" index pattern called comppackk8s-*, which includes all logs associated with the Component Pack deployment (including system pods).

    On the Configure an index pattern page, enter comppackk8s-* in the Index name or pattern field, and then click Create.

  3. Now create the index patterns for Component Pack microservice logs; refer to the tables for information about each index pattern that you should create.

    Complete the following steps to create an index pattern:

    1. On the Management tab, click Index Patterns.
    2. On the Index Pattern page, click Add New.
    3. On the Configure an index pattern page, define a new index as described in "Creating an Index Pattern to Connect to Elasticsearch" article on the elastic.com website.

    Tables 1 through 8 list the index pattern name plus the associated microservice and Helm chart for the index patterns that you will create for each of the Component Pack services.

    Table 1. Index patterns for Orient Me
    Index pattern name Microservice Installed by this Helm chart
    *analysisservice* orient-indexing-service orientme
    *itm-services* itm-services orientme
    *orient-web-client* orient-web-client orientme
    *analysisservice* orient-analysis-service orientme
    *indexingservice* orient-indexing-service orientme
    *solr* solr-basic orientme
    *zookeeper* zookeeper orientme
    *middleware-graphql* middleware-graphql orientme
    *userprefs-service* userprefs-service orientme
    *retrievalservice* orient-retrieval-service orientme
    *people-scoring* people-scoring orientme
    *people-migrate* people-datamigration orientme
    *people-relation* people-relationship orientme
    *mail* mail-service orientme
    *people-idmapping* people-idmapping orientme
    *community-suggestions* community-suggestions orientme
    *mw-proxy* mw-proxy mw-proxy
    Table 2. Index patterns for Infrastructure
    Index pattern name Microservice Installed by this Helm chart
    *haproxy* haproxy infrastructure
    *redis-server* redis infrastructure
    *redis-sentinel* redis-sentinel infrastructure
    *mongo* mongodb infrastructure
    *mongo-sidecar* mongodb-rs-setup infrastructure
    *appregistry-client* appregistry-client infrastructure
    *appregistry-service* appregistry-service infrastructure
    Table 3. Index patterns for Elasticsearch
    Index pattern name Microservice Installed by this Helm chart
    *es-master* es-master elasticsearch
    *es-client* es-client elasticsearch
    *es-data* es-data elasticsearch
    Table 4. Index patterns for mw-proxy
    Index pattern name Microservice Installed by this Helm chart
    *mw-proxy* mw-proxy mw-proxy
    Table 5. Index pattern for Bootstrap
    Index pattern name Microservice Installed by this Helm chart
    *bootstrap* bootstrap bootstrap
    Table 6. Index patterns for Sanity
    Index pattern name Microservice Installed by this Helm chart
    *sanity* sanity sanity
    *sanity-watcher* sanity-watcher sanity-watcher
    Table 7. Index patterns for Elastic Stack
    Index pattern name Microservice Installed by this Helm chart
    *elasticsearch-curator* elasticsearch-curator elasticstack
    *kibana* kibana elasticstack
    Table 8. Index patterns for system pods
    Index pattern name Microservice Installed by this Helm chart
    *kube-proxy* System System
    *kube-controller-manager* System System
    *calico-node* System System
    *influxdb* System System
    *kube-scheduler* System System
    *heapster* System System
    *coredns* System System
    *etcd* System System
    *kube-apiserver* System System
    *tiller* System System
    *kubernetes-dashboard* System System
    *calico* System System

What to do next

For information on using the Kibana dashboard to run queries against Component Pack data, see Querying Component Pack data from the Kibana dashboard.