Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add note about overwriting dashboards #6828

Merged
merged 3 commits into from
Jun 20, 2018
Merged

add note about overwriting dashboards #6828

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f9a3493
add note about overwriting dashboards
Apr 11, 2018
6f83218
New wording
Apr 13, 2018
c5a1dd7
Reinstating removed sentence
Apr 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion libbeat/docs/dashboardsconfig.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ You can specify the following options in the `setup.dashboards` section of the

If this option is set to true, {beatname_uc} loads the sample Kibana dashboards
automatically on startup. If no other options are set, the dashboard are loaded
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why the sentence which start with "If no other options are set..." is removed? AFAIK it is still possible to override it using setup.dashboards.directory.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kvch I think this was my fault! When I suggested an edit to @loekvangool, I inadvertently deleted that line when I copy/pasted the original text. I didn't notice the line was missing because the sentence read correctly without the deleted line. My edit should have said:

If this option is set to true, {beatname_uc} loads the sample Kibana dashboards
automatically on startup. If no other options are set, the dashboard are loaded
from the local `kibana` directory in the home path of the {beatname_uc} installation.

Sorry about the confusion.

from the local `kibana` directory in the home path of the installation.
from the local `kibana` directory in the home path of the installation. Note that
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems fairly important, so you might want to call this out as a separate note. I wonder if it might make sense to have a setup.dashboards.overwrite option like we have with the index template?

I'd suggest the following changes (includes a few edits to remove ambiguity in the existing text):

If this option is set to true, {beatname_uc} loads the sample Kibana dashboards
from the local `kibana` directory in the home path of the {beatname_uc} installation.

NOTE: When dashboard loading is enabled, {beatname_uc} overwrites any existing
dashboards that match the names of the dashboards you are loading. This happens
every time {beatname_uc} starts.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dedemorton

beats/libbeat/dashboards/kibana_loader.go

Line 89 in 9e2838d

params.Set("force", "true") //overwrite the existing dashboards
suggests we indeed force overwriting the dashboards (not a developer on Beats, could be wrong about this).

I opened a Discuss on this: https://discuss.elastic.co/t/should-beats-modules-overwrite-kibana-dashboards/127984

I like the new wording. I patched the PR.

any existing dashboards with the same names will be overwritten anytime Beats
starts.

To load dashboards from a different location, you can configure one of the
following options: <<directory-option,`setup.dashboards.directory`>>,
Expand Down