1. Create an issue describing the bug or enhancement you want to propose (select the right issue template).
2. Make sure the issue has been reviewed and agreed.
3. Create a Merge Request, from your **own** fork (see [forking workflow](https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html) documentation).
3. Create a Merge Request, from your **own** fork (see [forking workflow](https://docs.gitlab.com/user/project/repository/forking_workflow/) documentation).
Don't hesitate to mark your MR as `Draft` as long as you think it's not ready to be reviewed.
This project builds a Docker image able to send GitLab CI job information to any Elasticsearch server.
It is aimed at being used in GitLab CI as a [service container](https://docs.gitlab.com/ee/ci/services/)
It is aimed at being used in GitLab CI as a [service container](https://docs.gitlab.com/ci/services/)
in order to track _to be continuous_ usage and compute statistics.
## Which information is tracked ?
The _Tracking Probe Service_, whenever added as a [service container](https://docs.gitlab.com/ee/ci/services/)
The _Tracking Probe Service_, whenever added as a [service container](https://docs.gitlab.com/ci/services/)
of a GitLab CI job, will send the following JSON payload to one or several Elasticsearch servers:
```json
@@ -50,13 +50,13 @@ of a GitLab CI job, will send the following JSON payload to one or several Elast
}
```
Each of those information are retrieved from [GitLab CI predefined variables](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html).
Each of those information are retrieved from [GitLab CI predefined variables](https://docs.gitlab.com/ci/variables/predefined_variables/).
From this, you can build any valuable statistics, visualization or so.
## How is it used in GitLab CI ?
The Docker image can be used as a [service container](https://docs.gitlab.com/ee/ci/services/)
The Docker image can be used as a [service container](https://docs.gitlab.com/ci/services/)
in any GitLab CI file as follows:
```yaml
@@ -79,7 +79,7 @@ some-job-test:
```
The 2 arguments passed to the service container are the template **name** and **version** that will be sent with
the JSON payload (the only 2 information that can't be retrieved from [GitLab CI predefined variables](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)).
the JSON payload (the only 2 information that can't be retrieved from [GitLab CI predefined variables](https://docs.gitlab.com/ci/variables/predefined_variables/)).
:bulb: this is configured in every _to be continuous_ template.
