<commit_before>---
date: 2017-01-09T09:00:00+00:00
title: Troubleshooting
menu:
  main:
    parent: "Documentation"
    name: "Troubleshoot"
    weight: 50
draft: true
---

The pointers below will help debug and resolve common issues in case Vamp is not running or not behaving as expected.

If you find some of the instructions not clear enough or lacking information, please [raise an issue on GitHub](https://github.com/magneticio/vamp.io/issues/new).

* [Troubleshoot a full Vamp installation](/documentation/troubleshoot/#troubleshoot-a-full-vamp-installation)
* [Troubleshoot the Vamp hello world quickstart](/documentation/troubleshoot/#troubleshoot-the-vamp-hello-world-quickstart)
* [Troubleshooting tips for using Vamp](/documentation/troubleshoot/#troubleshooting-tips-for-using-vamp)
* [Report an issue](/documentation/troubleshoot/#report-an-issue)

## Troubleshoot a full Vamp installation
The steps below will help you debug problems encountered when following our full install instructions. 

1. Does your install follow the instructions for your framework? 
  - Check the install page [DC/OS](/documentation/installation/dcos/), [Mesos/Marathon](/documentation/installation/mesos-marathon/), [Kubernetes](/documentation/installation/kubernetes/), [Rancher](/documentation/installation/rancher/) and [Docker](/documentation/installation/docker/). 
- Can Vamp connect to Elasticsearch?  
  - Check the Elasticsearch indices required by the Vamp UI have been created:  
    `GET <elasticsearch url>/_cat/indices?v`  
      HAProxy logs: _logstash-{date}_     
      Health workflow events: _vamp-pulse-health-{date}_  
      Metrics workflow events: _vamp-pulse-metrics-{date}_   
- Are all Vamp components installed and running?
  - Check that the `vamp` and `vamp-gateway-agent` docker containers are running using `docker ps`. 
  - Check the logs `docker logs {container ID}`  
    Any errors here should be clear, in case they aren't [report the issue](/documentation/troubleshoot/#report-an-issue).
- Can Vamp connect to the configured key value store?  
  - Check the key value store reports as connected in Vamp info `GET <vamp url>/api/v1/info`  
  If not, correct the configuration in `application.conf`
  - Check you can communicate with the configured key value store from where Vamp is running.  
  Zookeeper:  
  Consul:  
  etcd:  
- Are you running supported versions of all components?
- Are the workflow containers running or restarting?
  - Check that the three default workflow containers are there using `docker ps`  
  - Check the logs for each `vamp-workflow-agent` container using `docker logs {container ID}`  
    If a `failure` is reported, the workflow may not be able to talk to Elasticsearch - check the Elasticsearch configuration in `application.conf`.  
    Any errors here should be clear, in case they aren't [report the issue](/documentation/troubleshoot/#report-an-issue).
- Check the [release notes](/documentation/release-notes/latest) for known issues and breaking changes.
- If you're still hitting problems, please [report the issue](/documentation/troubleshoot/#report-an-issue).

## Troubleshoot the Vamp Hello world quickstart
The Vamp hello world quickstart is a self contained testing place. If you run into problems or unexpected behaviour, we advise that you clear everything out and reinstall.

1. Stop all running containers - for example using `docker ps | awk '{print $1}' | xargs docker stop 2>/dev/null`
- Clean up  your docker environment (remove stopped containers, dangling images and volumes).
- Restart docker machine using `docker-machine restart`.
- Reinstall [Vamp hello world](/documentation/installation/hello-world/).
- If everything is installed ok and you're running into problems using Vamp, check the [troubleshooting tips for using Vamp](/documentation/troubleshoot/#troubleshooting-tips-for-using-vamp).

## Troubleshooting tips for using Vamp
If you encounter problems running services on an installed version of Vamp, check the following: 

1. Confirm that everything is installed ok:
  - Check the Vamp info (using `GET <vamp url>/api/v1/info` or in the info pane of the Vamp UI).  
    If a component is not listed or reported as `not connected`, check the instructions to [troubleshoot a full Vamp installation](/documentation/troubleshoot/#troubleshoot-a-full-vamp-installation) or [troubleshoot the Vamp Hello world quickstart](/documentation/troubleshoot/#troubleshoot-the-vamp-hello-world-quickstart).
- Take some time to read through the [documentation](/documentation/using-vamp/blueprints/) and [tutorials](/documentation/tutorials/overview/).
- Ask us on gitter ([gitter.im - magneticio/vamp](https://gitter.im/magneticio/vamp))
- Still not working? [Report an issue](/documentation/troubleshoot/#report-an-issue).


## Report an issue

If you've tried the above steps and are still stuck, then let us know. We accept bug reports and pull requests on the GitHub repo for each project ([github.com - magneticio](https://github.com/magneticio)).

{{< note >}}                                  
* **Questions about how to use Vamp?** Please [check the documentation first](/documentation/).
* To suggest a change or new feature, [create a GitHub issue](https://github.com/magneticio/vamp/issues) and tag it with "feature proposal"
{{< /note >}}

When reporting issues, please include the following details:

- Description of issue.
- Vamp info, from the API: `GET <vamp url>/api/v1/info`<commit_msg>troubleshooting edit<commit_after>---
date: 2017-01-09T09:00:00+00:00
title: Troubleshooting
menu:
  main:
    parent: "Documentation"
    name: "Troubleshoot"
    weight: 50
draft: true
---

The pointers below will help debug and resolve common issues in case Vamp is not running or not behaving as expected.

* [Troubleshoot a full Vamp installation](/documentation/troubleshoot/#troubleshoot-a-full-vamp-installation)
* [Troubleshoot the Vamp hello world quickstart](/documentation/troubleshoot/#troubleshoot-the-vamp-hello-world-quickstart)
* [Troubleshooting tips for using Vamp](/documentation/troubleshoot/#troubleshooting-tips-for-using-vamp)
* [Report an issue](/documentation/troubleshoot/#report-an-issue)

If you find some of the instructions not clear enough or lacking information, please [raise an issue on GitHub](https://github.com/magneticio/vamp.io/issues/new).

## Troubleshoot a full Vamp installation
The steps below will help you debug problems encountered when following our full install instructions. 

1. Does your install follow the instructions for your framework? 
  - Check the install page [DC/OS](/documentation/installation/dcos/), [Mesos/Marathon](/documentation/installation/mesos-marathon/), [Kubernetes](/documentation/installation/kubernetes/), [Rancher](/documentation/installation/rancher/) and [Docker](/documentation/installation/docker/). 
- Can Vamp connect to Elasticsearch?  
  - Check the Elasticsearch indices required by the Vamp UI have been created:  
    `GET <elasticsearch url>/_cat/indices?v`  
      HAProxy logs: _logstash-{date}_     
      Health workflow events: _vamp-pulse-health-{date}_  
      Metrics workflow events: _vamp-pulse-metrics-{date}_   
- Are all Vamp components installed and running?
  - Check that the `vamp` and `vamp-gateway-agent` docker containers are running using `docker ps`. 
  - Check the logs `docker logs {container ID}`  
    Any errors here should be clear, in case they aren't [report the issue](/documentation/troubleshoot/#report-an-issue).
- Can Vamp connect to the configured key value store?  
  - Check the key value store reports as connected in Vamp info `GET <vamp url>/api/v1/info`  
  If not, correct the configuration in `application.conf`
  - Check you can communicate with the configured key value store from where Vamp is running.  
  Zookeeper:  
  Consul:  
  etcd:  
- Are you running supported versions of all components?
- Are the workflow containers running or restarting?
  - Check that the three default workflow containers are there using `docker ps`  
  - Check the logs for each `vamp-workflow-agent` container using `docker logs {container ID}`  
    If a `failure` is reported, the workflow may not be able to talk to Elasticsearch - check the Elasticsearch configuration in `application.conf`.  
    Any errors here should be clear, in case they aren't [report the issue](/documentation/troubleshoot/#report-an-issue).
- Check the [release notes](/documentation/release-notes/latest) for known issues and breaking changes.
- If you're still hitting problems, please [report the issue](/documentation/troubleshoot/#report-an-issue).

Did this help? If you find some of the instructions not clear enough or lacking information, please [raise an issue on GitHub](https://github.com/magneticio/vamp.io/issues/new).

## Troubleshoot the Vamp Hello world quickstart
The Vamp hello world quickstart is a self contained testing place. If you run into problems or unexpected behaviour, we advise that you clear everything out and reinstall.

1. Stop all running containers - for example using `docker ps | awk '{print $1}' | xargs docker stop 2>/dev/null`
- Clean up  your docker environment (remove stopped containers, dangling images and volumes).
- Restart docker machine using `docker-machine restart`.
- Reinstall [Vamp hello world](/documentation/installation/hello-world/).
- If everything is installed ok and you're running into problems using Vamp, check the [troubleshooting tips for using Vamp](/documentation/troubleshoot/#troubleshooting-tips-for-using-vamp).

Did this help? If you find some of the instructions not clear enough or lacking information, please [raise an issue on GitHub](https://github.com/magneticio/vamp.io/issues/new).

## Troubleshooting tips for using Vamp
If you encounter problems running services on an installed version of Vamp, check the following: 

1. Confirm that everything is installed ok:
  - Check the Vamp info (using `GET <vamp url>/api/v1/info` or in the info pane of the Vamp UI).  
    If a component is not listed or reported as `not connected`, check the instructions to [troubleshoot a full Vamp installation](/documentation/troubleshoot/#troubleshoot-a-full-vamp-installation) or [troubleshoot the Vamp Hello world quickstart](/documentation/troubleshoot/#troubleshoot-the-vamp-hello-world-quickstart).
- Take some time to read through the [documentation](/documentation/using-vamp/blueprints/) and [tutorials](/documentation/tutorials/overview/).
- Ask us on gitter ([gitter.im - magneticio/vamp](https://gitter.im/magneticio/vamp))
- Still not working? [Report an issue](/documentation/troubleshoot/#report-an-issue).

Did this help? If you find some of the instructions not clear enough or lacking information, please [raise an issue on GitHub](https://github.com/magneticio/vamp.io/issues/new).

## Report an issue

If you've tried the above steps and are still stuck, then let us know. We accept bug reports and pull requests on the GitHub repo for each project ([github.com - magneticio](https://github.com/magneticio)).

{{< note >}}                                  
* **Questions about how to use Vamp?** Please [check the documentation first](/documentation/).
* To suggest a change or new feature, [create a GitHub issue](https://github.com/magneticio/vamp/issues) and tag it with "feature proposal"
{{< /note >}}

When reporting issues, please include the following details:

- Description of issue.
- Vamp info, from the API: `GET <vamp url>/api/v1/info`
{'fraction_non_alphanumeric': 0.09227300320874166, 'fraction_numerical': 0.004856473853091666, 'mean_word_length': 4.3020689655172415, 'pattern_counts': {'":': 0, '<': 15, '<?xml version=': 0, '>': 17, 'https://': 11, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6943897', 'n_tokens_mistral': 3394, 'n_tokens_neox': 3161, 'n_words': 1250}