Skip to content

Commit

Permalink
[Auditbeat] System module dashboards (#10511)
Browse files Browse the repository at this point in the history
Seven dashboards for the Auditbeat System module - one for each dataset, and an overall overview dashboards.
  • Loading branch information
Christoph Wurm authored Feb 5, 2019
1 parent 980102c commit 38d5f43
Show file tree
Hide file tree
Showing 27 changed files with 8,311 additions and 3 deletions.
2 changes: 2 additions & 0 deletions auditbeat/docs/fields.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6297,6 +6297,8 @@ ID uniquely identifying the socket. It is computed as a SHA-256 hash of the host
--
type: long
format: duration
Uptime in nanoseconds.
Expand Down
7 changes: 6 additions & 1 deletion libbeat/scripts/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ INTEGRATION_TESTS?=
FIND?=. ${PYTHON_ENV}/bin/activate; find . -type f -not -path "*/vendor/*" -not -path "*/build/*" -not -path "*/.git/*"
PERM_EXEC?=$(shell [ `uname -s` = "Darwin" ] && echo "+111" || echo "/a+x")
XPACK_ONLY?=false
XPACK_DIR=${ES_BEATS}/x-pack/${BEAT_NAME}

ifeq ($(DOCKER_CACHE),0)
DOCKER_NOCACHE=--no-cache
Expand Down Expand Up @@ -364,7 +365,11 @@ endif

.PHONY: docs
docs: ## @build Builds the documents for the beat
sh ${ES_BEATS}/script/build_docs.sh ${BEAT_NAME} ${BEAT_PATH}/docs ${BUILD_DIR}
@if [ -d $(XPACK_DIR) ]; then \
sh ${ES_BEATS}/script/build_docs.sh ${BEAT_NAME} ${BEAT_PATH}/docs ${BUILD_DIR} ${XPACK_DIR}; \
else \
sh ${ES_BEATS}/script/build_docs.sh ${BEAT_NAME} ${BEAT_PATH}/docs ${BUILD_DIR}; \
fi

.PHONY: docs-preview
docs-preview: ## @build Preview the documents for the beat in the browser
Expand Down
8 changes: 7 additions & 1 deletion script/build_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ set -e
name=$1
path=$2
build_dir=$3
resource_dir=$4

docs_dir=$build_dir/docs
html_dir=$build_dir/html_docs
Expand All @@ -29,7 +30,12 @@ do
mkdir -p "$dest_dir"
params="--chunk=1"
if [ "$PREVIEW" = "1" ]; then
params="--chunk=1 -open chunk=1 -open"
params="$params -open"
fi

if [ -d "$resource_dir" ]; then
params="$params -resource=${resource_dir}"
fi

$docs_dir/build_docs.pl $params --doc "$index" -out "$dest_dir"
done
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions x-pack/auditbeat/docs/modules/system.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,14 @@ All datasets are currently using a poll model to retrieve their data.
The frequency of these polls is controlled by the `period` configuration
parameter.

[float]
==== Example dashboard

The module comes with a sample dashboard:

[role="screenshot"]
image:./images/auditbeat-system-overview-dashboard.png[Auditbeat System Overview Dashboard]

[float]
=== Configuration options

Expand Down
8 changes: 8 additions & 0 deletions x-pack/auditbeat/module/system/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,14 @@ All datasets are currently using a poll model to retrieve their data.
The frequency of these polls is controlled by the `period` configuration
parameter.

[float]
==== Example dashboard

The module comes with a sample dashboard:

[role="screenshot"]
image:./images/auditbeat-system-overview-dashboard.png[Auditbeat System Overview Dashboard]

[float]
=== Configuration options

Expand Down
Loading

0 comments on commit 38d5f43

Please sign in to comment.