Enable or disable VNC API statistics

Enable or disable VNC API statistics

Note

This feature is available starting from the MCP 2019.2.12 maintenance update. Before using the feature, follow the steps described in Apply maintenance updates.

On every HTTP resource request, such as create, update, list, and so on, the OpenContrail contrail-api server sends statistics messages to the collector service, which can potentially cause high load on analytics nodes. To disable such statistics messages, use the disable_vnc_api_stats option of the contrail-api service. By default disable_vnc_api_stats is set to True.

To enable or disable VNC API statistics:

  1. Log in to the Salt Master node.

  2. In classes/cluster/<cluster_name>/opencontrail/control.yml of your Reclass model, specify the required value for the disable_vnc_api_stats parameter. To enable sending statistics messages to the OpenContrail analytics nodes, set disable_vnc_api_stats to False. To suppress the statistics messages, set disable_vnc_api_stats to True. For example:

    parameters:
    
      opencontrail:
        ...
        config
          ...
          disable_vnc_api_stats: True
          ...
    
  3. Apply the changes:

    salt -C 'I@opencontrail:control' state.sls_id /etc/contrail/contrail-api.conf opencontrail
    
  4. Restart the contrail-api service:

    Warning

    Restarting the contrail-api service on all nodes at once causes interruption for CRUD operations with networking objects. Plan the restart in advance or restart contrail-api on each node one by one using a modified target in the following Salt command.

    • If one worker is configured for the OpenContrail API:

      salt -C 'I@opencontrail:control' cmd.run "doctrail controller service contrail-api* restart"
      
    • If multiple workers are configured for the OpenContrail API:

      salt -C 'I@opencontrail:control' cmd.run "doctrail controller systemctl restart contrail-api@*"