https://github.com/dadoonet/injector
This injector is used to demo elasticsearch and Kibana.
https://github.com/dadoonet/injector
elasticsearch java
Last synced: 5 months ago
JSON representation
This injector is used to demo elasticsearch and Kibana.
- Host: GitHub
- URL: https://github.com/dadoonet/injector
- Owner: dadoonet
- License: apache-2.0
- Created: 2021-10-28T07:51:25.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-14T09:17:53.000Z (about 1 year ago)
- Last Synced: 2025-04-14T10:28:55.983Z (about 1 year ago)
- Topics: elasticsearch, java
- Language: Java
- Homepage:
- Size: 8.59 MB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.markdown
- License: LICENSE.txt
Awesome Lists containing this project
README
# Injector for demos
This injector is used to demo
[elasticsearch](https://www.elastic.co/products/elasticsearch) and [Kibana](https://www.elastic.co/products/kibana).
| Injector | elasticsearch | Release date |
|:-------------------|:-------------------------|:------------:|
| 8.17-SNAPSHOT | 8.17.4 | |
| 8.16 | 8.16.1 | 2024-12-09 |
| 8.15 | 8.15.1 | 2024-09-23 |
| 8.7 | 8.7.0 | 2023-04-20 |
| 8.6 | 8.6.0 | 2023-01-12 |
| 8.4 | 8.4.1 | 2022-09-06 |
| 8.3 | 8.3.1 | 2022-07-06 |
| 8.0 | 8.0.0 | 2022-02-16 |
| 7.15 | 7.15.1 | 2021-10-28 |
| 7.0 | 7.0.0 | 2019-04-11 |
| 6.5 | 6.5.1 | 2018-12-03 |
| 6.4.2 | 6.4.2 | 2018-10-03 |
| 6.4 | 6.4.0 | 2018-09-06 |
| 6.2 | 6.2.3 | 2018-04-09 |
| 6.0 | 6.0.0-alpha1 | 2017-05-10 |
| 5.3 | 5.3.2 | 2017-05-05 |
| 5.0 | 5.0.0 | 2016-10-03 |
| 5.0 | 5.0.0 | 2016-03-31 |
| 5.0 | 5.0.0-alpha1 | 2016-03-30 |
| 3.2 | 2.2.0 | 2016-02-05 |
| 3.1 | 2.1.0 | 2015-11-27 |
| 3.0 | 2.0.0 | 2015-11-12 |
| 2.10 | 1.7.1 | 2015-09-07 |
| 2.9 | 1.6.0 | 2015-06-15 |
| 2.8 | 1.5.2 | 2015-06-01 |
| 2.7 | 1.4.4 | 2015-02-24 |
| 2.6 | 1.4.0 | 2014-11-19 |
| 2.5 | 1.3.2 | 2014-09-02 |
| 2.4 | 1.2.0 | 2014-05-26 |
| 2.3 | 1.1.1 | 2014-05-06 |
| 2.2 | 1.1.0 | 2014-04-01 |
| 2.1 | 1.0.0 | 2014-03-21 |
| 2.1.RC2 | 1.0.0.RC2 | 2014-02-04 |
| 2.1.RC1 | 1.0.0.RC1 | 2014-01-23 |
| 1.1 | 0.90.6 | 2013-11-05 |
| 1.0 | 0.90.5 | 2013-10-01 |
`*` Broken version
## Status
[](https://maven-badges.herokuapp.com/maven-central/fr.pilato.elasticsearch.injector/injector/)
[](https://github.com/dadoonet/injector/actions/workflows/main.yml)
## Installation
### Local installation
You will need Java 17 to run the injector.
```sh
# Download it from maven central
wget https://repo1.maven.org/maven2/fr/pilato/elasticsearch/injector/injector/8.16/injector-8.16.jar
# Launch it (with all default settings)
java -jar injector-8.16.jar
```
If you are looking for a SNAPSHOT version, please look into
### Docker installation
```sh
# Pull the latest build
docker pull dadoonet/persons-injector
# Or a specific version
docker pull dadoonet/persons-injector:8.16
# Launch it (with all default settings)
docker run dadoonet/persons-injector
```
If you are looking for a SNAPSHOT version, please look into
## Usage
With no option, it will inject `1000000` documents with a bulk size of `10000` in a local cluster running at
with default password `changeme` for user named `elastic`.
Injector comes with the following implementations:
* Elasticsearch (`--elasticsearch` flag), where you want to index generated data to an elasticsearch cluster running locally or on [cloud](https://cloud.elastic.co/).
* Console (`--console` flag), where you want to just print on the console generated data.
For both, you can configure `--nb` option to define the number of documents you'd like to generate
(defaults to `1000000`).
Also `--bulk` option can be set to define how many documents should be sent at once (defaults to `10000`).
For example:
```sh
# Docker installation
docker run dadoonet/persons-injector --nb 1000 --bulk 100
# Local installation
java -jar injector-8.16.jar --nb 1000 --bulk 100
```
If no implementation is set, the injector will assume by default that you want to index your data in Elasticsearch
and will set `--elasticsearch` flag for you.
### Elasticsearch service
When running an Elasticsearch instance, local or on [cloud.elastic.co](https://cloud.elastic.co/), you can define other options.
To define the host to send the data to, set `--es.host` option (defaults to `https://127.0.0.1:9200`):
```sh
# Docker installation
docker run dadoonet/persons-injector --elasticsearch --es.host https://cloud_id.europe-west1.gcp.cloud.es.io:9243
# Local installation
java -jar injector-8.16.jar --elasticsearch --es.host https://cloud_id.europe-west1.gcp.cloud.es.io:9243
```
If your cluster is secured, which is what will happen most likely on cloud.elastic.co, use `--es.apikey` to set the [API Key](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html) to use.
```sh
# Docker installation
docker run dadoonet/persons-injector --elasticsearch --es.apikey API_KEY
# Local installation
java -jar injector-8.16.jar --elasticsearch --es.apikey API_KEY
```
If you'd like to index your data in another index than `person` (default one), use `--es.index`:
```sh
# Docker installation
docker run dadoonet/persons-injector --elasticsearch --es.index person
# Local installation
java -jar injector-8.16.jar --elasticsearch --es.index person
```
**Note:** `--es.user` (defaults to `elastic`) and `--es.pass` are deprecated and should not be used anymore.
If you want to use Kibana to display the information that have been generated, you can import the following
files into Kibana using `Stack Management -> Kibana -> Saved Objects` menu and click on "Import":
* Data view, Dashboard, Maps, Visualisations:
* Canvas example:
Example of the Persons dataset dashboard:
Example of the Canvas presentation:
### Console
When printing documents to the console, you can choose to prettify the documents first by using `cs.pretty` option:
```sh
# Docker installation
docker run dadoonet/persons-injector --console --cs.pretty
# Local installation
java -jar injector-8.16.jar --console --cs.pretty
```
### Using all services together
You can start the injector like this (all options together):
```sh
# Docker installation
docker run dadoonet/persons-injector \
--nb 1000 --bulk 100 \
--elasticsearch --es.host https://cloud_id.europe-west1.gcp.cloud.es.io:9243 --es.apikey API_KEY --es.index person \
--console --cs.pretty
# Local installation
java -jar injector-8.16.jar \
--nb 1000 --bulk 100 \
--debug \
--elasticsearch --es.host https://cloud_id.europe-west1.gcp.cloud.es.io:9243 --es.apikey API_KEY --es.index person \
--console --cs.pretty
```
When you build the project with maven, you'll see in `target/scripts` dir an example
of scripts which you can adapt to your needs.
### Debug options
You can use `--silent`, `--debug` or `--trace` to change the log level when using the injector.
That can give you more information when something is failing for example.
## Documentation
If you wish to edit the documentation, please edit it in `src/main/documentation`.
Then run the following commands to update the README in the root of this project and commit your changes:
```shell
mvn clean process-resources
git commit -a -m "Update documentation"
```
## Developer Guide
If you want to build it yourself or update to a new elasticsearch version, modify `pom.xml` file:
```xml
8.17.4
```
Then compile the project:
```sh
# Compile
mvn clean install
```
Just get the final jar from `target/injector-8.17-SNAPSHOT.jar`. Or:
```sh
cd target
```
And launch all the examples from this dir.
## Release guide
Ideally, modify the `src/main/documentation/README.markdown` file to add a static line with the release.
Also modify the `injector.stable.version` property in the `pom.xml` and commit the changes:
```shell
mvn clean process-resources
git commit -a -m "Document the stable version"
```
To release the project you need to run the release plugin with the `release` profile as you need to sign the artifacts:
```sh
mvn release:prepare
git push --tags
git push
mvn release:perform -Prelease
```
If you need to skip the tests, run:
```sh
mvn release:perform -Prelease -Darguments="-DskipTests"
```
If everything is ok in ,
you can confirm the release from the sonatype UI.
## License
```txt
This software is licensed under the Apache 2 license, quoted below.
Copyright 2009-2025 Elastic
Licensed under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under
the License.
```