Skip to content

Commit

Permalink
Introduce BEAT_TITLE. (#5109)
Browse files Browse the repository at this point in the history
As suggested by @tsg
  • Loading branch information
roncohen authored and tsg committed Sep 7, 2017
1 parent 9c9eaab commit 34fb3c8
Show file tree
Hide file tree
Showing 8 changed files with 12 additions and 5 deletions.
1 change: 1 addition & 0 deletions auditbeat/Makefile
@@ -1,4 +1,5 @@
BEAT_NAME=auditbeat
BEAT_TITLE=Auditbeat
BEAT_DESCRIPTION=Audit the activities of users and processes on your system.
SYSTEM_TESTS=false
TEST_ENVIRONMENT=false
Expand Down
1 change: 1 addition & 0 deletions filebeat/Makefile
@@ -1,4 +1,5 @@
BEAT_NAME?=filebeat
BEAT_TITLE?=Filebeat
BEAT_DESCRIPTION?=Filebeat sends log files to Logstash or directly to Elasticsearch.
SYSTEM_TESTS?=true
TEST_ENVIRONMENT?=true
Expand Down
1 change: 1 addition & 0 deletions heartbeat/Makefile
@@ -1,4 +1,5 @@
BEAT_NAME=heartbeat
BEAT_TITLE=Heartbeat
BEAT_PACKAGE_NAME=heartbeat-elastic
BEAT_DESCRIPTION?=Ping remote services for availability and log results to Elasticsearch or send to Logstash.
SYSTEM_TESTS=true
Expand Down
5 changes: 3 additions & 2 deletions libbeat/scripts/Makefile
@@ -1,6 +1,7 @@
### VARIABLE SETUP ###
### Application using libbeat may override the following variables in their Makefile
BEAT_NAME?=libbeat ## @packaging Name of the application
BEAT_NAME?=libbeat## @packaging Name of the binary
BEAT_TITLE?=${BEAT_NAME}## @packaging Title of the application
BEAT_DESCRIPTION?=Sends events to Elasticsearch or Logstash ## @packaging Description of the application
BEAT_PATH?=github.com/elastic/beats/${BEAT_NAME}
BEAT_PACKAGE_NAME?=${BEAT_NAME}
Expand Down Expand Up @@ -285,7 +286,7 @@ endif

@# Update docs
@mkdir -p docs
@${PYTHON_ENV}/bin/python ${ES_BEATS}/libbeat/scripts/generate_fields_docs.py $(PWD) ${BEAT_NAME} ${ES_BEATS}
@${PYTHON_ENV}/bin/python ${ES_BEATS}/libbeat/scripts/generate_fields_docs.py $(PWD) ${BEAT_TITLE} ${ES_BEATS}

@# Generate Kibana index pattern
@mkdir -p $(PWD)/_meta/kibana/5.x/index-pattern
Expand Down
6 changes: 3 additions & 3 deletions libbeat/scripts/generate_fields_docs.py
Expand Up @@ -115,13 +115,13 @@ def fields_to_asciidoc(input, output, beat):
parser = argparse.ArgumentParser(
description="Generates the documentation for a Beat.")
parser.add_argument("path", help="Path to the beat folder")
parser.add_argument("beatname", help="The beat name")
parser.add_argument("beattitle", help="The beat title")
parser.add_argument("es_beats", help="The path to the general beats folder")

args = parser.parse_args()

beat_path = args.path
beat_name = args.beatname
beat_title = args.beattitle
es_beats = args.es_beats

fields_yml = beat_path + "/fields.yml"
Expand All @@ -133,6 +133,6 @@ def fields_to_asciidoc(input, output, beat):
output = open(beat_path + "/docs/fields.asciidoc", 'w')

try:
fields_to_asciidoc(fields, output, beat_name.title())
fields_to_asciidoc(fields, output, beat_title)
finally:
output.close()
1 change: 1 addition & 0 deletions metricbeat/Makefile
Expand Up @@ -2,6 +2,7 @@

# Name can be overwritten, as Metricbeat is also a library
BEAT_NAME?=metricbeat
BEAT_TITLE?=Metricbeat
BEAT_DESCRIPTION?=Metricbeat sends metrics to Elasticsearch.
SYSTEM_TESTS?=true
TEST_ENVIRONMENT?=true
Expand Down
1 change: 1 addition & 0 deletions packetbeat/Makefile
@@ -1,4 +1,5 @@
BEAT_NAME?=packetbeat
BEAT_TITLE?=Packetbeat
BEAT_DESCRIPTION?=Packetbeat analyzes network traffic and sends the data to Elasticsearch.
SYSTEM_TESTS?=true
TEST_ENVIRONMENT=false
Expand Down
1 change: 1 addition & 0 deletions winlogbeat/Makefile
@@ -1,4 +1,5 @@
BEAT_NAME=winlogbeat
BEAT_TITLE=Winlogbeat
BEAT_DESCRIPTION=Winlogbeat ships Windows event logs to Elasticsearch or Logstash.
SYSTEM_TESTS=true
TEST_ENVIRONMENT=false
Expand Down

0 comments on commit 34fb3c8

Please sign in to comment.