Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions content/collections/explanation/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Explanations
weight: 4
---
34 changes: 34 additions & 0 deletions content/collections/explanation/reporting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Reporting
weight: 1
---

# Reporting

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.

## How the reporting system works

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.

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.

## Understanding labels

The reporting system uses labels to categorize issues and indicate what action is needed.

### Auto-managed labels

All labels that are marked with `- Auto-managed by OTA engine` in their description are managed by the engine. These labels should:

- **Not** be manually added to issues by maintainers
- **Not** be modified or removed from issues by maintainers
- **Not** have their descriptions or colors edited by maintainers

The engine will automatically manage these labels as needed.
Comment on lines +22 to +28
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
All labels that are marked with `- Auto-managed by OTA engine` in their description are managed by the engine. These labels should:
- **Not** be manually added to issues by maintainers
- **Not** be modified or removed from issues by maintainers
- **Not** have their descriptions or colors edited by maintainers
The engine will automatically manage these labels as needed.
All labels that are marked with `- Auto-managed by OTA engine` visible in their description on hover are automatically managed by the engine.
**These labels should not be manually added to issues, modified or removed from them, nor should their descriptions or colors be edited by maintainers.**


### Issues requiring intervention

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.

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.