Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Datadog Jenkins plugin configuration instructions #27181

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+50 −4
Open

Update Datadog Jenkins plugin configuration instructions #27181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 50 additions & 4 deletions content/en/continuous_integration/pipelines/jenkins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,10 @@
2. (Optional) Configure your CI Instance name.
8. (Optional) Configure logs collection:
1. Enable the `Enable Log Collection` checkbox.
9. Save your configuration.
9. (Optional) Enter the name of the host that you use to access Datadog UI (e.g. `app.datadoghq.com`) in the `Datadog App hostname` field.

Check warning on line 99 in content/en/continuous_integration/pipelines/jenkins.md

View workflow job for this annotation

GitHub Actions / vale

Datadog.abbreviations 

Use 'for example' instead of abbreviations like 'e.g.'.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
9. (Optional) Enter the name of the host that you use to access Datadog UI (e.g. `app.datadoghq.com`) in the `Datadog App hostname` field.
9. (Optional) Enter the name of the host that you use to access Datadog UI (for example, `app.datadoghq.com`) in the `Datadog App hostname` field.

10. Save your configuration.

{{< img src="ci/jenkins_plugin_agentless_urls_blurred.png" alt="Datadog Plugin configuration for Jenkins" style="width:100%;">}}
{{< img src="ci/ci-jenkins-plugin-config-agentless.png" alt="Datadog Plugin configuration for Jenkins" style="width:100%;">}}

[1]: /getting_started/site/#access-the-datadog-site
{{% /tab %}}
Expand All @@ -117,7 +118,8 @@
1. Configure the `Log Collection` port as configured in the Datadog Agent.
2. Click the `Test logs connection` button to verify that your configuration is valid.
3. Enable the `Enable Log Collection` checkbox.
7. Save your configuration.
7. (Optional) Enter the name of the host that you use to access Datadog UI (e.g. `app.datadoghq.com`) in the `Datadog App hostname` field.

Check warning on line 121 in content/en/continuous_integration/pipelines/jenkins.md

View workflow job for this annotation

GitHub Actions / vale

Datadog.abbreviations 

Use 'for example' instead of abbreviations like 'e.g.'.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
7. (Optional) Enter the name of the host that you use to access Datadog UI (e.g. `app.datadoghq.com`) in the `Datadog App hostname` field.
7. (Optional) Enter the name of the host that you use to access Datadog UI (for example, `app.datadoghq.com`) in the `Datadog App hostname` field.

8. Save your configuration.

{{< img src="ci/ci-jenkins-plugin-config-agentful.png" alt="Datadog Plugin configuration for Jenkins" style="width:100%;">}}
{{% /tab %}}
Expand Down Expand Up @@ -152,6 +154,8 @@
enableCiVisibility: true
# (Optional) Configure your CI Instance name
ciInstanceName: 'jenkins'
# (Optional) Configure the name of the host that you use to access Datadog UI
datadogAppHostname: 'app.datadoghq.com'
# (Optional) Enable logs collection
collectBuildLogs: true
{{< /code-block >}}
Expand All @@ -177,6 +181,8 @@
enableCiVisibility: true
# (Optional) Configure your CI Instance name
ciInstanceName: 'jenkins'
# (Optional) Configure the name of the host that you use to access Datadog UI
datadogAppHostname: 'app.datadoghq.eu'
# (Optional) Enable logs collection
collectBuildLogs: true
{{< /code-block >}}
Expand All @@ -202,6 +208,8 @@
enableCiVisibility: true
# (Optional) Configure your CI Instance name
ciInstanceName: 'jenkins'
# (Optional) Configure the name of the host that you use to access Datadog UI
datadogAppHostname: 'app.ddog-gov.com'
# (Optional) Enable logs collection
collectBuildLogs: true
{{< /code-block >}}
Expand All @@ -225,8 +233,10 @@
credentialsId: 'my-api-key-credentials-id'
# Enable CI Visibility flag
enableCiVisibility: true
# (Optional) Configure your CI Instance name
# (Optional) Configure the name of the host that you use to access Datadog UI
ciInstanceName: 'jenkins'
# (Optional) Configure your Datadog app hostname
datadogAppHostname: 'app.us3.datadoghq.com'
# (Optional) Enable logs collection
collectBuildLogs: true
{{< /code-block >}}
Expand All @@ -252,6 +262,8 @@
enableCiVisibility: true
# (Optional) Configure your CI Instance name
ciInstanceName: 'jenkins'
# (Optional) Configure the name of the host that you use to access Datadog UI
datadogAppHostname: 'app.us5.datadoghq.com'
# (Optional) Enable logs collection
collectBuildLogs: true
{{< /code-block >}}
Expand All @@ -277,6 +289,8 @@
enableCiVisibility: true
# (Optional) Configure your CI Instance name
ciInstanceName: 'jenkins'
# (Optional) Configure the name of the host that you use to access Datadog UI
datadogAppHostname: 'app.ap1.datadoghq.com'
# (Optional) Enable logs collection
collectBuildLogs: true
{{< /code-block >}}
Expand Down Expand Up @@ -312,6 +326,8 @@
enableCiVisibility: true
# (Optional) Configure your CI Instance name
ciInstanceName: 'jenkins'
# (Optional) Configure the name of the host that you use to access Datadog UI
datadogAppHostname: 'app.datadoghq.com'
# (Optional) Enable logs collection
collectBuildLogs: true
{{< /code-block >}}
Expand Down Expand Up @@ -350,6 +366,7 @@
def apiKey = new DatadogTextApiKey(Secret.fromString('<YOUR_API_KEY>')) // or `new DatadogCredentialsApiKey('<YOUR_CREDENTIALS_ID>')`
datadog.datadogClientConfiguration = new DatadogApiConfiguration(site, apiKey)

