KEMBAR78
Improve Agent logging by yczhang-nv · Pull Request #136 · NVIDIA/NeMo-Agent-Toolkit · GitHub
Skip to content

Conversation

@yczhang-nv
Copy link
Contributor

@yczhang-nv yczhang-nv commented Apr 18, 2025

Description

Improved agent logging for consistency, readability, and information.

  • Re-formatted the logging information of the agents (and added some colorized font to enhance readability)
  • Switched some logging from info to debug level
  • Removed some duplicated logging
  • Updated console output examples in README

The original logging:
Screenshot 2025-04-23 at 20 41 02

The updated logging:
Screenshot 2025-04-23 at 20 40 26

Closes AIQ-933

By Submitting this PR I confirm:

  • I am familiar with the Contributing Guidelines.
  • We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
    • Any contribution which contains commits that are not Signed-Off will not be accepted.
  • When the PR is ready for review, new or existing tests cover these changes.
  • When the PR is ready for review, the documentation is up to date with these changes.

@yczhang-nv yczhang-nv added enhancement non-breaking Non-breaking change labels Apr 18, 2025
@yczhang-nv yczhang-nv self-assigned this Apr 18, 2025
@yczhang-nv yczhang-nv requested a review from a team as a code owner April 18, 2025 23:20
@copy-pr-bot
Copy link

copy-pr-bot bot commented Apr 18, 2025

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@yczhang-nv yczhang-nv added improvement Improvement to existing functionality and removed enhancement labels Apr 21, 2025
AnuradhaKaruppiah and others added 23 commits April 21, 2025 11:02
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
This reverts commit 4dbf9ed.

Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
* Use a separate README for pypi

Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>

* Move pypi.md to ci

Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>

* Moved pypi.md to internal metadata

Notes for the future
1. README gets copied agentiq-*.dist-info/METADATA. So need to be a
   complete path within src.
2. The README doesn't need to be include as a data file

Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>

* Check GPG verification

Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>

---------

Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
* Document the need to isntall from source to run examples

Signed-off-by: David Gardner <dagardner@nvidia.com>

* Replace pip with install from source

Signed-off-by: David Gardner <dagardner@nvidia.com>

* Drop redundant heading

Signed-off-by: David Gardner <dagardner@nvidia.com>

* Move heading

Signed-off-by: David Gardner <dagardner@nvidia.com>

* De-emphesise installing from pip

Signed-off-by: David Gardner <dagardner@nvidia.com>

* Remove direct references to 'pip install'

Signed-off-by: David Gardner <dagardner@nvidia.com>

* Replace pip section with documentation on how to declare a dependency on AgentIQ

Signed-off-by: David Gardner <dagardner@nvidia.com>

* Spelling fixes

Signed-off-by: David Gardner <dagardner@nvidia.com>

* fix code block

Signed-off-by: David Gardner <dagardner@nvidia.com>

* Link to the install guide in each example's readme

Signed-off-by: David Gardner <dagardner@nvidia.com>

* Always link to instructions on obtaining an NVIDIA API key in examples which require it

Signed-off-by: David Gardner <dagardner@nvidia.com>

---------

Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
* Fix broken links

Signed-off-by: David Gardner <dagardner@nvidia.com>

* Fix broken link

Signed-off-by: David Gardner <dagardner@nvidia.com>

* Add link checking to documentation build

Signed-off-by: David Gardner <dagardner@nvidia.com>

---------

Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
* Updating readme.md and fixing links

Signed-off-by: Michael Demoret <mdemoret@nvidia.com>

* Removing Getting Started Section from Pypi Readme

Signed-off-by: Michael Demoret <mdemoret@nvidia.com>

---------

Signed-off-by: Michael Demoret <mdemoret@nvidia.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
* Add images for each key feature

Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>

* Add an image for observability

Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>

* Fixup some typos

Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>

* Some more cleanup

Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>

* Add some clarification to the observability image

Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>

* Fix a rogue char

Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>

* Place the image before the text

Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>

---------

Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
Co-authored-by: David Gardner <96306125+dagardner-nv@users.noreply.github.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
Fixed quotes

