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

As a Dataverse installation administrator, I need clear indications of status of harvesting attempts so that I know which ones I need to troubleshoot #9294

Open
jggautier opened this issue Jan 17, 2023 · 7 comments · May be fixed by #11017

Comments

@jggautier
Copy link
Contributor

jggautier commented Jan 17, 2023

Overview of the Feature Request

What kind of user is the feature intended for?
Dataverse installation administrators, Sysadmins

What inspired the request?
Dataverse team discussion about the helpfulness of the text on the harvesting clients page that shows the status of Dataverse's harvesting attempts.

What existing behavior do you want changed?
On the harvesting clients page, improve the text that's used to let people who manage Dataverse installations know the status of harvesting runs.

Screen Shot 2023-01-17 at 10 58 14 AM

In the "Last Results" column, the results highlighted in orange show cases where Harvard Dataverse finished trying to harvest and wasn't able to harvest any new records. The text reads SUCCESS, but this might be misleading to people.

  • Is it really a success if Dataverse wasn't able to harvest the new dataset metadata records it found?
  • Does the "SUCCESS" text indicate that the harvesting attempt finished successfully? Is it possible to make this more clear?
    • During a brief team chat about this, we talked about using "Finished", "Completed" or “Completed with failures”, instead of "SUCCESS".

Any related open or closed issues to this feature request?
None that I could find

Any related threads on the mailing list?
Similar screenshot at https://groups.google.com/g/dataverse-community/c/5F7aH0cLios/m/kvjVOHUiJgAJ

@jggautier jggautier changed the title As a Dataverse installation administrator, I need to know the status of harvesting attempts so that I know which ones I need to troubleshoot As a Dataverse installation administrator, I need clear indications of status of harvesting attempts so that I know which ones I need to troubleshoot Jan 17, 2023
@DS-INRAE
Copy link
Member

We'll make a contribution to change the "SUCCESS" into "Completed with failures" when there are errors and take on this opportunity to make these labels translatable.
Is it already necessary to create a similar issue in SPA of is harvesting out of the current perimeter ?
As this also raises the question on how to give the administration more informations on the type of errors without having to access and analyse the logs it might be better to envision a rework of this page first rather than redoing the exact same for the SPA:) .

@DS-INRAE
Copy link
Member

DS-INRAE commented Apr 18, 2024

Our team started looking into it 😄
@jggautier we plan to use "Completed" when there are no failures, as we'll add internationalization it would be easy for an installation to change the label if needed, is that ok with you?

@DS-INRAE
Copy link
Member

I also wanted to point out this new zulip thread about notifications for harvesting failures : https://dataverse.zulipchat.com/#narrow/stream/375707-community/topic/Feature.20.3A.20Notify.20harvested.20repo.20admins.20of.20harvesting.20errors

@jggautier
Copy link
Contributor Author

Hi @DS-INRA. I'm not sure and would need more context. So is this what you're suggesting?:

  • When the installation didn't fail to harvest records, the Last Results column will read "Completed; # harvested, # deleted, 0 failed"
  • When the installation failed to harvest records, the Last Results column will read "SUCCESS; # harvested, # deleted, # failed"

Or do you plan to make other changes based on different conditions of a harvesting run?

Since I opened this GitHub issue, I've learned that "success" and "failure" here doesn't mean what I thought it meant. Some of that conversation in Zulip gets into this, right? For example, I didn't realize a year ago that even though the Last Results column says that records were harvested, those records may still not appear in the UI and be searchable.

If you haven't already, it might be helpful to reach out to managers of other installations that harvest to see what they think, too. I know Sherry Lake at UVA Dataverse does. Not sure who else. The folks who worked on harvesting issues described in an old closed GitHub issue at #8289 might have helpful perspectives.

@DS-INRAE
Copy link
Member

Hi sorry for the delay, I forgot about this comment 🤐

* When the installation didn't fail to harvest records, the Last Results column will read "Completed; # harvested, # deleted, 0 failed"

* When the installation failed to harvest records, the Last Results column will read "SUCCESS; # harvested, # deleted, # failed"

Or do you plan to make other changes based on different conditions of a harvesting run?

The plan was:

  • When the installation didn't fail to harvest records, the Last Results column will read "Completed; # harvested, # deleted, 0 failed"
  • When the installation failed to harvest records, the Last Results column will read "Completed with failures; # harvested, # deleted, # failed"

@jggautier @shlake Do you have other suggestions :) ?

@DS-INRAE
Copy link
Member

I also forgot to mention we plan to make these text translatable as part of the update of the messages

@jggautier
Copy link
Contributor Author

Thanks @DS-INRA. I have no other suggestions. I think it'll be good to have these clearer status indications.

@gwendoux gwendoux moved this to Interested in Cirad Dataverse Jul 10, 2024
@DS-INRAE DS-INRAE moved this to 🚧 Dev by Recherche Data Gouv in Recherche Data Gouv Jul 10, 2024
@DS-INRAE DS-INRAE moved this from 🚧 Dev by Recherche Data Gouv to 🕒 Planned Development in Recherche Data Gouv Jul 11, 2024
@DS-INRAE DS-INRAE moved this from 🕒 Planned Development to 🚧 Dev by Recherche Data Gouv in Recherche Data Gouv Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Interested
Status: 🚧 Dev by Recherche Data Gouv
Development

Successfully merging a pull request may close this issue.

2 participants