Skip to content

Latest commit

 

History

History
74 lines (46 loc) · 3.97 KB

README.md

File metadata and controls

74 lines (46 loc) · 3.97 KB
Raw

Kibana Reports for Open Distro

Kibana Reports for Open Distro allows ‘Report Owner’ (engineers, including but not limited to developers, DevOps, IT Engineer, and IT admin) export and share reports from Kibana dashboards, saved search, alerts and visualizations. It helps automate the process of scheduling reports on an on-demand or a periodical basis (on cron schedules as well). Further, it also automates the process of exporting and sharing reports triggered for various alerts. The feature is present in the Dashboard, Discover, and Visualization tabs. Scheduled reports can be sent to (shared with) self or various stakeholders within the organization such as, including but not limited to, executives, managers, engineers (developers, DevOps, IT Engineer) in the form of pdf, hyperlinks, csv, excel via various channels such as email, slack, Amazon Chime. However, in order to export, schedule and share reports, report owners should have the necessary permissions as defined under Roles and Privileges.

Request for Comments ( RFC )

Please add your feature requests here New Requests and view project progress here RFCs.

Setup

  1. Download Elasticsearch for the version that matches the Kibana version specified in package.json.

  2. Download the Kibana source code for the version specified in package.json you want to set up.

    See the Kibana contributing guide for more instructions on setting up your development environment.

  3. Change your node version to the version specified in .node-version inside the Kibana root directory.

  4. Create a plugins directory inside the Kibana source code directory, if plugins directory doesn't exist.

  5. Check out this package from version control into the plugins directory.

    git clone [email protected]:opendistro-for-elasticsearch/kibana-reports.git plugins --no-checkout
cd plugins
echo 'kibana-reports/*' >> .git/info/sparse-checkout
git config core.sparseCheckout true
git checkout dev

  6. Run yarn kbn bootstrap inside kibana/plugins/kibana-reports.

Ultimately, your directory structure should look like this:

.
├── kibana
│   └──plugins
│      └── kibana-reports

Build

To build the plugin's distributable zip simply run yarn build.

Example output: ./build/opendistro-kibana-reports-0.0.1.zip

Run

  • yarn start

    Starts Kibana and includes this plugin. Kibana will be available on localhost:5601.

  • yarn test:jest

    Runs the plugin tests.

Contributing to Kibana reports for Open Distro

We welcome you to get involved in development, documentation, testing the kibana reports plugin. See our CONTRIBUTING.md and join in.

Since this is a Kibana plugin, it can be useful to review the Kibana contributing guide alongside the documentation around Kibana plugins and plugin development.

Code of Conduct

This project has adopted an Open Source Code of Conduct.

Security issue notifications

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public GitHub issue.

License

See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.

Copyright

Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.