Signed-off-by: gzitzlsb-nv <gzitzlsberge@nvidia.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
Signed-off-by: atalhens <sneh.lata@nutanix.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
…ut of range when given subtraction (NVIDIA#31)

* Fix NVIDIA#27 (NVIDIA#28)

Signed-off-by: atalhens <sneh.lata@nutanix.com>

* Fix NVIDIA#29

Signed-off-by: atalhens <sneh.lata@nutanix.com>

* Revert "Fix NVIDIA#29"

This reverts commit 80e02dc.

Signed-off-by: atalhens <sneh.lata@nutanix.com>

* Fix NVIDIA#29 Update config

Signed-off-by: atalhens <sneh.lata@nutanix.com>

* Fix NVIDIA#29

Signed-off-by: atalhens <sneh.lata@nutanix.com>

---------

Signed-off-by: atalhens <sneh.lata@nutanix.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
* Fix NVIDIA#32 Add a check to ensure empty input is not passed

Signed-off-by: atalhens <sneh.lata@nutanix.com>

* Add str constant for output message

Signed-off-by: atalhens <sneh.lata@nutanix.com>

* Add unit test

Signed-off-by: atalhens <sneh.lata@nutanix.com>

---------

Signed-off-by: atalhens <sneh.lata@nutanix.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
Signed-off-by: Andrey Voroshilov <avoroshilov@nvidia.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
* First pass at adding issue templates, and rapids bots

Signed-off-by: David Gardner <dagardner@nvidia.com>

* Fix team name

Signed-off-by: David Gardner <dagardner@nvidia.com>

* Fix team name

Signed-off-by: David Gardner <dagardner@nvidia.com>

* First pass at a minimal CI for a PR

Signed-off-by: David Gardner <dagardner@nvidia.com>

* add ops-bots.yaml

Signed-off-by: Christopher Harris <xixonia@gmail.com>

* rename ops-bot.yaml -> ops-bots.yaml

Signed-off-by: Christopher Harris <xixonia@gmail.com>

* rename ops-bots.yaml -> ops-bot.yaml

Signed-off-by: Christopher Harris <xixonia@gmail.com>

---------

Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: Christopher Harris <xixonia@gmail.com>
Co-authored-by: Christopher Harris <xixonia@gmail.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
dagardner-nv and others added 8 commits April 21, 2025 11:02
Intended usage:
```bash
cat ci/release/pr_code_freeze_template.md | envsubst | \
    gh pr create --base main --head ${SOURCE_BRANCH} \
    --title "[RELEASE] ${REPO_NAME} v${RELEASE_VERSION}" \
    --body-file - \
    --label "! - Release" \
    --web
```

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AgentIQ/blob/develop/docs/source/advanced/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - David Gardner (https://github.com/dagardner-nv)

Approvers:
  - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah)

URL: NVIDIA#123
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
…e cluster (NVIDIA#109)

Sample Usage:
1. Start the workflow service on any cluster via `aiq serve`-
```
aiq serve --config_file=examples/simple/configs/config.yml
```
2. Send evaluation request to it using a separate (or same) eval_config file -
That will return immediately with a job id. The job is run as a background task
```
curl --request POST   --url http://localhost:8000/evaluate   --header 'Content-Type: application/json'   --data '{
    "config_file": "examples/simple/configs/eval_config.yml"
}'
{"job_id":"551d181a-3e3c-4a1c-95b4-a4dde2f8aa3d","status":"submitted"}
```
3. You can then query the status by using the job-id or my asking for the status of the last (created) job -
```
curl --request GET --url http://localhost:8000/evaluate/job/last |jq
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   242  100   242    0     0    204      0  0:00:01  0:00:01 --:--:--   204
{
  "job_id": "551d181a-3e3c-4a1c-95b4-a4dde2f8aa3d",
  "status": "running",
  "config_file": "examples/simple/configs/eval_config.yml",
  "error": null,
  "output_path": "None",
  "created_at": "2025-04-10T03:56:43.931778",
  "updated_at": "2025-04-10T03:56:43.933886"
}
```
```
curl --request GET --url http://localhost:8000/evaluate/job/551d181a-3e3c-4a1c-95b4-a4dde2f8aa3d |jq
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   283  100   283    0     0     74      0  0:00:03  0:00:03 --:--:--    74
{
  "job_id": "551d181a-3e3c-4a1c-95b4-a4dde2f8aa3d",
  "status": "success",
  "config_file": "examples/simple/configs/eval_config.yml",
  "error": null,
  "output_path": ".tmp/aiq/examples/simple/workflow_output.json",
  "created_at": "2025-04-10T03:56:43.931778",
  "updated_at": "2025-04-10T03:57:11.722188"
}
```
4. You can get a complete list of jobs by running -
```
curl --request GET --url http://localhost:8000/evaluate/jobs | jq
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   569  100   569    0     0  47535      0 --:--:-- --:--:-- --:--:-- 56900
[
  {
    "job_id": "a62086d3-3373-485f-95b1-80e0477fac6b",
    "status": "success",
    "config_file": "examples/simple/configs/eval_config.yml",
    "error": null,
    "output_path": ".tmp/aiq/examples/simple/workflow_output.json",
    "created_at": "2025-04-10T04:43:29.741201",
    "updated_at": "2025-04-10T04:43:58.451151"
  },
  {
    "job_id": "a5a11719-cd8d-468d-b1c2-9855ab2e9927",
    "status": "success",
    "config_file": "examples/simple/configs/eval_config.yml",
    "error": null,
    "output_path": ".tmp/aiq/examples/simple/workflow_output.json",
    "created_at": "2025-04-10T04:43:35.432887",
    "updated_at": "2025-04-10T04:44:04.429978"
  }
]
```
This endpoint allows you to filter by status -
```
curl http://localGET --url http://localhost:8000/evaluate/jobs?status=running |jq
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   244  100   244    0     0   3870      0 --:--:-- --:--:-- --:--:--  3935
[
  {
    "job_id": "1cff39fe-bedb-4089-9034-50377abc8f6b",
    "status": "running",
    "config_file": "examples/simple/configs/eval_config.yml",
    "error": null,
    "output_path": "None",
    "created_at": "2025-04-10T04:45:06.708431",
    "updated_at": "2025-04-10T04:45:06.710928"
  }
]
```

Closes: NVIDIA#100

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AgentIQ/blob/develop/docs/source/advanced/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah)

Approvers:
  - Eric Evans II (https://github.com/ericevans-nv)
  - David Gardner (https://github.com/dagardner-nv)

URL: NVIDIA#109
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
Closes

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AgentIQ/blob/develop/docs/source/advanced/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah)

Approvers:
  - Eric Evans II (https://github.com/ericevans-nv)

URL: NVIDIA#126
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
Feature: Function Tracking Decorator

This PR adds a straightforward decorator, `@track_function`, that makes it easy to log details about function calls. It works on synchronous and asynchronous functions, generators (sync and async), and class methods—all with a consistent interface.

Key Points:
- Versatile Support: Works with regular functions, async functions, generators, and even class methods.
- Optional Metadata: You can add extra context by passing a dictionary to the decorator. Metadata keys are validated to ensure they’re strings.
- Data Serialization: Automatically serializes input arguments and outputs (or each yield) into a JSON-friendly format. It even handles Pydantic models by calling model_dump() if needed.
- Intermediate Event Logging: The decorator sends tracking events to a reactive stream in three stages:
-- SPAN_START: When the function starts.
-- SPAN_CHUNK: For each yielded item (for generators).
-- SPAN_END: When the function returns (or ends in generators).

Usage Example:

```python
from aiq.profiler.decorators.function_tracking import track_function

@track_function(metadata={"action": "compute", "source": "api"})
def add_numbers(a, b):
    return a + b
```
Just apply `@track_function` to any function (or method) where you need a bit of extra insight into the inputs and outputs. Subscribe to the reactive stream to see the published events and get a better sense of the function’s flow.

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AgentIQ/blob/develop/docs/source/advanced/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - Dhruv Nandakumar (https://github.com/dnandakumar-nv)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)

URL: NVIDIA#98
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
Fix a typo in `aiq.profiler.decorators`

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AgentIQ/blob/develop/docs/source/advanced/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - Dhruv Nandakumar (https://github.com/dnandakumar-nv)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)
  - Will Killian (https://github.com/willkill07)

URL: NVIDIA#132
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
Closes NVIDIA#77

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AgentIQ/blob/develop/docs/source/advanced/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - David Gardner (https://github.com/dagardner-nv)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)

URL: NVIDIA#82
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
* Document using locally hosted models using NIMs and using vLLM
* Adds an OpenAI LangChain embedding client (required for the vLLM).

Closes NVIDIA#34
Closes NVIDIA#37

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AgentIQ/blob/develop/docs/source/advanced/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - David Gardner (https://github.com/dagardner-nv)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)

URL: NVIDIA#101
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
@yczhang-nv yczhang-nv force-pushed the yuchen-improve-logging branch from 14d60c4 to 2cfdbd3 Compare April 21, 2025 18:02
yczhang-nv and others added 6 commits April 21, 2025 11:06
…ogging

Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
…ogging

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
@yczhang-nv
Copy link
Contributor Author

/merge

@rapids-bot rapids-bot bot merged commit eb832e3 into NVIDIA:develop Apr 24, 2025
10 checks passed
@yczhang-nv yczhang-nv deleted the yuchen-improve-logging branch April 24, 2025 04:16
yczhang-nv added a commit to yczhang-nv/NeMo-Agent-Toolkit that referenced this pull request May 8, 2025
Improved agent logging for consistency, readability, and information.

- Re-formatted the logging information of the agents (and added some colorized font to enhance readability)
- Switched some logging from `info` to `debug` level
- Removed some duplicated logging
- Updated console output examples in `README`

The original logging:
<img width="1032" alt="Screenshot 2025-04-23 at 20 41 02" src="https://github.com/user-attachments/assets/f98b58fe-35f4-4246-994d-70ce7e784246" />

The updated logging:
<img width="804" alt="Screenshot 2025-04-23 at 20 40 26" src="https://github.com/user-attachments/assets/9711f0cb-04c6-4ac8-9f80-c6a839e1a5bb" />

Closes  [AIQ-933](https://jirasw.nvidia.com/browse/AIQ-933?filter=-1)

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AgentIQ/blob/develop/docs/source/advanced/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - Yuchen Zhang (https://github.com/yczhang-nv)
  - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah)
  - David Gardner (https://github.com/dagardner-nv)
  - Michael Demoret (https://github.com/mdemoret-nv)
  - https://github.com/gzitzlsb-nv
  - Snehlata (https://github.com/atalhens)
  - Andrey Voroshilov (https://github.com/avoroshilov)
  - Bruno Alvisio (https://github.com/balvisio)
  - Eric Evans II (https://github.com/ericevans-nv)
  - Dhruv Nandakumar (https://github.com/dnandakumar-nv)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)

URL: NVIDIA#136
Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>
AnuradhaKaruppiah pushed a commit to AnuradhaKaruppiah/oss-agentiq that referenced this pull request Aug 4, 2025
Improved agent logging for consistency, readability, and information.

- Re-formatted the logging information of the agents (and added some colorized font to enhance readability)
- Switched some logging from `info` to `debug` level
- Removed some duplicated logging
- Updated console output examples in `README`

The original logging:
<img width="1032" alt="Screenshot 2025-04-23 at 20 41 02" src="https://github.com/user-attachments/assets/f98b58fe-35f4-4246-994d-70ce7e784246" />

The updated logging:
<img width="804" alt="Screenshot 2025-04-23 at 20 40 26" src="https://github.com/user-attachments/assets/9711f0cb-04c6-4ac8-9f80-c6a839e1a5bb" />



Closes  [AIQ-933](https://jirasw.nvidia.com/browse/AIQ-933?filter=-1)

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AgentIQ/blob/develop/docs/source/advanced/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - Yuchen Zhang (https://github.com/yczhang-nv)
  - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah)
  - David Gardner (https://github.com/dagardner-nv)
  - Michael Demoret (https://github.com/mdemoret-nv)
  - https://github.com/gzitzlsb-nv
  - Snehlata (https://github.com/atalhens)
  - Andrey Voroshilov (https://github.com/avoroshilov)
  - Bruno Alvisio (https://github.com/balvisio)
  - Eric Evans II (https://github.com/ericevans-nv)
  - Dhruv Nandakumar (https://github.com/dnandakumar-nv)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)

URL: NVIDIA#136
scheckerNV pushed a commit to scheckerNV/aiq-factory-reset that referenced this pull request Aug 22, 2025
Improved agent logging for consistency, readability, and information.

- Re-formatted the logging information of the agents (and added some colorized font to enhance readability)
- Switched some logging from `info` to `debug` level
- Removed some duplicated logging
- Updated console output examples in `README`

The original logging:
<img width="1032" alt="Screenshot 2025-04-23 at 20 41 02" src="https://github.com/user-attachments/assets/f98b58fe-35f4-4246-994d-70ce7e784246" />

The updated logging:
<img width="804" alt="Screenshot 2025-04-23 at 20 40 26" src="https://github.com/user-attachments/assets/9711f0cb-04c6-4ac8-9f80-c6a839e1a5bb" />



Closes  [AIQ-933](https://jirasw.nvidia.com/browse/AIQ-933?filter=-1)

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AgentIQ/blob/develop/docs/source/advanced/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - Yuchen Zhang (https://github.com/yczhang-nv)
  - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah)
  - David Gardner (https://github.com/dagardner-nv)
  - Michael Demoret (https://github.com/mdemoret-nv)
  - https://github.com/gzitzlsb-nv
  - Snehlata (https://github.com/atalhens)
  - Andrey Voroshilov (https://github.com/avoroshilov)
  - Bruno Alvisio (https://github.com/balvisio)
  - Eric Evans II (https://github.com/ericevans-nv)
  - Dhruv Nandakumar (https://github.com/dnandakumar-nv)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)

URL: NVIDIA#136
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

improvement Improvement to existing functionality non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants