-
-
Notifications
You must be signed in to change notification settings - Fork 8.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[JENKINS-70199] Add distributed builds telemetry (#7470)
Co-authored-by: Daniel Beck <[email protected]> Co-authored-by: Alexander Brandes <[email protected]>
- Loading branch information
1 parent
304b4b3
commit 7ff56d9
Showing
2 changed files
with
109 additions
and
0 deletions.
There are no files selected for viewing
92 changes: 92 additions & 0 deletions
92
core/src/main/java/jenkins/telemetry/impl/DistributedBuilds.java
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
/* | ||
* The MIT License | ||
* | ||
* Copyright (c) 2022, CloudBees, Inc. | ||
* | ||
* Permission is hereby granted, free of charge, to any person obtaining a copy | ||
* of this software and associated documentation files (the "Software"), to deal | ||
* in the Software without restriction, including without limitation the rights | ||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
* copies of the Software, and to permit persons to whom the Software is | ||
* furnished to do so, subject to the following conditions: | ||
* | ||
* The above copyright notice and this permission notice shall be included in | ||
* all copies or substantial portions of the Software. | ||
* | ||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
* THE SOFTWARE. | ||
*/ | ||
|
||
package jenkins.telemetry.impl; | ||
|
||
import edu.umd.cs.findbugs.annotations.NonNull; | ||
import hudson.Extension; | ||
import hudson.ExtensionList; | ||
import hudson.model.Node; | ||
import hudson.slaves.Cloud; | ||
import java.time.LocalDate; | ||
import java.util.HashMap; | ||
import java.util.Map; | ||
import jenkins.diagnostics.ControllerExecutorsAgents; | ||
import jenkins.diagnostics.ControllerExecutorsNoAgents; | ||
import jenkins.model.Jenkins; | ||
import jenkins.telemetry.Telemetry; | ||
import net.sf.json.JSONObject; | ||
import org.kohsuke.accmod.Restricted; | ||
import org.kohsuke.accmod.restrictions.NoExternalUse; | ||
|
||
@Restricted(NoExternalUse.class) | ||
@Extension | ||
public class DistributedBuilds extends Telemetry { | ||
@NonNull | ||
@Override | ||
public String getDisplayName() { | ||
return "Distributed Builds"; | ||
} | ||
|
||
@NonNull | ||
@Override | ||
public LocalDate getStart() { | ||
return LocalDate.of(2022, 12, 1); | ||
} | ||
|
||
@NonNull | ||
@Override | ||
public LocalDate getEnd() { | ||
return LocalDate.of(2023, 3, 1); | ||
} | ||
|
||
@Override | ||
public JSONObject createContent() { | ||
JSONObject payload = new JSONObject(); | ||
|
||
payload.put("controllerExecutors", Jenkins.get().getNumExecutors()); | ||
|
||
// Capture whether admin monitors are dismissed | ||
payload.put("controllerExecutorsWithAgentsWarning", ExtensionList.lookupSingleton(ControllerExecutorsAgents.class).isEnabled()); | ||
payload.put("controllerExecutorsWithoutAgentsWarning", ExtensionList.lookupSingleton(ControllerExecutorsNoAgents.class).isEnabled()); | ||
|
||
Map<String, Integer> clouds = new HashMap<>(); | ||
for (Cloud cloud : Jenkins.get().clouds) { | ||
clouds.compute(cloud.getClass().getName(), (key, value) -> value == null ? 1 : value + 1); | ||
} | ||
payload.put("clouds", clouds); | ||
|
||
Map<String, Integer> agents = new HashMap<>(); | ||
for (Node agent : Jenkins.get().getNodes()) { | ||
agents.compute(agent.getClass().getName(), (key, value) -> value == null ? 1 : value + 1); | ||
} | ||
payload.put("agents", agents); | ||
|
||
// Try to understand the complexity of the instance | ||
payload.put("items", Jenkins.get().getAllItems().size()); | ||
|
||
payload.put("components", buildComponentInformation()); | ||
return payload; | ||
} | ||
} |
17 changes: 17 additions & 0 deletions
17
core/src/main/resources/jenkins/telemetry/impl/DistributedBuilds/description.jelly
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
<?jelly escape-by-default='true'?> | ||
<j:jelly xmlns:j="jelly:core"> | ||
This trial collects basic information about how distributed builds are set up on this Jenkins instance: | ||
<ul> | ||
<li>The number of executors configured on the controller</li> | ||
<li>The number and kind of agents</li> | ||
<li>The number and kind of clouds</li> | ||
<li>Whether any of the administrative monitors related to distributed builds have been disabled</li> | ||
</ul> | ||
Additionally, the following general information is collected: | ||
<ul> | ||
<li>The total number of items (folders and jobs) on the instance</li> | ||
<li>Jenkins version</li> | ||
<li>Installed plugins and their versions</li> | ||
</ul> | ||
This data will be used to understand how common various distributed builds setups (all local, static agents only, clouds only, mixed, with or without executors on the controller) are, and how they correlate to the number of jobs. | ||
</j:jelly> |