This repository was archived by the owner on Jan 23, 2020. It is now read-only.
configure plugin using env vars#184
Merged
Merged
Conversation
gzussa
commented
Dec 17, 2019
gzussa
commented
Contributor
- Fixes Set dogstatsd endpoint in a dockerized environment #116
zippolyte
reviewed
Dec 17, 2019
|
|
||
| You have the option of configuring your Datadog plugin using environment variables. | ||
| You will have to specify three variables: | ||
| - `DATADOG_JENKINS_PLUGIN_REPORT_WITH` specify which authentication mechanism you want to use. When set to `DSD` it will use a DogStatsD Server to report to Datadog. Otherwise set it to the default `HTTP` value. |
Contributor
There was a problem hiding this comment.
Suggested change
| - `DATADOG_JENKINS_PLUGIN_REPORT_WITH` specify which authentication mechanism you want to use. When set to `DSD` it will use a DogStatsD Server to report to Datadog. Otherwise set it to the default `HTTP` value. | |
| - `DATADOG_JENKINS_PLUGIN_REPORT_WITH` specify which report mechanism you want to use. When set to `DSD` it uses a DogStatsD Server to report to Datadog. Otherwise set it to the default `HTTP` value. |
l0k0ms
reviewed
Dec 17, 2019
|
|
||
| ### Configure with the plugin user interface | ||
|
|
||
| To configure your newly installed Datadog Plugin, simply navigate to the `Manage Jenkins -> Configure System` page on your Jenkins installation. |
There was a problem hiding this comment.
Suggested change
| To configure your newly installed Datadog Plugin, simply navigate to the `Manage Jenkins -> Configure System` page on your Jenkins installation. | |
| To configure your newly installed Datadog Plugin, navigate to the `Manage Jenkins -> Configure System` page on your Jenkins installation. |
l0k0ms
reviewed
Dec 17, 2019
| @@ -179,7 +190,9 @@ You can use two ways to configure your plugin to submit data to Datadog. | |||
|
|
|||
| Once your configuration changes are finished, simply save them, and you're good to go! | |||
There was a problem hiding this comment.
We should avoid words like "simply" "quickly" "east"
Suggested change
| Once your configuration changes are finished, simply save them, and you're good to go! | |
| Once your configuration changes are finished, save them, and you're good to go! |
l0k0ms
reviewed
Dec 17, 2019
| Alternatively, you have the option of configuring your Datadog plugin using a Groovy script like this one: | ||
| ### Configure with a Groovy script | ||
|
|
||
| You have the option of configuring your Datadog plugin using a Groovy script like this one: |
There was a problem hiding this comment.
Suggested change
| You have the option of configuring your Datadog plugin using a Groovy script like this one: | |
| Configure your Datadog plugin using a Groovy script like this one |
l0k0ms
reviewed
Dec 17, 2019
|
|
||
| ### Configure with an environment variables | ||
|
|
||
| You have the option of configuring your Datadog plugin using environment variables. |
There was a problem hiding this comment.
Suggested change
| You have the option of configuring your Datadog plugin using environment variables. | |
| Configure your Datadog plugin using environment variables by specifying the three variables below: |
l0k0ms
reviewed
Dec 17, 2019
| ### Configure with an environment variables | ||
|
|
||
| You have the option of configuring your Datadog plugin using environment variables. | ||
| You will have to specify three variables: |
There was a problem hiding this comment.
Suggested change
| You will have to specify three variables: |
l0k0ms
reviewed
Dec 17, 2019
| You will have to specify three variables: | ||
| - `DATADOG_JENKINS_PLUGIN_REPORT_WITH` specify which authentication mechanism you want to use. When set to `DSD` it will use a DogStatsD Server to report to Datadog. Otherwise set it to the default `HTTP` value. | ||
|
|
||
| If you set `DATADOG_JENKINS_PLUGIN_REPORT_WITH` with the `DSD` value, you will have to specify the following environment variables: |
There was a problem hiding this comment.
Suggested change
| If you set `DATADOG_JENKINS_PLUGIN_REPORT_WITH` with the `DSD` value, you will have to specify the following environment variables: | |
| If you set `DATADOG_JENKINS_PLUGIN_REPORT_WITH` with the `DSD` value, you must specify the following environment variables: |
l0k0ms
reviewed
Dec 17, 2019
| - `DATADOG_JENKINS_PLUGIN_REPORT_WITH` specify which authentication mechanism you want to use. When set to `DSD` it will use a DogStatsD Server to report to Datadog. Otherwise set it to the default `HTTP` value. | ||
|
|
||
| If you set `DATADOG_JENKINS_PLUGIN_REPORT_WITH` with the `DSD` value, you will have to specify the following environment variables: | ||
| - `DATADOG_JENKINS_PLUGIN_TARGET_HOST` which specify the DogStatsD Server host to report to. Default value is `localhost`. |
There was a problem hiding this comment.
Suggested change
| - `DATADOG_JENKINS_PLUGIN_TARGET_HOST` which specify the DogStatsD Server host to report to. Default value is `localhost`. | |
| - `DATADOG_JENKINS_PLUGIN_TARGET_HOST` which specifies the DogStatsD Server host to report to. Default value is `localhost`. |
l0k0ms
reviewed
Dec 17, 2019
|
|
||
| If you set `DATADOG_JENKINS_PLUGIN_REPORT_WITH` with the `DSD` value, you will have to specify the following environment variables: | ||
| - `DATADOG_JENKINS_PLUGIN_TARGET_HOST` which specify the DogStatsD Server host to report to. Default value is `localhost`. | ||
| - `DATADOG_JENKINS_PLUGIN_TARGET_PORT` which specify the DogStatsD Server port to report to. Default value is `8125`. |
There was a problem hiding this comment.
Suggested change
| - `DATADOG_JENKINS_PLUGIN_TARGET_PORT` which specify the DogStatsD Server port to report to. Default value is `8125`. | |
| - `DATADOG_JENKINS_PLUGIN_TARGET_PORT` which specifies the DogStatsD Server port to report to. Default value is `8125`. |
l0k0ms
reviewed
Dec 17, 2019
| - `DATADOG_JENKINS_PLUGIN_TARGET_HOST` which specify the DogStatsD Server host to report to. Default value is `localhost`. | ||
| - `DATADOG_JENKINS_PLUGIN_TARGET_PORT` which specify the DogStatsD Server port to report to. Default value is `8125`. | ||
|
|
||
| If you set `DATADOG_JENKINS_PLUGIN_REPORT_WITH` with the `HTTP` value or don't specify it, you will have to specify the following environment variables: |
There was a problem hiding this comment.
Suggested change
| If you set `DATADOG_JENKINS_PLUGIN_REPORT_WITH` with the `HTTP` value or don't specify it, you will have to specify the following environment variables: | |
| If you set `DATADOG_JENKINS_PLUGIN_REPORT_WITH` with the `HTTP` value or don't specify it, you must specify the following environment variables: |
l0k0ms
reviewed
Dec 17, 2019
| - `DATADOG_JENKINS_PLUGIN_TARGET_PORT` which specify the DogStatsD Server port to report to. Default value is `8125`. | ||
|
|
||
| If you set `DATADOG_JENKINS_PLUGIN_REPORT_WITH` with the `HTTP` value or don't specify it, you will have to specify the following environment variables: | ||
| - `DATADOG_JENKINS_PLUGIN_TARGET_API_URL` which specify the Datadog API Endpoint to report to. Default value is `https://api.datadoghq.com/api/`. |
There was a problem hiding this comment.
Should we inline here the instructions for EU ?
Suggested change
| - `DATADOG_JENKINS_PLUGIN_TARGET_API_URL` which specify the Datadog API Endpoint to report to. Default value is `https://api.datadoghq.com/api/`. | |
| - `DATADOG_JENKINS_PLUGIN_TARGET_API_URL` which specifies the Datadog API Endpoint to report to. Default value is `https://api.datadoghq.com/api/`. |
l0k0ms
reviewed
Dec 17, 2019
|
|
||
| If you set `DATADOG_JENKINS_PLUGIN_REPORT_WITH` with the `HTTP` value or don't specify it, you will have to specify the following environment variables: | ||
| - `DATADOG_JENKINS_PLUGIN_TARGET_API_URL` which specify the Datadog API Endpoint to report to. Default value is `https://api.datadoghq.com/api/`. | ||
| - `DATADOG_JENKINS_PLUGIN_TARGET_API_KEY` which specify your Datadog API key in order to report to your Datadog account. |
There was a problem hiding this comment.
Suggested change
| - `DATADOG_JENKINS_PLUGIN_TARGET_API_KEY` which specify your Datadog API key in order to report to your Datadog account. | |
| - `DATADOG_JENKINS_PLUGIN_TARGET_API_KEY` which specifies your Datadog API key in order to report to your Datadog account. |
l0k0ms
reviewed
Dec 17, 2019
| If you set `DATADOG_JENKINS_PLUGIN_REPORT_WITH` with the `HTTP` value or don't specify it, you will have to specify the following environment variables: | ||
| - `DATADOG_JENKINS_PLUGIN_TARGET_API_URL` which specify the Datadog API Endpoint to report to. Default value is `https://api.datadoghq.com/api/`. | ||
| - `DATADOG_JENKINS_PLUGIN_TARGET_API_KEY` which specify your Datadog API key in order to report to your Datadog account. | ||
| - Find your API Key from the [API Keys](https://app.datadoghq.com/account/settings#api) page on your Datadog account. |
There was a problem hiding this comment.
Suggested change
| - Find your API Key from the [API Keys](https://app.datadoghq.com/account/settings#api) page on your Datadog account. | |
| - Get your API Key from the [Datadog API Keys page](https://app.datadoghq.com/account/settings#api). |
l0k0ms
reviewed
Dec 18, 2019
| * Global Tags | ||
| * A comma-separated list of tags to apply to all metrics, events, service checks. | ||
| * Blacklisted Jobs | ||
| * A comma-separated list of regex to match job names that should not be monitored. (eg: susans-job,johns-.*,prod_folder/prod_release). |
There was a problem hiding this comment.
Suggested change
| * A comma-separated list of regex to match job names that should not be monitored. (eg: susans-job,johns-.*,prod_folder/prod_release). | |
| * A comma-separated list of regex to match job names that should not be monitored. (eg: `susans-job,johns-.*,prod_folder/prod_release`). |
l0k0ms
reviewed
Dec 18, 2019
| ### Configure with an environment variables | ||
|
|
||
| Configure your Datadog plugin using environment variables by specifying the three variables below:. | ||
| - `DATADOG_JENKINS_PLUGIN_REPORT_WITH` specify which report mechanism you want to use. When set to `DSD` it will use a DogStatsD Server to report to Datadog. Otherwise set it to the default `HTTP` value. |
There was a problem hiding this comment.
Suggested change
| - `DATADOG_JENKINS_PLUGIN_REPORT_WITH` specify which report mechanism you want to use. When set to `DSD` it will use a DogStatsD Server to report to Datadog. Otherwise set it to the default `HTTP` value. | |
| - `DATADOG_JENKINS_PLUGIN_REPORT_WITH` which specifies which report mechanism you want to use. When set to `DSD` it will use a DogStatsD Server to report to Datadog. Otherwise set it to the default `HTTP` value. |
l0k0ms
approved these changes
Dec 18, 2019
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.