datadog.datadogAppHostname = 'app.datadoghq.com' // the name of the host that you use to access Datadog UI
datadog.enableCiVisibility = true
datadog.collectBuildLogs = true // (Optional) Enable logs collection

Expand Down Expand Up @@ -378,6 +395,7 @@
def apiKey = new DatadogTextApiKey(Secret.fromString('<YOUR_API_KEY>')) // or `new DatadogCredentialsApiKey('<YOUR_CREDENTIALS_ID>')`
datadog.datadogClientConfiguration = new DatadogApiConfiguration(site, apiKey)

datadog.datadogAppHostname = 'app.datadoghq.eu' // the name of the host that you use to access Datadog UI
datadog.enableCiVisibility = true
datadog.collectBuildLogs = true // (Optional) Enable logs collection

Expand Down Expand Up @@ -406,6 +424,7 @@
def apiKey = new DatadogTextApiKey(Secret.fromString('<YOUR_API_KEY>')) // or `new DatadogCredentialsApiKey('<YOUR_CREDENTIALS_ID>')`
datadog.datadogClientConfiguration = new DatadogApiConfiguration(site, apiKey)

datadog.datadogAppHostname = 'app.ddog-gov.com' // the name of the host that you use to access Datadog UI
datadog.enableCiVisibility = true
datadog.collectBuildLogs = true // (Optional) Enable logs collection

Expand Down Expand Up @@ -434,6 +453,7 @@
def apiKey = new DatadogTextApiKey(Secret.fromString('<YOUR_API_KEY>')) // or `new DatadogCredentialsApiKey('<YOUR_CREDENTIALS_ID>')`
datadog.datadogClientConfiguration = new DatadogApiConfiguration(site, apiKey)

datadog.datadogAppHostname = 'app.us3.datadoghq.com' // the name of the host that you use to access Datadog UI
datadog.enableCiVisibility = true
datadog.collectBuildLogs = true // (Optional) Enable logs collection

Expand Down Expand Up @@ -462,6 +482,7 @@
def apiKey = new DatadogTextApiKey(Secret.fromString('<YOUR_API_KEY>')) // or `new DatadogCredentialsApiKey('<YOUR_CREDENTIALS_ID>')`
datadog.datadogClientConfiguration = new DatadogApiConfiguration(site, apiKey)

datadog.datadogAppHostname = 'app.us5.datadoghq.com' // the name of the host that you use to access Datadog UI
datadog.enableCiVisibility = true
datadog.collectBuildLogs = true // (Optional) Enable logs collection

