Troubleshooting the Free Edition
3 minute read
You can check whether the Free Edition agent was correctly installed using the Edge Delta agent troubleshooter.
- Get your API key.
To run the troubleshooter, you will need the API key you used for your installation. You got this key from your installation instructions in step 3. It is the number specified after secretApiKey.value=.
If you don’t have that key, you can get your API key from the K8s secret:
kubectl get secrets/ed-api-key --template="{{index .data \"ed-api-key\" | base64decode}}" -n edgedelta
The API key may end with a % symbol indicating that there is no new line. Leave this symbol out when you copy the API key.
- Run the troubleshooter
Install and run the troubleshooter in your cluster with the following command. In this example the API key is 123456789:
kubectl run agent-troubleshooter -i --rm --image=gcr.io/edgedelta/agent-troubleshooter:latest -- /edgedelta/agent_troubleshooter --mode=post-install-checks --api_key=123456789
Expected Result
If the agent was successfully installed the output of the troubleshooter should be as follows:
Starting Edge Delta agent troubleshooter.
Starting Edge Delta agent post-install check.
Starting agent API key check.
API key is successfully verified with the Edge Delta server.
Starting agent health check, this may take up to a few minutes.
Successfully verified agent health, deployed agents for the specified API key is: [minikube-f7ab635 edgedelta-aggregator-f7ab635]
Agent troubleshooter finished with success.
pod "agent-troubleshooter" deleted
After a successful verification the troubleshooter uninstalls itself from your cluster.
Possible Errors
The following problems can be discovered by the troubleshooter:
Incorrect API Key
If the API key you specified when you installed the agent is incorrect the troubleshooter will detect an API key error:
Starting Edge Delta agent troubleshooter.
Starting Edge Delta agent post-install check.
Starting agent API key check.
Agent post install check failed, err: API key is not valid. Please check the API key
pod "agent-troubleshooter" deleted
Confirm your API key and pass it into the cluster. Alternatively, install a fresh agent with a new API key. Finally, contact support if the problem persists.
No Heartbeat
If the troubleshooter does not detect the agent heartbeat the install check fails with the following output:
Starting Edge Delta agent troubleshooter.
Starting Edge Delta agent post-install check.
Starting agent API key check.
API key is successfully verified with the Edge Delta server.
Starting agent health check, this may take up to a few minutes.
Agent post install check failed, err: 5 errors occurred:
- retry 1 of 5: failed to verify agent install, err: agent heartbeat could not be found for the specified API key
- retry 2 of 5: failed to verify agent install, err: agent heartbeat could not be found for the specified API key
- retry 3 of 5: failed to verify agent install, err: agent heartbeat could not be found for the specified API key
- retry 4 of 5: failed to verify agent install, err: agent heartbeat could not be found for the specified API key
- retry 5 of 5: failed to verify agent install, err: agent heartbeat could not be found for the specified API key
pod "agent-troubleshooter" deleted
If there is no heartbeat, check that the Edge Delta pods are running.
kubectl get pods -n edgedelta
If they are running correctly, confirm your API key and try running the troubleshooter again. Check in the web app whether data is being sent by the agent. Finally, contact support if the problem persists.