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.

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

Update Filebeat development guide && create _meta/kibana/default folder #4787

Merged
merged 2 commits into from Aug 8, 2017

Conversation

Projects
None yet
4 participants
@kvch
Copy link
Contributor

commented Jul 28, 2017

This PR contains two small updates which is highly coupled. But please note that it includes code changes in create_fileset.py.

Also I am not sure if I added all of the required documentation files.

  • "Creating a new Filebeat module" is updated so it includes instructions on how to export dashboards from Kibana 6.x. Furthermore, exporting from Kibana 5.x has also changed, so it is followed-up, too.
  • In create_fileset.py creating both _meta/kibana and _meta/kibana/default is included.

@kvch kvch force-pushed the kvch:docs/filebeat-dev-guide branch from 043899e to 77cd838 Jul 28, 2017

$ ./export_dashboards -dashboard '{dashboard-id}' -output '../../../filebeat/module/{module}/_meta/kibana/default/dashboard'
----

New Filebeat modules might not be compatible with Kibana 5.x. But if compatibility is required,

This comment has been minimized.

Copy link
@dedemorton

dedemorton Jul 28, 2017

Contributor

I'd change the wording to say:

The exported dashboards might not be compatible with Kibana 5.x. To export dashboards that are compatible with 5.x, run the following command inside the developer virtualenv:

$ cd filebeat/module/{module}/
python ../../../dev-tools/export_dashboards.py --regex {module} --dir _meta/kibana
$ mkdir -p filebeat/module/{module}/_meta/kibana/5.x
$ python ../../../dev-tools/export_5x_dashboards.py --regex {module} --dir _meta/kibana/5.x

This comment has been minimized.

Copy link
@dedemorton

dedemorton Jul 28, 2017

Contributor

Are the dashboards exported here compatible with 5.x and 6.x? Or just 5.x?

This comment has been minimized.

Copy link
@kvch

kvch Jul 28, 2017

Author Contributor

These dashboards are only compatible with 5.x.

This comment has been minimized.

Copy link
@dedemorton

dedemorton Jul 28, 2017

Contributor

Then I'd say that in the doc to make it clear.

This comment has been minimized.

Copy link
@kvch

kvch Jul 28, 2017

Author Contributor

Ok, i will fix it soon. :)

@@ -46,13 +46,16 @@ def generate_module(base_path, metricbeat_path, module, fileset):

module_path = base_path + "/module/" + module
meta_path = module_path + "/_meta"
kibana_default_path = meta_path + "/kibana/default"

This comment has been minimized.

Copy link
@dedemorton

dedemorton Jul 28, 2017

Contributor

@monicasarbu should look through these changes

This comment has been minimized.

Copy link
@monicasarbu

monicasarbu Aug 2, 2017

Contributor

yes, it's not ideal the export thing, but I am planning to improve it for the next beta release.

@dedemorton
Copy link
Contributor

left a comment

Recommended some rewording.

@kvch kvch force-pushed the kvch:docs/filebeat-dev-guide branch 3 times, most recently from effdcc3 to 17de97b Jul 31, 2017

@tsg tsg added the needs_backport label Aug 2, 2017

$ cd filebeat/module/{module}/
python ../../../dev-tools/export_dashboards.py --regex {module} --dir _meta/kibana
$ mkdir -p filebeat/module/{module}/_meta/kibana/5.x

This comment has been minimized.

Copy link
@monicasarbu

monicasarbu Aug 2, 2017

Contributor

$ make python-env

kvch added some commits Jul 28, 2017

create_fileset: Create kibana/default folder
kibana/default folder is created under _meta to be
more consistent with the development guide.
filebeat: update development guide on dashboards
The way dashboards are exported has changed, so it followed up
in the development guide. It also includes the export of dashboards
before 6.x.

@kvch kvch force-pushed the kvch:docs/filebeat-dev-guide branch from 17de97b to f0f1d9e Aug 8, 2017

@tsg

This comment has been minimized.

Copy link
Collaborator

commented Aug 8, 2017

jenkins, test it again

@tsg tsg merged commit 190edf0 into elastic:master Aug 8, 2017

4 of 6 checks passed

continuous-integration/travis-ci/pr The Travis CI build could not complete due to an error
Details
codecov/project 58.33% (-4.07%) compared to 0008c72
Details
CLA Commit author is a member of Elasticsearch
Details
beats-ci Build finished.
Details
codecov/patch Coverage not affected when comparing 0008c72...f0f1d9e
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details

kvch added a commit to kvch/beats that referenced this pull request Aug 11, 2017

Update Filebeat development guide && create _meta/kibana/default fold…
…er (elastic#4787)

* create_fileset: Create kibana/default folder

kibana/default folder is created under _meta to be
more consistent with the development guide.

* filebeat: update development guide on dashboards

The way dashboards are exported has changed, so it followed up
in the development guide. It also includes the export of dashboards
before 6.x.

tsg added a commit that referenced this pull request Aug 14, 2017

Update Filebeat development guide && create _meta/kibana/default fold…
…er (#4787) (#4886)

* create_fileset: Create kibana/default folder

kibana/default folder is created under _meta to be
more consistent with the development guide.

* filebeat: update development guide on dashboards

The way dashboards are exported has changed, so it followed up
in the development guide. It also includes the export of dashboards
before 6.x.

ramon-garcia added a commit to ramon-garcia/beats that referenced this pull request Dec 5, 2017

Update Filebeat development guide && create _meta/kibana/default fold…
…er (elastic#4787)

* create_fileset: Create kibana/default folder

kibana/default folder is created under _meta to be
more consistent with the development guide.

* filebeat: update development guide on dashboards

The way dashboards are exported has changed, so it followed up
in the development guide. It also includes the export of dashboards
before 6.x.

athom added a commit to athom/beats that referenced this pull request Jan 25, 2018

Update Filebeat development guide && create _meta/kibana/default fold…
…er (elastic#4787)

* create_fileset: Create kibana/default folder

kibana/default folder is created under _meta to be
more consistent with the development guide.

* filebeat: update development guide on dashboards

The way dashboards are exported has changed, so it followed up
in the development guide. It also includes the export of dashboards
before 6.x.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.