Documentation forSolarWinds Observability

Configure ZooKeeper integration

The ZooKeeper New Metric System feature is not supported. See OpenTelemetry issue #20702 (© 2023 GitHub, Inc., available at https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/20702, obtained on April 12, 2023.)

If you are not using the New Metrics Feature, consider adjusting the configuration not to mention the feature. In zoo.cfg, search for the metricsProvider.className string and remove it from zoo.cfg. By default, zoo.cfg is located at /opt/zookeeper/conf/zoo.cfg.

To integrate ZooKeeper with SolarWinds Observability:

  1. In SolarWinds Observability, click Add Data at the top.

  2. In the Add Data dialog, click Integration, and then click ZooKeeper.

  3. In the Add ZooKeeper dialog, select a host with the SolarWinds Observability Agent you want to use for ZooKeeper and click Next.

    To only display Agents running in a Kubernetes cluster, click the List only Agents... toggle.

    If you want to install a dedicated Agent on a dedicated host, add the host and then add the ZooKeeper integration. See Add a self-managed host.

    If you prefer using Docker, see Run the SolarWinds Observability Agent as a Docker image or Kubernetes deployment.

  4. Select where the ZooKeeper service is located:

    • On Host: The ZooKeeper service runs on the same physical or virtual machine as the Agent.

    • Off Host: The ZooKeeper service runs on a different physical or virtual machine than the Agent.

  5. Configure the mntr - '4 letter word command' in the ZooKeeper configuration file. By default, the file is located at /opt/zookeeper/conf/zoo.cfg.

    The instructions below expect default configuration, using port 2181. To change the default port, refer to ZooKeeper documentation

    4lw.commands.whitelist=mntr

  6. Run the command to get the status. The output should include basic status data.

    echo mntr | nc localhost 2181

  7. Click Next.

  8. Review the configuration and click Deploy to deploy the changes to the agent.

    • Provide a Display Name.

    • Review the ZooKeeper Endpoint.

    • Review the Collection Interval.

    • For On Host integrations, you can collect logs. Click Enable log monitoring and configure logs.

  9. Optional for On Host integrations: Configure logs.

    If you enabled logs:

    1. Grant the Agent access to the ZooKeeper log folder. Use the following command:

      sudo usermod -a -G adm swagent

    2. Restart the Agent. Run the following command.

      sudo service uamsclient restart

    3. Review the default path for storing logs. Adjust it if appropriate.

  10. When the installation is complete, you can continue to observe ZooKeeper data. Use the buttons on the Summary screen.

To view data collected for the newly configured integration, click Dashboards and search for ZooKeeper. Click the system dashboard for ZooKeeper. See Dashboards.

To view metrics collected for ZooKeeper, click Analyze > Metrics and search for ZooKeeper. See Metrics Explorer for details.