Skip to content

README.md

Latest commit

 

History

History
27 lines (22 loc) · 2.91 KB

README.md

File metadata and controls

27 lines (22 loc) · 2.91 KB
Raw

Overview

This PoC shows the usage alerting in kibana. This PoC makes use of some of the non-free tier functions of elasticsearch called Watcher. For this showcase an alert is raised once more then 100 HTTP 500 Errors occured in the last hour. An info-event is then logged.

This PoC uses Filebeat and an Ingest-Pipeline as the main ingesting component.

Overview

This PoC uses scripted-fields to map http status codes to status code text. This is usually done via the Kibana-Web-Interface and then automatically applied by kibana at search time.

In this PoC Filebeat is used to monitor the /usr/share/data/accesss.log-file on the local filesystem and output the data to elasticsearch. When Elasticsearches receives data, the data is then processed using the defined ingest-pipeline in the filebeat.yml During processing the message field is parsed using a grok filter to extract field values.

Usage

To run the PoC simply execute the run.sh script. It will start all the docker-container and apply runtime configuration, aswell as output log messages and cleanup after you exit.

Runtime Configuration

Elasticsearch and Kibana uses a custom runtime configuration to create an index-template, the ingest-pipeline and an index-pattern. This configuration is created when starting the docker-environment using the run.sh script. The scripts used to perform runtime object creation can be found in the setup-directory.

  • 00_cleanup.sh: cleanes up index-templates, pipelines, etc. from previous runs.
  • 01_create-index.sh: Creates an index-template called http_access_logs_template, which is applied to every created index, which matches the pattern http_access_logs*. Defines index-settings, such as number_of_shards, number_of_replicas and field-mappings.
  • 02_create-pipeline: Creates the ingest-pipeline used to parse log events before they get indexed by elasticsearch.
  • 03_create_kibana_index_pattern.sh: Creates a kibana-index-pattern, which matches all http_access_logs*-indexes and sets the timeFieldName to timestamp.
  • 04_start_trial_license.sh: Starts a 30-day trial of the pay-for-use features of the elastic stack.
  • 05_create_watcher_alert.sh: Creates a watcher-alert which searches all http_access_log* indices for events which were created 1 hour ago and counts the occurances of http.response.status_codes >= 500 If the number exceeds 100 an alert is raised and an info-event is logged.