Enable Gainsight integration¶

Gainsight is a customer relationship management (CRM) tool and extension for Salesforce. Gainsight integration service queries Prometheus for the metrics data and sends the data to Gainsight. Mirantis uses the collected data for further analysis and reports to improve the quality of customer support. For more information, see MCP Reference Architecture: StackLight LMA components.

To enable Gainsight integration service on an existing StackLight LMA deployment:

1. Log in to the Salt Master node.

2. Update the system level of your Reclass model.

3. Add the classes and parameters to stacklight/client.yml as required:

   1. For OpenStack environments, add the default Openstack-related metrics:

      - system.prometheus.gainsight.query.openstack
      

   2. Add the main Gainsight class:

      - system.docker.swarm.stack.monitoring.gainsight
      

   3. Specify the following parameters:

      parameters:
        _param:
          docker_image_prometheus_gainsight: docker-prod-local.artifactory.mirantis.com/openstack-docker/gainsight:${_param:mcp_version}
          gainsight_csv_upload_url: <URL_to_Gainsight_API>
          gainsight_account_id: <customer_account_ID_in_Salesforce>
          gainsight_environment_id: <customer_environment_ID_in_Salesforce>
          gainsight_app_org_id: <Mirantis_organization_ID_in_Salesforce>
          gainsight_access_key: <Gainsight_access_key>
          gainsight_job_id: <Gainsight_job_ID>
          gainsight_login: <Gainsight_login>
          gainsight_csv_retention: <retention_in_days>
      

      Note

      To obtain the values for the above parameters, contact Mirantis Customer Success Team through cs-team@mirantis.com.

      The retention period for CSV files is set to 180 days by default.

   4. Optional. Customize the frequency of CSV uploads to Gainsight by specifying the duration parameter in the prometheus block.

      Example:

      _param:
      prometheus:
        gainsight:
          crontab:
            duration: '0 0 * * *'
      

4. Refresh Salt grains and pillars:

   salt '*' state.sls salt.minion.grains && salt '*' mine.update && salt '*' saltutil.refresh_pillar
   

5. Deploy the configuration files for the Gainsight Docker service:

   salt -C 'I@docker:swarm' state.sls prometheus.gainsight
   

6. Deploy the new monitoring_gainsight Docker service:

   salt -C 'I@docker:swarm:role:master' state.sls docker.client