extra/docker/elk/README.md

   1 CLAMP Dashboard
   2 ===============
   3
   4 ELK stack for CLAMP : Logstash is used to retrieve events and notifications from DMaaP and pushes them into Elasticsearch.
   5 Kibana is then used to extract statistics.
   6
   7
   8 Deployment instructions
   9 -----------------------
  10
  11 Requirements: docker-compose
  12
  13 1. Update configuration in docker-compose file
  14 2. `docker-compose up -d logstash kibana`
  15 3. `docker-compose run default`  # loads the dashboard configuration for Kibana
  16
  17
  18 Tools
  19 -----
  20
  21 The following tools are available in the 'tools/' folder.
  22
  23
  24 ### EsAutoQuery
  25
  26 Small script ease Elasticsearch /painless/ field development.
  27 It reads a json file as a query for Elasticsearch, pushes it on the ES server, and display back the answer in a loop, each time the file is modified.
  28
  29
  30 ### DMaaP Service Mocker
  31
  32 Script that simulates control loop DMaaP services to provide sample data to logstash through DMaaP.