Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add telemetry for basic Java system properties #8787

Merged
merged 2 commits into from
Dec 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
/*
* The MIT License
*
* Copyright (c) 2023, Daniel Beck
*
* 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 java.util.Map;
import java.util.TreeMap;
import jenkins.telemetry.Telemetry;
import net.sf.json.JSONObject;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;

/**
* Collect the value of various Java system properties describing the environment.
*/
@Extension
@Restricted(NoExternalUse.class)
public class JavaSystemProperties extends Telemetry {
private static final String[] PROPERTIES = new String[] {
"file.encoding",
"file.separator",
"java.vm.name",
"java.vm.vendor",
"java.vm.version",
"os.arch",
"os.name",
"os.version",
"user.language",
};

public Map<String, String> getProperties() {
Map<String, String> properties = new TreeMap<>();
for (String property : PROPERTIES) {
final String value = System.getProperty(property);
properties.put(property, value);
}
return properties;
}

@NonNull
@Override
public String getDisplayName() {
return "System Properties";

Check warning on line 67 in core/src/main/java/jenkins/telemetry/impl/JavaSystemProperties.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Not covered line

Line 67 is not covered by tests
}

@NonNull
@Override
public LocalDate getStart() {
return LocalDate.of(2023, 12, 17);
}

@NonNull
@Override
public LocalDate getEnd() {
return LocalDate.of(2024, 4, 1);
}

@Override
public JSONObject createContent() {
JSONObject o = new JSONObject();
for (Map.Entry<String, String> entry : getProperties().entrySet()) {
final String value = entry.getValue();
o = o.element(entry.getKey(), value == null ? "(undefined)" : value);

Check warning on line 87 in core/src/main/java/jenkins/telemetry/impl/JavaSystemProperties.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Partially covered line

Line 87 is only partially covered, one branch is missing
}
o.put("components", buildComponentInformation());
return o;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
<j:if test="${not collector.end.isBefore(now)}">
<dt>${collector.displayName}</dt>
<dd>
<st:include from="${collector}" optional="true" page="description.jelly"/>
<st:include it="${collector}" optional="true" page="description.jelly"/>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Required to be able to access it (the current Telemetry implementation) in description.jelly.

<p>
Start date: ${collector.start}<br/>
End date: ${collector.end}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<?jelly escape-by-default='true'?>
<j:jelly xmlns:j="jelly:core">
<p>
${%blurb}
</p>
<ul>
<j:forEach items="${it.properties.entrySet()}" var="e">
<li>
<tt>${e.key}</tt>
<j:choose>
<j:when test="${e.value == null}">
(current value: <em>undefined</em>)
</j:when>
<j:otherwise>
(current value: <tt>${e.value}</tt>)
</j:otherwise>
</j:choose>
</li>
</j:forEach>
</ul>
<p>
${%blurb2}
</p>
</j:jelly>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blurb = This trial collects the values of some basic Java system properties, that provide information about basic system configuration \
(OS, Java runtime, default language and character set). \
The collected system properties and their values are listed below.
blurb2 = Additionally, this trial collects the list of installed plugins, their version, and the version of Jenkins. \
This data will be used to understand the environments that Jenkins is running in.
Loading