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

Improve logging using structured logs #527

Open
MattMcL4475 opened this issue Oct 28, 2022 · 1 comment
Open

Improve logging using structured logs #527

MattMcL4475 opened this issue Oct 28, 2022 · 1 comment
Labels
tobegroomed Add this label while creating new issues to get issues prioritized on the backlog
Milestone

Comments

@MattMcL4475
Copy link
Contributor

Problem:
Logs contain log messages which don't uniformly refer to identifiers (like the TES task ID). This makes it difficult and/or impossible to trace the life cycle of a TES task through the system.

Solution:
Instead of:

string msg = $"TES task: {tesTask.Id} BatchTaskState: {combinedBatchTaskInfo.BatchTaskState}";
logger.LogInformation(msg);

Can do something like this:
logger.LogInformation("TES task: {tesTask.Id} BatchTaskState: {combinedBatchTaskInfo.BatchTaskState}", tesTask.Id, combinedBatchTaskInfo.BatchTaskState);

This issue is to comprehensively design a better way to improve logging so that it's easier to debug the lifecycle of a TES task and see any Batch issues that may be related to it, as well as easily query it in Application Insights traces. The solution should include clear examples of how to query in Application Insights traces.

@MattMcL4475 MattMcL4475 added this to the next milestone Oct 28, 2022
@ngambani
Copy link

ngambani commented Feb 1, 2024

@MattMcL4475 do we have any update on this one. Is this something we want to work on or has already been addressed?

@ngambani ngambani added the tobegroomed Add this label while creating new issues to get issues prioritized on the backlog label Feb 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tobegroomed Add this label while creating new issues to get issues prioritized on the backlog
Projects
None yet
Development

No branches or pull requests

2 participants