Troubleshoot an Integration installation on Windows using Grafana Agent

When installing an Integration, you can experience errors when executing the Grafana Agent installation script and errors when configuring the Agent to work with the Integration.

Common errors when executing the Agent installation script

The installation script will return an error message if there is a problem during installation. You can use these messages to identify and correct the errors.

`ERROR: The script needs to be run with Administrator privileges`

The script provided to install the Agent on Windows creates a Windows Service, which is the recommended way to manage background processes for this OS. This operation requires you to execute the script with Administrator privileges.

`ERROR: Failed to install Grafana agent for Windows`

The script could not download and successfully execute the Agent installer. Check the detailed error message for more information. If you need help, contact us using one of the options available on our official Help page, or contact us using the Feedback form if you think there is a problem with the integration.

Any other error

Other errors might occur during installation, like exceptions when creating the Windows Service for the Agent. Check the error message for more details. If you need help, contact us using one of the options available on our official Help page, or contact us using the Feedback form if you think there is a problem with the integration.

Common errors when configuring the Agent for Integrations - Test Data Connection button

You can use the Test Data Connection button on the integration setup page to verify that you configured your Agent correctly and that it is sending the expected data.

A few things can cause a check failure. Before going into detail, make sure you have restarted your Agent service by running the following commands on Powershell with Administrator privileges:

Stop-Service "Grafana Agent"
Start-Service "Grafana Agent"

If the test fails, check the error message for more information:

No metrics were found for this integration.

This message indicates that the Agent cannot contact your Grafana Cloud Prometheus endpoint. This can happen for several reasons, not limited to:

Agent is not starting correctly due to problems in your configuration file syntax or indentation
Agent is not able to connect to your Grafana Cloud Prometheus endpoint (networking or configuration issues)

To understand the reasons for this problem, check the Agent events in the Windows Event Visualizer, under Windows Logs > Application.

If you find errors in the logs about loading the YAML configuration file, make sure you have placed the snippets in the correct sections and with the right YAML indentation and syntax. Make sure you have placed metrics snippets under metrics.configs.scrape_configs, logs snippets under logs.configs.scrape_configs, and integrations (exporters) snippets under integrations.

If you find errors in the logs about connecting to your Grafana Cloud Prometheus endpoint, make sure you didn’t change the prometheus_remote_write URL or authentication details. You can verify your endpoint and create new keys under the Cloud Portal, or contact us using the Feedback form if you think there is a problem with the integration.

Agent was not able to reach your application prometheus metrics endpoint.

This message means that the Agent started successfully and was able to connect to your Grafana Cloud Prometheus endpoint but failed to scrape your application Prometheus metrics endpoint. This can happen for several reasons, not limited to:

The endpoint address is incorrect
The endpoint is protected, and no authentication details were provided
The endpoint is not online

To understand the reasons for this error, check the Agent events in the Windows Event Visualizer, under Windows Logs > Application.

If you find that the endpoint is not online or there are authentication errors, make sure you have followed the steps under the first section of the Integration setup page, Check prerequisites specific to....

Agent was not able to collect your application logs

This message is displayed when the Agent can’t collect logs and send them to your Grafana Cloud Loki endpoint. This can happen for several reasons, not limited to:

There are no logs available
The logs path is incorrect
Agent does not have the necessary permissions to access your application logs
Agent is not able to connect to your Grafana Cloud Loki endpoint (networking or configuration issues)

To understand the reasons for this error, check the Agent events in the Windows Event Visualizer, under Windows Logs > Application.

If you find that there are permission errors, make sure you have followed the steps under the first section of the Integration setup page, Check prerequisites specific to....

If you find errors in the logs about connecting to your Grafana Cloud Loki endpoint, make sure you didn’t change the logs URL or authentication details. You can verify your endpoint and create new keys under the Cloud Portal, or contact us using the Feedback form if you think there is a problem with the integration.