-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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.
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
Edit config info about dashboard loading #4016
Conversation
website. | ||
|
||
===== directory | ||
|
||
The directory from where to read the dashboards. It is used instead of the URL | ||
when it has a value. | ||
The directory that contains the dashboards to load. If this option is set, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewers: It's not clear to me if directory
and file
settings are mutually exclusive. My assumption is that if the user specifies a directory, then the Beat looks in the specified directory for dashboards and loads whatever it finds. It's not clear to me whether the directory has to contain an archive, or can just contain saved dashboards (I think the latter, but not sure).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, directory
, file
, and url
are mutually exclusive, we expect people to specify only one of these. Also yes, directory
expects the unarchived dashboards. file
is the equivalent that expects an archive.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, I added a sentence to indicate that these options are 3 different ways to specify the location of dashboards.
|
||
===== file | ||
|
||
The file archive (zip file) from where to read the dashboards. It is used | ||
instead of the URL when it has a value. | ||
The file archive (zip file) that contains the dashboards to load. If this option |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
REVIEWERS: Is this simply the filename or a path? (My apologies for not testing, but I thought it would be faster just to ask.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a path.
f7021df
to
d9705d0
Compare
This PR is ready for a final review now. |
Resolves some of the edits from my backlog (tracked in #3539).