Project: StarRocks (App Definition and Development / Database)
File: datadog_support.md

displayed_sidebar: "English" description: Monitor with Datadog sidebar_label: Datadog This topic describes how to integrate your StarRocks cluster with , a monitoring and security platform. Before getting started, you must have the following software installed on your instances: Python NOTE When you install Datadog Agent for the first time, Python is also installed as a dependency. We recommend you use this Python in the following steps. Since Datadog does not provide the integration kit for StarRocks yet, you need to integrate them using the source code. Launch a terminal, navigate to a local directory to which you have both read and write access, and run the following command to create a dedicated directory for StarRocks source code. ```shell mkdir -p starrocks ``` Download the StarRocks source code package using the following command or on to the directory you created. ```shell cd starrocks wget https://github.com/StarRocks/starrocks/archive/refs/tags/<starrocks_ver>.tar.gz ``` Extract the files in the package. ```shell tar -xzvf <starrocks_ver>.tar.gz --strip-components 1 ``` Install Datadog integration kit for FE using source code. ```shell /opt/datadog-agent/embedded/bin/pip install contrib/datadog-connector/starrocks_fe ``` Create the FE integration configuration file /etc/datadog-agent/conf.d/starrocks_fe.d/conf.yaml. ```shell sudo mkdir -p /etc/datadog-agent/conf.d/starrocks_fe.d sudo cp contrib/datadog-connector/starrocksfe/datadogchecks/starrocksfe/data/conf.yaml.example /etc/datadog-agent/conf.d/starrocksfe.d/conf.yaml ``` Modify the FE integration configuration file /etc/datadog-agent/conf.d/starrocks_fe.d/conf.yaml. Examples of some important configuration items: | Config | Example | Description | | -- | | | | femetricurl | `http://localhost:8030/metrics` | The URL used to access the StarRocks FE metrics. | | metrics | `- starrocksfe` | Metrics to be monitored on FE. You can use wildcards `` to match the configuration items. | Install Datadog integration kit for BE using source code. ```shell /opt/datadog-agent/embedded/bin/pip install contrib/datadog-connector/starrocks_be ``` Create the BE integration configuration file /etc/datadog-agent/conf.d/starrocks_be.d/conf.yaml. ```shell sudo mkdir -p /etc/datadog-agent/conf.d/starrocks_be.d sudo cp contrib/datadog-connector/starrocksbe/datadogchecks/starrocksbe/data/conf.yaml.example /etc/datadog-agent/conf.d/starrocksbe.d/conf.yaml ``` Modify the BE integration configuration file /etc/datadog-agent/conf.d/starrocks_be.d/conf.yaml. Examples of some important configuration items: | Config | Example | Description | | -- | | | | bemetricurl | `http://localhost:8040/metrics` | The URL used to access the StarRocks BE metrics. | | metrics | `- starrocksbe` | Metrics to be monitored on BE. You can use wildcards `` to match the configuration items. | Restart Datadog Agent to allow the configuration to take effect. ```shell sudo systemctl stop datadog-agent sudo systemctl start datadog-agent ``` For instructions to verify the integration, see . You can uninstall the integration kits when you no longer need them. To uninstall FE integration kit, run the following command: ```shell /opt/datadog-agent/embedded/bin/pip uninstall datadog-starrocks-fe ``` To uninstall BE integration kit, run the following command: ```shell /opt/datadog-agent/embedded/bin/pip uninstall datadog-starrocks-be ```