Add support for Cloud Statistics plugin (#797)

Author: francoisferrand

pom.xml

@@ -103,6 +103,11 @@
       <groupId>org.jenkins-ci.plugins</groupId>
       <artifactId>bouncycastle-api</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins</groupId>
+      <artifactId>cloud-stats</artifactId>
+      <version>267.v577e3742c282</version>
+    </dependency>
     <dependency>
       <groupId>org.jenkins-ci.plugins</groupId>
       <artifactId>docker-commons</artifactId>

src/main/java/com/nirima/jenkins/plugins/docker/DockerCloud.java

@@ -47,6 +47,8 @@
 import java.util.concurrent.TimeUnit;
 import jenkins.authentication.tokens.api.AuthenticationTokens;
 import jenkins.model.Jenkins;
+import org.jenkinsci.plugins.cloudstats.ProvisioningActivity;
+import org.jenkinsci.plugins.cloudstats.TrackedPlannedNode;
 import org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint;
 import org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryToken;
 import org.jenkinsci.plugins.docker.commons.credentials.DockerServerEndpoint;
@@ -387,8 +389,10 @@ public synchronized Collection<NodeProvisioner.PlannedNode> provision(
                 LOGGER.info(
                         "Will provision '{}', for label: '{}', in cloud: '{}'", t.getImage(), label, getDisplayName());
 
+                final ProvisioningActivity.Id id = new ProvisioningActivity.Id(
+                        DockerCloud.this.name, t.getName() + " (" + t.getImage() + ")", null);
                 final CompletableFuture<Node> plannedNode = new CompletableFuture<>();
-                r.add(new NodeProvisioner.PlannedNode(t.getDisplayName(), plannedNode, t.getNumExecutors()));
+                r.add(new TrackedPlannedNode(id, t.getNumExecutors(), plannedNode));
 
                 final Runnable taskToCreateNewAgent = new Runnable() {
                     @Override
@@ -400,6 +404,7 @@ public void run() {
                             agent = t.provisionNode(api, TaskListener.NULL);
                             agent.setDockerAPI(api);
                             agent.setCloudId(DockerCloud.this.name);
+                            agent.setProvisioningId(id);
                             plannedNode.complete(agent);
 
                             // On provisioning completion, let's trigger NodeProvisioner

src/main/java/io/jenkins/docker/DockerComputer.java

@@ -2,18 +2,21 @@
 
 import com.nirima.jenkins.plugins.docker.DockerCloud;
 import edu.umd.cs.findbugs.annotations.CheckForNull;
+import edu.umd.cs.findbugs.annotations.Nullable;
 import hudson.EnvVars;
 import hudson.slaves.AbstractCloudComputer;
 import io.jenkins.docker.client.DockerAPI;
 import java.io.IOException;
+import org.jenkinsci.plugins.cloudstats.ProvisioningActivity;
+import org.jenkinsci.plugins.cloudstats.TrackedItem;
 import org.jenkinsci.plugins.docker.commons.credentials.DockerServerEndpoint;
 
 /**
  * Represents remote (running) container
  *
  * @author magnayn
  */
-public class DockerComputer extends AbstractCloudComputer<DockerTransientNode> {
+public class DockerComputer extends AbstractCloudComputer<DockerTransientNode> implements TrackedItem {
     // private static final Logger LOGGER = Logger.getLogger(DockerComputer.class.getName());
 
     public DockerComputer(DockerTransientNode node) {
@@ -62,4 +65,11 @@ public EnvVars getEnvironment() throws IOException, InterruptedException {
     public String toString() {
         return "DockerComputer{" + "name='" + super.getName() + '\'' + ", node='" + nodeName + '\'' + '}';
     }
+
+    @Nullable
+    @Override
+    public ProvisioningActivity.Id getId() {
+        final DockerTransientNode nodeOrNull = getNode();
+        return nodeOrNull == null ? null : nodeOrNull.getId();
+    }
 }

src/main/java/io/jenkins/docker/DockerTransientNode.java

@@ -9,6 +9,7 @@
 import com.nirima.jenkins.plugins.docker.DockerTemplate;
 import com.nirima.jenkins.plugins.docker.strategy.DockerOnceRetentionStrategy;
 import edu.umd.cs.findbugs.annotations.NonNull;
+import edu.umd.cs.findbugs.annotations.Nullable;
 import hudson.Extension;
 import hudson.model.Computer;
 import hudson.model.Descriptor;
@@ -20,6 +21,8 @@
 import java.io.IOException;
 import java.util.concurrent.atomic.AtomicBoolean;
 import jenkins.model.Jenkins;
+import org.jenkinsci.plugins.cloudstats.ProvisioningActivity;
+import org.jenkinsci.plugins.cloudstats.TrackedItem;
 import org.kohsuke.accmod.Restricted;
 import org.kohsuke.accmod.restrictions.NoExternalUse;
 import org.slf4j.Logger;
@@ -30,7 +33,7 @@
  *
  * @author <a href="mailto:[email protected]">Nicolas De Loof</a>
  */
-public class DockerTransientNode extends AbstractCloudSlave {
+public class DockerTransientNode extends AbstractCloudSlave implements TrackedItem {
     private static final long serialVersionUID = 1349729340506926183L;
     private static final Logger LOGGER = LoggerFactory.getLogger(DockerTransientNode.class.getName());
 
@@ -44,6 +47,8 @@ public class DockerTransientNode extends AbstractCloudSlave {
 
     private String cloudId;
 
+    private ProvisioningActivity.Id provisioningId;
+
     private AtomicBoolean acceptingTasks = new AtomicBoolean(true);
 
     /**
@@ -152,11 +157,25 @@ public void setCloudId(String cloudId) {
         this.cloudId = cloudId;
     }
 
+    public ProvisioningActivity.Id getProvisioningId() {
+        return provisioningId;
+    }
+
+    public void setProvisioningId(ProvisioningActivity.Id provisioningId) {
+        this.provisioningId = provisioningId.named(getNodeName());
+    }
+
     @Override
     public DockerComputer createComputer() {
         return new DockerComputer(this);
     }
 
+    @Nullable
+    @Override
+    public ProvisioningActivity.Id getId() {
+        return provisioningId;
+    }
+
     private interface ILogger {
         void println(String msg);