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.

Sign up for GitHub

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

feat: add job manager conventions #68

Closed
wants to merge 3 commits into from
Closed

feat: add job manager conventions #68

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d737994
feat: add job manager conventions
razbroc Jun 20, 2024
70caecb
chroe: pr - status description
razbroc Jun 23, 2024
aa92f07
chroe: pr - status description
razbroc Jun 23, 2024
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
12 changes: 11 additions & 1 deletion src/semanticConventions/infra.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"jobId": {
"propertyName": "mapcolonies.infra.job_management.job_id",
"deprecated": false,
"description": "Type of task as stored on db (uuid)"
"description": "Type of job as stored on db (uuid)"
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not a type but an ID. Please change description accordingly.
This comment is relevant for taskId, jobType, and taskType's desriptions as well.

Copy link
Collaborator

Choose a reason for hiding this comment

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

descriptions*

},
"taskId": {
"propertyName": "mapcolonies.infra.job_management.task_id",
Expand All @@ -37,6 +37,16 @@
"propertyName": "mapcolonies.infra.job_management.service_url",
"deprecated": false,
"description": "API url of job management service"
},
"taskIds": {
"propertyName": "mapcolonies.infra.job_management.task_ids",
"deprecated": false,
"description": "Array of tasks (uuid array)"
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"description": "Array of tasks (uuid array)"
"description": "Array of task ids (uuid array)"

},
"status": {
Copy link

Choose a reason for hiding this comment

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

do you think jobStatus is better?

Copy link
Author

@razbroc razbroc Jun 23, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Hmmmm, I believe it might be better to be just "status" since it appears as "status" in DB, and can be used for tasks and jobs.
Should I note it in the description?

Copy link
Collaborator

Choose a reason for hiding this comment

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

even if its like this in the DB, it might be confusing with other statuses across mapcolonies

"propertyName": "mapcolonies.infra.job_management.status",
"deprecated": false,
"description": "Status of job/task as stored on db (COMPLETED/ IN-PROGRESS/ PENDING, etc.)"
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"description": "Status of job/task as stored on db (COMPLETED/ IN-PROGRESS/ PENDING, etc.)"
"description": "Status of job/task as stored on db (COMPLETED, IN-PROGRESS, PENDING, etc.)"

}
}
}
Expand Down
Loading