Add a link to Datadog to job details page by nikita-tkachenko-datadog · Pull Request #447 · jenkinsci/datadog-plugin

nikita-tkachenko-datadog · 2024-09-16T13:01:22Z

Requirements for Contributing to this repository

Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
The pull request must only fix one issue at the time.
The pull request must update the test suite to demonstrate the changed functionality.
After you create the pull request, all status checks must be pass before a maintainer reviews your contribution. For more details, please see CONTRIBUTING.

What does this PR do?

If CI Visibility is enabled, adds a "View in Datadog" link to the details page of every traced job.

Description of the Change

Alternate Designs

Possible Drawbacks

Verification Process

Tested manually.

Additional Notes

Release Notes

Review checklist (to be filled by reviewers)

Feature or bug fix MUST have appropriate tests (unit, integration, etc...)
PR title must be written as a CHANGELOG entry (see why)
Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
PR must have one changelog/ label attached. If applicable it should have the backward-incompatible label attached.
PR should not have do-not-merge/ label attached.
If Applicable, issue must have kind/ and severity/ labels attached at least.

drodriguezhdez

Requested changes as the link does not take into account the datacenter region. (Host is different between them)

drodriguezhdez · 2024-09-18T11:09:52Z

+    public DatadogLinkAction(BuildData buildData) { // ci.pipeline.url%3A"https%3A%2F%2Fgoogle.com"
+        String query = String.format("ci_level:pipeline @ci.pipeline.name:\"%s\" @ci.pipeline.number:%s", buildData.getJobName(), buildData.getBuildNumber(""));
+        String urlEncodedQuery = URLEncoder.encode(query, StandardCharsets.UTF_8);
+        this.url = String.format("https://app.datadoghq.com/ci/pipeline-executions?query=%s", urlEncodedQuery);


The host will be different depending on the datacenter and/or, if the org has custom subdomains.
E.g. For orgs in Europe, the url is https://app.datadoghq.eu/........., etc.

This is typically resolved by asking customer to provide a DD_SITE environment variable (this does not cover custom subdomains, tho). For Jenkins, this does not seem the best approach, as it has its own config page.

I know it's the case when using the intakes, but is it the same when logging in to the UI though? I thought for the app the URL is always the same, as in the static docs we have https://app.datadoghq.com hardcoded.
I might be wrong though, will try asking someone who knows

I have updated the link to take Datadog site into account.

If Agentless mode is used, the site can de derived from the plugin configuration.

If Agentful mode is used, we cannot reliably detect the site unfortunately (I've checked Agent endpoints, talked to the people from the Agent team - there seems to be no easy way at the moment). So for this case I have added a dropdown with the site to the config UI: if the users choose a site value there, the link will be shown, otherwise it won't.

        }

+        @RequirePOST
+        public ListBoxModel doFillSiteItems() {


drodriguezhdez

Dropped some comments

drodriguezhdez · 2025-01-17T10:09:48Z

+    public DatadogLinkAction(BuildData buildData, String siteName) {
+        String query = String.format("ci_level:pipeline @ci.pipeline.name:\"%s\" @ci.pipeline.number:%s", buildData.getJobName(), buildData.getBuildNumber(""));
+        String urlEncodedQuery = URLEncoder.encode(query, StandardCharsets.UTF_8);
+        this.url = String.format("https://app.%s/ci/pipeline-executions?query=%s", siteName, urlEncodedQuery);


Notice that some orgs can have dedicated urls that are not the default app.%s.
Using this link won't work for them. Should we add this limitation somewhere?

Ahh, that is a good catch! I don't think there's a way to work around this, knowing only the site.
I asked around and did some tests of my own: the custom links indeed seem to replace the standard ones, not just be an alias in addition to them.

So what I ended up doing is adding a dedicated "Datadog App hostname" field to the plugin configuration.
The logic is as follows:

if the field is configured, we use its value to construct the link URL

if the field is empty, we try to infer the hostname using the intake URLs - this option will only work for agentless config

if agentful connectivity is configured (and the Datadog App hostname is not provided), we will not show the link at all

drodriguezhdez · 2025-01-17T10:14:53Z

+    <f:entry title="Datadog Site" field="site">
+      <f:select/>
+    </f:entry>
+


This new entry is under DatadogAgentConfiguration namespace. Is there any way to send data without using the agent?

We only need the user to specify the site manually if they're reporting through the agent. For the agentless mode we can deduce the site automatically, which is why I've only added this setting to the agent section.

This is not relevant anymore, now that I've added the dedicated field for Datadog App hostname (see the conversation above), so I reverted this addition.

drodriguezhdez · 2025-01-17T10:15:41Z

+    public String getDisplayName() {
+        return "View in Datadog";
+    }


Where this display is going to appear? Is it in the config section or in the pipeline detail?
I could not identify where it's used.

It is in the pipeline detail

Is there a possibility to disable this functionality? We use Datadog primarily for monitoring and not all of our developers have access to Datadog. This button is great for our Datadog-users, but it adds another button to the large list of actions on the Job Detail page.

@sebastiaanspeck I have added an environment property (DATADOG_JENKINS_PLUGIN_SHOW_DATADOG_LINKS) and a UI control to the plugin config to disable this: #495

drodriguezhdez

Dropped some comments

drodriguezhdez · 2025-01-17T14:02:44Z

      DATADOG_JENKINS_PLUGIN_TARGET_API_KEY: $JENKINS_PLUGIN_DATADOG_API_KEY
      DATADOG_JENKINS_PLUGIN_ENABLE_CI_VISIBILITY: true
      DATADOG_JENKINS_PLUGIN_CI_VISIBILITY_CI_INSTANCE_NAME: $JENKINS_PLUGIN_DATADOG_CI_INSTANCE_NAME
+      DATADOG_JENKINS_PLUGIN_DATADOG_APP_HOSTNAME: $JENKINS_PLUGIN_DATADOG_APP_HOSTNAME


Should we document this new env var in this PR?

Makes sense, added the env var (along with the UI and groovy-based config examples)

nikita-tkachenko-datadog added the changelog/Added Added features results into a minor version bump label Sep 16, 2024

nikita-tkachenko-datadog marked this pull request as ready for review September 16, 2024 14:08

drodriguezhdez requested changes Sep 18, 2024

View reviewed changes

nikita-tkachenko-datadog force-pushed the nikita-tkachenko/add-datadog-link branch from 9bf640e to 490a0c7 Compare September 19, 2024 17:03

github-actions Bot added the documentation Documentation related changes label Sep 19, 2024

nikita-tkachenko-datadog changed the base branch from master to nikita-tkachenko/configuration-refactoring-updated September 19, 2024 17:03

github-advanced-security AI found potential problems Sep 19, 2024

View reviewed changes

nikita-tkachenko-datadog marked this pull request as draft September 23, 2024 14:00

nikita-tkachenko-datadog force-pushed the nikita-tkachenko/configuration-refactoring-updated branch from 5f3a210 to d20b98e Compare October 11, 2024 11:01

nikita-tkachenko-datadog force-pushed the nikita-tkachenko/configuration-refactoring-updated branch from d20b98e to b8e26e6 Compare November 20, 2024 10:03

nikita-tkachenko-datadog force-pushed the nikita-tkachenko/configuration-refactoring-updated branch 2 times, most recently from 0404aa5 to 0260867 Compare December 5, 2024 15:55

Base automatically changed from nikita-tkachenko/configuration-refactoring-updated to master December 11, 2024 09:53

nikita-tkachenko-datadog force-pushed the nikita-tkachenko/add-datadog-link branch from 490a0c7 to 0277c0d Compare December 18, 2024 16:26

nikita-tkachenko-datadog marked this pull request as ready for review January 7, 2025 11:13

nikita-tkachenko-datadog requested a review from drodriguezhdez January 7, 2025 11:13

nikita-tkachenko-datadog force-pushed the nikita-tkachenko/add-datadog-link branch from 0277c0d to 35bf37d Compare January 10, 2025 11:37

Add a link to Datadog to job details page

1b7f781

nikita-tkachenko-datadog force-pushed the nikita-tkachenko/add-datadog-link branch from 35bf37d to 1b7f781 Compare January 14, 2025 12:04

drodriguezhdez reviewed Jan 17, 2025

View reviewed changes

drodriguezhdez self-requested a review January 17, 2025 10:17

drodriguezhdez reviewed Jan 17, 2025

View reviewed changes

Address review comments

b774817

nikita-tkachenko-datadog requested a review from drodriguezhdez January 17, 2025 13:43

drodriguezhdez reviewed Jan 17, 2025

View reviewed changes

Add Datadog App hostname config examples to docs

40a3a19

nikita-tkachenko-datadog requested a review from drodriguezhdez January 17, 2025 14:20

Fix a typo

9722c00

drodriguezhdez previously approved these changes Jan 17, 2025

View reviewed changes

Merge branch 'master' into nikita-tkachenko/add-datadog-link

f87c9e9

nikita-tkachenko-datadog dismissed drodriguezhdez’s stale review via f87c9e9 January 17, 2025 15:06

drodriguezhdez approved these changes Jan 17, 2025

View reviewed changes

nikita-tkachenko-datadog merged commit f64f715 into master Jan 17, 2025

nikita-tkachenko-datadog deleted the nikita-tkachenko/add-datadog-link branch January 17, 2025 15:56

nikita-tkachenko-datadog mentioned this pull request Jan 20, 2025

Add UI control and env var to configure if Datadog links are shown #495

Merged

6 tasks

Uh oh!

Conversation

nikita-tkachenko-datadog commented Sep 16, 2024

Requirements for Contributing to this repository

What does this PR do?

Description of the Change

Alternate Designs

Possible Drawbacks

Verification Process

Additional Notes

Release Notes

Review checklist (to be filled by reviewers)

Uh oh!

drodriguezhdez left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Check warning

drodriguezhdez left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

drodriguezhdez left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants