Skip to main content

Preparing to run the Grafana collector

Setting up pre-requisites for running the collector

Make sure that the machine from where you are running the collector meets the following hardware and software requirements.

Table 1.



Hardware (for on-premise runs only)

Note: The following specs are based upon running one collector process at a time. Please adjust the hardware if you are running multiple collectors at the same time.


8 GB


2 Ghz processor

Software (for on-premise runs only)


Click here to get Docker. specific objects (for both cloud and on-premise runs)


You must have a ddw-catalogs dataset set up to hold your catalog files when you are done running the collector.

If you are using Catalog Toolkit , follow these instructions to prepare the datasets for collectors.

Setting up authentication for cataloging Grafana

The collector authenticates to Grafana using an API key. For the collector to run successfully, the API key needs to have Viewer role.

To generate the API key:

Complete the following tasks to generate the API key that you will use for running the collector. See the Grafana documentation for all the details about doing this task.

  1. Navigate to https://<your_organization_name>

  2. Click Add API Key to add a new API key.

    1. Provide the key name.

    2. Set the Role as Viewer.

    3. In the Time to live field, set the expiry time for the API key.


Note down the API token that is generated after this task. We will use it while setting up the command for Grafana.