Skip to content

Commit

Permalink
Improve Jenkins plugin troubleshooting instructions (#26139)
Browse files Browse the repository at this point in the history
* Improve Jenkins plugin troubleshooting instructions

* Apply suggestions from code review

Co-authored-by: Bryce Eadie <[email protected]>

* Apply code review suggestion

* Update content/en/continuous_integration/pipelines/jenkins.md

Co-authored-by: Bryce Eadie <[email protected]>

* Apply suggestions from code review

Co-authored-by: Bryce Eadie <[email protected]>

---------

Co-authored-by: Bryce Eadie <[email protected]>
  • Loading branch information
nikita-tkachenko-datadog and buraizu authored Nov 10, 2024
1 parent e8c3cfc commit 2ceee35
Showing 1 changed file with 22 additions and 12 deletions.
34 changes: 22 additions & 12 deletions content/en/continuous_integration/pipelines/jenkins.md
Original file line number Diff line number Diff line change
Expand Up @@ -1455,27 +1455,37 @@ Send pipeline traces.
...
{{< /code-block >}}

### The Datadog Plugin cannot write payloads to the server
### Pipeline executions data is not available in Datadog

If the following error message appears in the **Jenkins Log**, make sure that the plugin configuration is correct.
#### HTTP connectivity check

{{< code-block lang="text" >}}
Error writing to server
{{< /code-block >}}
If your Jenkins instance is behind an HTTP proxy, go to **Manage Jenkins** > **Manage Plugins** > **Advanced tab** and make sure the proxy configuration is correct:
- If the Datadog plugin is configured to send data to a Datadog Agent, check that the Agent host has been added to the `No Proxy Hosts` section.
- If the Datadog plugin is configured to send data directly to Datadog (Agentless mode), check that Datadog host has been added to the `No Proxy Hosts` section. The table below shows the supported Datadog sites and their corresponding host values:

1. If you are using `localhost` as the hostname, try to change it to the server hostname instead.
2. If your Jenkins instance is behind an HTTP proxy, go to **Manage Jenkins** > **Manage Plugins** > **Advanced tab** and make sure the proxy configuration is correct.
| Datadog site | Host value |
| ------------ | ----------------------- |
| US1 | datadoghq.com |
| US3 | us3.datadoghq.com |
| US5 | us5.datadoghq.com |
| EU1 | datadoghq.eu |
| AP1 | ap1.datadoghq.com |

#### HTTP 504
#### The Datadog Plugin cannot write payloads to the server

If the HTTP 504 error message appears, make sure that the Jenkins proxy configuration is correct.
If the following error message appears in the **Jenkins Log**, make sure that the plugin configuration is correct.

{{< code-block lang="text" >}}
Failed to send HTTP request: PUT http://localhost:8126/v0.3/traces - Status: HTTP 504
Error writing to server
{{< /code-block >}}

1. If your Jenkins instance is behind an HTTP proxy, go to **Manage Jenkins** > **Manage Plugins** > **Advanced tab** and make sure the proxy configuration is correct.
1. Check that `localhost` has been configured in the `No Proxy Hosts` section.
If you are using `localhost` as the hostname, change it to the server hostname instead.

### Jenkins logs are not available in Datadog

If the Datadog plugin is configured to send data to a Datadog Agent, do the following:
- Make sure that custom log collection over TCP is [enabled and configured][29] in the Agent.
- Go to the plugin configuration UI and click **Test logs connection** to verify logs connectivity.

### The Datadog Plugin section does not appear in the Jenkins configuration

Expand Down

0 comments on commit 2ceee35

Please sign in to comment.