You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/collections/explanation/reporting.md
+7-11Lines changed: 7 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,28 +5,24 @@ weight: 1
5
5
6
6
# Reporting
7
7
8
-
Once services are declared in a collection and this collection starts tracking these terms, it becomes crucial to monitor whether the tracking is functioning properly. It is important to know if there are any terms whose tracking has been interrupted or has failed.
8
+
Over the lifetime of a collection, services will change the location, layout or distribution of their terms. This can impact tracking. In order to ensure continuous data collection, maintainers need to know if the tracking of any terms fails. To address this need, the Open Terms Archive engine automatically reports failures by opening issues in the declarations repository.
9
9
10
10
## How the reporting system works
11
11
12
-
To address this need, the Open Terms Archive engine implements an automated reporting system that creates issues in the declarations repository. This system helps maintainers stay informed about which terms are not being tracked and why.
13
-
14
-
When tracking is interrupted for a specific term, the system opens an issue that explains why the term is not being tracked and associates labels to categorize the cause of the tracking interruption. The system automatically closes issues when tracking resumes after declarations are fixed and deployed.
12
+
When some terms fail to track, an issue is opened that explains the reason for failure and is labelled based on the cause of the tracking interruption. The system also automatically closes issues when tracking resumes.
15
13
16
14
## Understanding labels
17
15
18
-
The reporting system uses labels to categorize issues and indicate what action is needed.
19
-
20
-
### Auto-managed labels
16
+
The reporting system uses labels to categorize issues and indicate what action, if any, is needed to resume tracking.
21
17
22
-
All labels that are marked with `- Auto-managed by OTA engine` visible in their description on hover are automatically managed by the engine.
18
+
### Automatically managed labels
23
19
24
-
**These labels should not be manually added to issues, modified or removed from them, nor should their descriptions or colors be edited by maintainers.**
20
+
Labels that are automatically managed by the engine say so in their description, which is visible by hovering the mouse cursor over the label name.
25
21
26
-
The engine will automatically manage these labels as needed.
22
+
**These labels should not be manually added to issues, modified or removed from them, nor should their descriptions or colors be edited by maintainers.** Otherwise, duplication of labels can appear. The engine will automatically manage these labels as needed, ensuring that the cause for interruption is as precisely identified as possible.
27
23
28
24
### Issues requiring intervention
29
25
30
26
The label `⚠ needs intervention` indicates that manual contributor intervention is required to restore tracking. When this label appears on an issue, it means the problem won't be resolved automatically and requires human action to fix the declarations or configuration.
31
27
32
-
Issues without this label represent tracking interruptions that need investigation to determine the appropriate course of action. These issues may resolve themselves automatically once the underlying problem (such as a temporary network outage or service downtime) is fixed. However, some may not be fixable at all, for example when the tracking engine is detected and blocked as a bot by the target service.
28
+
Issues without this label may resolve themselves automatically once the underlying problem, such as a temporary network outage or service downtime, is fixed. However, some may not be fixable at all, for example when the tracking engine is detected and blocked as a bot by the target service.
0 commit comments