-
-
Notifications
You must be signed in to change notification settings - Fork 8.8k
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
NotMyFault
merged 2 commits into
jenkinsci:master
from
daniel-beck:file.encoding-telemetry
Dec 19, 2023
+122
−1
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
92 changes: 92 additions & 0 deletions
92
core/src/main/java/jenkins/telemetry/impl/JavaSystemProperties.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) 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"; | ||
} | ||
|
||
@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); | ||
} | ||
o.put("components", buildComponentInformation()); | ||
return o; | ||
} | ||
} |
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
24 changes: 24 additions & 0 deletions
24
core/src/main/resources/jenkins/telemetry/impl/JavaSystemProperties/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,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> |
5 changes: 5 additions & 0 deletions
5
core/src/main/resources/jenkins/telemetry/impl/JavaSystemProperties/description.properties
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,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. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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 currentTelemetry
implementation) indescription.jelly
.