Add optional logging of requests for non-existent/non-public PIDs #11601
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,161 @@ | ||
| /* | ||
| * To change this license header, choose License Headers in Project Properties. | ||
| * To change this template file, choose Tools | Templates | ||
| * and open the template in the editor. | ||
| */ | ||
| package edu.harvard.iq.dataverse.pidproviders; | ||
|
|
||
| import edu.harvard.iq.dataverse.authorization.groups.impl.ipaddress.ip.IpAddress; | ||
| import edu.harvard.iq.dataverse.batch.util.LoggingUtil; | ||
| import java.io.UnsupportedEncodingException; | ||
| import java.net.URLEncoder; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.sql.Timestamp; | ||
| import java.text.SimpleDateFormat; | ||
| import java.util.Date; | ||
| import jakarta.enterprise.context.RequestScoped; | ||
| import jakarta.inject.Named; | ||
|
|
||
| /** | ||
| * | ||
| * @author qqmyers | ||
| */ | ||
|
|
||
| @Named | ||
| @RequestScoped | ||
| public class FailedPIDResolutionLoggingServiceBean { | ||
|
|
||
| public static final String LOG_HEADER = "#Fields: pid\trequestURI\tHTTP method\tclient_ip\teventTime\n"; | ||
|
|
||
|
|
||
| public void logEntry(FailedPIDResolutionEntry entry) { | ||
| LoggingUtil.saveLogFileAppendWithHeader(entry.toString(), "../logs", getLogFileName(), LOG_HEADER); | ||
| } | ||
|
|
||
| public String getLogFileName() { | ||
| return "PIDFailures_" + new SimpleDateFormat("yyyy-MM").format(new Timestamp(new Date().getTime())) + ".log"; | ||
| } | ||
|
|
||
| public static class FailedPIDResolutionEntry { | ||
|
|
||
| private String eventTime; | ||
| private String clientIp; | ||
| private String requestUrl; | ||
| private String identifier; | ||
| private String method; | ||
|
|
||
| public FailedPIDResolutionEntry() { | ||
|
|
||
| } | ||
|
|
||
| public FailedPIDResolutionEntry(String persistentId, String requestURI, String method, IpAddress sourceAddress) { | ||
| try { | ||
| setIdentifier(URLEncoder.encode(persistentId, StandardCharsets.UTF_8.toString())); | ||
| } catch (UnsupportedEncodingException e) { | ||
| // Should never happen | ||
| e.printStackTrace(); | ||
| } | ||
| setRequestUrl(requestURI); | ||
| setMethod(method); | ||
| setClientIp(sourceAddress.toString()); | ||
| setEventTime(new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssZ").format(new Timestamp(new Date().getTime()))); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return getIdentifier() + "\t" + | ||
| getRequestUrl() + "\t" + | ||
| getMethod() + "\t" + | ||
| getClientIp() + "\t" + | ||
| getEventTime() + "\n"; | ||
| } | ||
|
|
||
| /** | ||
| * @return the eventTime | ||
| */ | ||
| public String getEventTime() { | ||
| if (eventTime == null) { | ||
| return "-"; | ||
| } | ||
| return eventTime; | ||
| } | ||
|
|
||
| /** | ||
| * @param eventTime | ||
| * the eventTime to set | ||
| */ | ||
| public final void setEventTime(String eventTime) { | ||
| this.eventTime = eventTime; | ||
| } | ||
|
|
||
| /** | ||
| * @return the clientIp | ||
| */ | ||
| public String getClientIp() { | ||
| if (clientIp == null) { | ||
| return "-"; | ||
| } | ||
| return clientIp; | ||
| } | ||
|
|
||
| /** | ||
| * @param clientIp | ||
| * the clientIp to set | ||
| */ | ||
| public final void setClientIp(String clientIp) { | ||
| this.clientIp = clientIp; | ||
| } | ||
|
|
||
| /** | ||
| * @return the HTTP Method | ||
| */ | ||
| public String getMethod() { | ||
| return method; | ||
| } | ||
|
|
||
| /** | ||
| * @param method | ||
| * - the HTTP Method used | ||
| */ | ||
| public final void setMethod(String method) { | ||
| this.method = method; | ||
| } | ||
|
|
||
| /** | ||
| * @return the requestUrl | ||
| */ | ||
| public String getRequestUrl() { | ||
| if (requestUrl == null) { | ||
| return "-"; | ||
| } | ||
| return requestUrl; | ||
| } | ||
|
|
||
| /** | ||
| * @param requestUrl | ||
| * the requestUrl to set | ||
| */ | ||
| public final void setRequestUrl(String requestUrl) { | ||
| this.requestUrl = requestUrl; | ||
| } | ||
|
|
||
| /** | ||
| * @return the identifier | ||
| */ | ||
| public String getIdentifier() { | ||
| if (identifier == null) { | ||
| return "-"; | ||
| } | ||
| return identifier; | ||
| } | ||
|
|
||
| /** | ||
| * @param identifier | ||
| * the identifier to set | ||
| */ | ||
| public final void setIdentifier(String identifier) { | ||
| this.identifier = identifier; | ||
| } | ||
|
|
||
| } | ||
| } |
|
pdurbin marked this conversation as resolved.
|
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -193,6 +193,18 @@ public enum FeatureFlags { | |
| * @since Dataverse 6.5 | ||
| */ | ||
| ADD_LOCAL_CONTEXTS_PERMISSION_CHECK("add-local-contexts-permission-check"), | ||
|
|
||
| /** | ||
| * This flag turns on creation of a monthly log file that tracks when requests for | ||
| * datasets/files with PIDs fail due to the PIDs not existing. This helps in catching | ||
| * cases where the DOI of a draft dataset has been cited, etc. | ||
| * | ||
| * @apiNote Raise flag by setting | ||
| * "dataverse.feature.enable-pid-failure-log" | ||
| * @since Dataverse 6.8 | ||
| */ | ||
| ENABLE_PID_FAILURE_LOG("enable-pid-failure-log"), | ||
|
|
||
|
|
||
| ; | ||
|
|
||
|
Member
There was a problem hiding this comment. I'm just adding this at the end... https://jenkins.dataverse.org/job/IQSS-Dataverse-Develop-PR/job/PR-11601/3/testReport/junit/edu.harvard.iq.dataverse.api/DataverseFeaturedItemsIT/testCreateFeaturedItemWithBadDvOdbjectIds/ is failing with a 500 error. Can you please merge the latest from develop and see if tests pass? |
||
|
|
||
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.
Uh oh!
There was an error while loading. Please reload this page.