-
Notifications
You must be signed in to change notification settings - Fork 71
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Bump version number to `7.8.0` * Configure `yarn test:jest` for unit test instead of `yarn test`
- Loading branch information
1 parent
d38e2e4
commit 5c46cf0
Showing
7 changed files
with
4,049 additions
and
437 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,4 +5,5 @@ node_modules | |
.idea/ | ||
yarn-error.log | ||
/coverage/ | ||
.DS_Store | ||
.DS_Store | ||
.history/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,67 @@ | ||
# Kibana Reports | ||
# 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 ](https://github.com/opendistro-for-elasticsearch/kibana-reports/issues) and view project progress here [RFCs](https://github.com/opendistro-for-elasticsearch/kibana-reports/projects/1). | ||
# Request for Comments ( RFC ) | ||
|
||
# License | ||
Please add your feature requests here [ New Requests ](https://github.com/opendistro-for-elasticsearch/kibana-reports/issues) and view project progress here [RFCs](https://github.com/opendistro-for-elasticsearch/kibana-reports/projects/1). | ||
|
||
This project is licensed under the Apache-2.0 License. | ||
## Setup | ||
|
||
1. Download Elasticsearch for the version that matches the [Kibana version specified in package.json](./package.json#L7). | ||
1. Download the Kibana source code for the [version specified in package.json](./package.json#L7) you want to set up. | ||
|
||
See the [Kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md#setting-up-your-development-environment) for more instructions on setting up your development environment. | ||
|
||
1. Change your node version to the version specified in `.node-version` inside the Kibana root directory. | ||
1. Create a `plugins` directory inside the Kibana source code directory, if `plugins` directory doesn't exist. | ||
1. Check out this package from version control into the `plugins` directory. | ||
1. Run `yarn kbn bootstrap` inside `kibana/plugins/kibana-reports`. | ||
|
||
Ultimately, your directory structure should look like this: | ||
|
||
<!-- prettier-ignore --> | ||
```md | ||
. | ||
├── 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](./CONTRIBUTING.md) and join in. | ||
|
||
Since this is a Kibana plugin, it can be useful to review the [Kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md) alongside the documentation around [Kibana plugins](https://www.elastic.co/guide/en/kibana/master/kibana-plugins.html) and [plugin development](https://www.elastic.co/guide/en/kibana/master/plugin-development.html). | ||
|
||
## Code of Conduct | ||
|
||
This project has adopted an [Open Source Code of Conduct](https://opendistro.github.io/for-elasticsearch/codeofconduct.html). | ||
|
||
## 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](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue. | ||
|
||
## License | ||
|
||
See the [LICENSE](./LICENSE.txt) 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.