Expand Down Expand Up @@ -490,6 +511,7 @@
def apiKey = new DatadogTextApiKey(Secret.fromString('<YOUR_API_KEY>')) // or `new DatadogCredentialsApiKey('<YOUR_CREDENTIALS_ID>')`
datadog.datadogClientConfiguration = new DatadogApiConfiguration(site, apiKey)

datadog.datadogAppHostname = 'app.ap1.datadoghq.com' // the name of the host that you use to access Datadog UI
datadog.enableCiVisibility = true
datadog.collectBuildLogs = true // (Optional) Enable logs collection

Expand Down Expand Up @@ -521,6 +543,7 @@
def agentTraceCollectionPort = 8126 // Configure traces collection port
datadog.datadogClientConfiguration = new DatadogAgentConfiguration(agentHost, agentPort, agentLogCollectionPort, agentTraceCollectionPort)

datadog.datadogAppHostname = 'app.datadoghq.com' // the name of the host that you use to access Datadog UI
datadog.enableCiVisibility = true
datadog.collectBuildLogs = true // (Optional) Enable logs collection

Expand Down Expand Up @@ -559,6 +582,9 @@

# (Optional) Enable logs collection
DATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true

# (Optional) Configure the name of the host that you use to access Datadog UI
DATADOG_JENKINS_PLUGIN_DATADOG_APP_HOSTNAME=app.datadoghq.com
{{< /code-block >}}

{{% /site-region %}}
Expand All @@ -582,6 +608,9 @@

# (Optional) Enable logs collection
DATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true

# (Optional) Configure the name of the host that you use to access Datadog UI
DATADOG_JENKINS_PLUGIN_DATADOG_APP_HOSTNAME=app.datadoghq.eu
{{< /code-block >}}

{{% /site-region %}}
Expand All @@ -605,6 +634,9 @@

# (Optional) Enable logs collection
DATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true

# (Optional) Configure the name of the host that you use to access Datadog UI
DATADOG_JENKINS_PLUGIN_DATADOG_APP_HOSTNAME=app.ddog-gov.com
{{< /code-block >}}

{{% /site-region %}}
Expand All @@ -628,6 +660,9 @@

# (Optional) Enable logs collection
DATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true

# (Optional) Configure the name of the host that you use to access Datadog UI
DATADOG_JENKINS_PLUGIN_DATADOG_APP_HOSTNAME=app.us3.datadoghq.com
{{< /code-block >}}

{{% /site-region %}}
Expand All @@ -651,6 +686,9 @@

# (Optional) Enable logs collection
DATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true

# (Optional) Configure the name of the host that you use to access Datadog UI
DATADOG_JENKINS_PLUGIN_DATADOG_APP_HOSTNAME=app.us5.datadoghq.com
{{< /code-block >}}

{{% /site-region %}}
Expand All @@ -674,6 +712,9 @@

# (Optional) Enable logs collection
DATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true

# (Optional) Configure the name of the host that you use to access Datadog UI
DATADOG_JENKINS_PLUGIN_DATADOG_APP_HOSTNAME=app.ap1.datadoghq.com
{{< /code-block >}}
{{% /site-region %}}

Expand Down Expand Up @@ -704,6 +745,9 @@

# (Optional) Enable logs collection
DATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true

# (Optional) Configure the name of the host that you use to access Datadog UI
DATADOG_JENKINS_PLUGIN_DATADOG_APP_HOSTNAME=app.datadoghq.com
```

2. Restart your Jenkins instance.
Expand Down Expand Up @@ -821,6 +865,8 @@
The minimum required Git info for a build is repository URL, branch, commit SHA, and commit author email.
This information can be determined by the plugin automatically, propagated from SCM, provided manually with environment variables, or obtained by combining these approaches.

**Note:** If a pipeline checks out multiple repositories, Git info of the repositories that are checked out later in the pipeline has higher priority.

### Propagate Git information from SCM

The Jenkins plugin is capable of automatically detecting Git information associated with a build or a pipeline.
Expand Down
Binary file modified static/images/ci/ci-jenkins-plugin-config-agentful.png
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For images, can you re-add the deleted images and use a different name for the new image? Replacing images with the same name sometimes causes cacheing issues.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/ci/ci-jenkins-plugin-config-agentless.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading