-
Notifications
You must be signed in to change notification settings - Fork 291
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into feature/general/delete-not-enrolled-users
- Loading branch information
Showing
81 changed files
with
2,839 additions
and
1,504 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
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
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,37 @@ | ||
.. _telemetry: | ||
|
||
Telemetry | ||
========= | ||
|
||
To help to improve Artemis, we collect some data when the application starts. | ||
This feature can be disabled by setting `telemetry.enabled` in the `application-prod.yml` to `false`. | ||
When this is set to false, no data is sent to the Artemis maintainer team. | ||
By setting `telemetry.sendAdminDetails` to false, personal information of the instance's admin (i.e. contact email and name) is excluded from the telemetry data. | ||
This includes the contact email and the administrator's name. | ||
|
||
Artemis collects the following data at the startup of an instance: | ||
|
||
* The used Artemis version | ||
* The contact email address of the admin, which is set in `info.contact` | ||
* The name of the admin, set in `info.operatorAdminName` (optional) | ||
* The server's URL | ||
* The operator's name | ||
* The used profiles (e.g. Gitlab, Jenkins, LocalVC, Aeolus, ...) | ||
|
||
Example configuration in `application-prod.yml`: | ||
|
||
.. code-block:: yaml | ||
artemis: | ||
telemetry: | ||
enabled: true | ||
sendAdminDetails: false | ||
destination: telemetry.artemis.cit.tum.de | ||
info: | ||
contact: [email protected] | ||
operatorName: Technical University of Munich | ||
operatorAdminName: Stephan Krusche | ||
We collect this data to enhance Artemis by understanding how it is used, ensuring compatibility with different configurations, and providing better support to our users. | ||
Collecting admin contact information allows us to communicate important updates or address critical issues directly. |
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
Large diffs are not rendered by default.
Oops, something went wrong.
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
31 changes: 31 additions & 0 deletions
31
src/main/java/de/tum/in/www1/artemis/config/PropertiesConfigurationGuard.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,31 @@ | ||
package de.tum.in.www1.artemis.config; | ||
|
||
import static de.tum.in.www1.artemis.config.Constants.PROFILE_SCHEDULING; | ||
|
||
import org.slf4j.Logger; | ||
import org.slf4j.LoggerFactory; | ||
import org.springframework.beans.factory.InitializingBean; | ||
import org.springframework.beans.factory.annotation.Value; | ||
import org.springframework.context.annotation.Profile; | ||
import org.springframework.stereotype.Component; | ||
|
||
@Component | ||
@Profile(PROFILE_SCHEDULING) | ||
public class PropertiesConfigurationGuard implements InitializingBean { | ||
|
||
private static final Logger log = LoggerFactory.getLogger(PropertiesConfigurationGuard.class); | ||
|
||
@Value("${info.operatorName:#{null}}") | ||
private String operatorName; | ||
|
||
/** | ||
* Checks if the info.operatorName value is set in the configuration ymls, and exits the application if not. | ||
*/ | ||
public void afterPropertiesSet() { | ||
if (this.operatorName == null || this.operatorName.isEmpty()) { | ||
log.error( | ||
"The name of the operator (University) is not configured in the application-prod.yml! It is needed to be displayed in the /about page, and for the telemetry service."); | ||
throw new IllegalArgumentException("The name of the operator (university) must be configured, but is not!"); | ||
} | ||
} | ||
} |
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
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
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
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
Oops, something went wrong.