bilalbaraz / laravel-kibana
This allows you to use your kibana api
v0.1.1
2020-04-26 15:30 UTC
Requires
- php: ^7.2.5
- guzzlehttp/guzzle: ^6.5
- symfony/var-dumper: ^5.0
Requires (Dev)
- phpunit/phpunit: ^8.5
README
An easy way to use the official Kibana REST API in your Laravel applications.
Installation and Configuration
Install the current version of the bilalbaraz/laravel-kibana
package via composer:
composer require bilalbaraz/laravel-kibana
The package's service provider will automatically register its service provider.
Publish the configuration file:
php artisan vendor:publish --provider="Bilalbaraz\LaravelKibana\KibanaServiceProvider"
After you publish the configuration file as suggested above, you may configure Kibana by adding the following to your application's .env
file (with appropriate values):
KIBANA_VERSION=7.6.2 KIBANA_HOST=127.0.0.1 KIBANA_PORT=5601 KIBANA_SECURITY_ENABLED=true KIBANA_USERNAME=admin KIBANA_PASSWORD=password
Usage
T.B.D.
Documentation
Have a look at the documentation here.
Test
./vendor/bin/phpunit tests
Which Endpoints Have Been Implemented?
- Get features
- Create space
- Update space
- Get space
- Get all spaces
- Delete space
- Copy saved objects to space
- Resolve copy to space conflicts
- Create or update role
- Get specific role
- Get all roles
- Delete role
- Get object
- Bulk get objects
- Find objects
- Create saved objects
- Bulk create saved objects
- Update object
- Delete object
- Export objects
- Resolve import errors
- Import dashboard
- Export dashboard
Contributing
Contributions are welcome and will be fully credited.
We accept contributions via pull requests via Github.
- Fork the project.
- Create your bugfix/feature branch and write your (well-commented) code.
- Create unit tests for your code:
- Run
composer install --dev
in the root directory to install required testing packages. - Add your test classes/methods to the
/tests/
directory. - Run
vendor/bin/phpunit
and make sure everything passes (new and old tests).
- Run
- Commit your changes (and your tests) and push to your branch.
- Create a new pull request against this package's
master
branch.
Copyright and License
laravel-kibana was written by Bilal Baraz and is released under the MIT License.