Skip to content

Latest commit

 

History

History
81 lines (53 loc) · 2.33 KB

README.md

File metadata and controls

81 lines (53 loc) · 2.33 KB
Raw

DomainTools Elastic Integration

Includes

  • kibana plugin (via zip file)
  • deployment/install necessities
  • logstash config templates customer can use

Recommended Start Up Order

  1. Elasticsearch
  2. Setup log source items (below)
  3. Kibana with DomainTools plugin
  4. Setup Logstash config
  5. Logstash
  6. Setup Filebeat config
  7. Filebeat
  8. Setup .env file
  9. DomainTools Backend Python Service (Docker)

Install Background Service

/bin/bash -c “$(curl -fsSL https://github.com/DomainTools/elastic-integration/raw/main/install.sh)”

If you don't have a .env file yet, this will create one from .env.example and notify you to edit it and retry make install

Install Kibana Plugin

  • assuming your kibana install is located at /usr/share/kibana
/usr/share/kibana/bin/kibana-plugin install https://github.com/DomainTools/elastic-integration/raw/main/domaintools[elastic-version]-[DomainTools version].zip

SETTING UP LOG SOURCE ITEMS

Items being setup:

  • ILM Policy - handler of rotating related event source indices
  • Index template - the template (mappings, etc) to use for newly created indices in the ILM policy
  • Initial index - the starter index (mapping matches index template mapping)
./setup/run.sh

If these are not setup in Elasticsearch then when Logstash sends events to Elasticsearch, the event index rolloever process will not work and our parsing of that index will fail.

TESTING LOGSTASH

To test and verify logstash config files run:

/usr/share/logstash/bin/logstash -f logstash_test.conf --path.settings /etc/logstash -t

  • /user/share/logstash/bin/logstash is the logstash executable
  • -f logstash_test.conf is the flag to point to the config file
  • --path.settings /etc/logstash is the flag to point to the directory holding the logstash.yml file
  • -t is the flag to test the config

Notes for Customer:

Out of band deletion of indices may cause problems

Solution: restart dt_service_1 python background docker container to recreate indices

Troubleshooting

Problem: Test connection errors

Solution:

  • Can kibana talk to python service?
  • Are the DomainTools API credentials correct?

Problem: Data not being enriched

Solution:

  • Make sure the field in logstash is being extracted correctly
  • Make sure service url is pointing to the service