-
-
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.
Add telemetry for Jenkins uptime (#8596)
Co-authored-by: Daniel Beck <[email protected]>
- Loading branch information
1 parent
7a6e2b0
commit 3218599
Showing
2 changed files
with
76 additions
and
0 deletions.
There are no files selected for viewing
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,65 @@ | ||
/* | ||
* The MIT License | ||
* | ||
* Copyright (c) 2023, 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 java.time.LocalDate; | ||
import jenkins.telemetry.Telemetry; | ||
import net.sf.json.JSONObject; | ||
import org.kohsuke.accmod.Restricted; | ||
import org.kohsuke.accmod.restrictions.NoExternalUse; | ||
|
||
/** | ||
* Records approximations of when Jenkins was started and the current time, to allow for computation of uptime. | ||
*/ | ||
@Extension | ||
@Restricted(NoExternalUse.class) | ||
public class Uptime extends Telemetry { | ||
private static final long START = System.nanoTime(); | ||
|
||
@NonNull | ||
@Override | ||
public String getDisplayName() { | ||
return "Uptime"; | ||
} | ||
|
||
@NonNull | ||
@Override | ||
public LocalDate getStart() { | ||
return LocalDate.of(2023, 10, 20); | ||
} | ||
|
||
@NonNull | ||
@Override | ||
public LocalDate getEnd() { | ||
return LocalDate.of(2024, 1, 20); | ||
} | ||
|
||
@Override | ||
public JSONObject createContent() { | ||
return new JSONObject().element("start", START).element("now", System.nanoTime()).element("components", buildComponentInformation()); | ||
} | ||
} |
11 changes: 11 additions & 0 deletions
11
core/src/main/resources/jenkins/telemetry/impl/Uptime/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,11 @@ | ||
<?jelly escape-by-default='true'?> | ||
<j:jelly xmlns:j="jelly:core"> | ||
This trial collects two timestamps: | ||
<ul> | ||
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.html#nanoTime()"><code>System#nanoTime</code></a> when the trial was initialized (corresponds roughly to when Jenkins was started)</li> | ||
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.html#nanoTime()"><code>System#nanoTime</code></a> when the trial data was collected (i.e., when it was prepared just before submission)</li> | ||
</ul> | ||
|
||
Additionally this trial collects the list of installed plugins, their version, and the version of Jenkins. | ||
This data will help understand unexpected submission frequency of other trials' data. | ||
</j:jelly> |