Logging tool calls and results in Agentic AI - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the main purpose of logging tool calls and results?

Logging tool calls and results helps track what actions were performed and their outcomes. This makes it easier to find problems and understand system behavior.

beginner

Name two common pieces of information recorded in logs for tool calls.

1. The command or tool name called.
2. The result or output of the call, including success or error messages.

intermediate

Why should logs be easy to read and well-structured?

Clear and structured logs help quickly find important details without confusion. This saves time when fixing issues or reviewing system actions.

beginner

What is a simple way to log a tool call and its result in a script?

You can print or write the command and its output to a file with a timestamp. For example:
echo "$(date) Running tool X" >> log.txt
toolX >> log.txt 2>&1

intermediate

How can logging tool calls improve teamwork in DevOps?

Logs provide a shared record of what happened and when. Team members can understand each other's work, spot errors, and improve processes together.

What is the first step when logging a tool call?

A Ignore the output

B Record the tool name or command being run

C Delete old logs

D Restart the system

The first step is to record which tool or command is being called so you know what action was taken.

Which of these is NOT typically logged for tool calls?

A User's favorite color

B Timestamp

C Error messages

D Command output

User's favorite color is unrelated and not useful for logging tool calls.

Why include timestamps in logs?

A To make logs colorful

B To slow down the system

C To confuse readers

D To know when each action happened

Timestamps help track the timing of events, which is important for troubleshooting and understanding sequences.

What is a benefit of logging tool results?

A Helps identify if a tool succeeded or failed

B Makes the system slower

C Hides errors from users

D Removes the need for backups

Logging results shows if the tool worked correctly or if there were errors to fix.

Which practice improves log usefulness?

A Logging only once a month

B Using random symbols

C Writing clear, structured messages

D Ignoring errors

Clear and structured logs make it easier to read and understand what happened.

Explain why logging tool calls and results is important in DevOps.

Think about how logs help when something goes wrong or when sharing work with others.

Describe a simple method to log a tool call and its result in a script.

Consider how you would keep a note of what you did and what happened.

Practice

1. What is the main purpose of logging tool calls and results in DevOps?

easy

A. To make the tools run faster

B. To hide errors from users

C. To track what tools do and their outputs for debugging and monitoring

D. To reduce the size of log files

Solution

1. Step 1: Understand the role of logging

   Logging records actions and results of tools to help understand their behavior.

2. Step 2: Identify the benefits of logging

   Logging helps with debugging, monitoring, and auditing by showing what happened and when.

3. Final Answer:

   To track what tools do and their outputs for debugging and monitoring -> Option C

4. Quick Check:

   Logging = Track tool actions and outputs [OK]

Hint: Logging means recording tool actions and outputs clearly [OK]

Common Mistakes:

• Thinking logging speeds up tools
• Believing logging hides errors
• Assuming logging reduces log file size

2. Which of the following is the correct way to log a tool call and its result in a simple Python function?

easy

A. def log_call(tool_name, result): print(f"Tool {tool_name} result")

B. def log_call(tool_name, result): return f"Tool {tool_name} returned {result}"

C. def log_call(tool_name, result): print("Tool tool_name returned result")

D. def log_call(tool_name, result): print(f"Tool {tool_name} returned {result}")

Solution

1. Step 1: Check string formatting with variables

   def log_call(tool_name, result): print(f"Tool {tool_name} returned {result}") uses f-string correctly to insert variables tool_name and result.

2. Step 2: Verify output method

   def log_call(tool_name, result): print(f"Tool {tool_name} returned {result}") prints the message, which is typical for logging in simple scripts.

3. Final Answer:

   def log_call(tool_name, result): print(f"Tool {tool_name} returned {result}") -> Option D

4. Quick Check:

   Correct f-string and print used [OK]

Hint: Use f-strings and print() to log calls and results [OK]

Common Mistakes:

• Not using f-string for variable insertion
• Printing literal variable names instead of values
• Returning string instead of printing

3. Given the code below, what will be the output?

def log_call(tool, result):
    print(f"Calling {tool}...")
    print(f"Result: {result}")

log_call('BackupTool', 'Success')

medium

A. Calling BackupTool... Result: Success

B. Calling BackupTool...\nResult: Success

C. Calling tool...\nResult: result

D. Error: Missing parentheses in print

Solution

1. Step 1: Analyze the function calls

   The function prints two lines: one with tool name, one with result.

2. Step 2: Substitute arguments and check output

   Calling 'BackupTool' and 'Success' prints exactly two lines with those values.

3. Final Answer:

   Calling BackupTool...\nResult: Success -> Option B

4. Quick Check:

   Print lines match arguments [OK]

Hint: Read print lines carefully and substitute variables [OK]

Common Mistakes:

• Confusing variable names with strings
• Expecting output on one line
• Thinking print syntax is wrong

4. What is wrong with this logging function?

def log_call(tool, result):
    print("Calling tool...")
    print("Result: result")

medium

A. It prints the variable names instead of their values

B. It uses print instead of return

C. It has a syntax error in print statements

D. It logs too much information

Solution

1. Step 1: Check how variables are used in print

   The function prints literal strings "tool" and "result" instead of variable values.

2. Step 2: Understand correct variable usage

   To print values, variables must be inside f-strings or concatenated properly.

3. Final Answer:

   It prints the variable names instead of their values -> Option A

4. Quick Check:

   Variables not interpolated in strings [OK]

Hint: Use f-strings to print variable values, not names [OK]

Common Mistakes:

• Forgetting f before string
• Using quotes around variable names
• Thinking print must be replaced by return

5. You want to log multiple tool calls and their results in a list, showing each call and result clearly. Which code snippet correctly logs all calls from the list calls = [('ToolA', 'OK'), ('ToolB', 'Fail'), ('ToolC', 'OK')]?

hard

A. for tool, result in calls:
print(f"Tool {tool} returned {result}")

B. for call in calls:
print(f"Tool call[0] returned call[1]")

C. for tool, result in calls:
print("Tool tool returned result")

D. for tool, result in calls:
print(f"Tool {tool} result")

Solution

1. Step 1: Understand tuple unpacking in loop

   for tool, result in calls: print(f"Tool {tool} returned {result}") correctly unpacks each tuple into tool and result variables.

2. Step 2: Check correct f-string usage

   for tool, result in calls: print(f"Tool {tool} returned {result}") uses f-string to insert variables properly in the print statement.

3. Final Answer:

   for tool, result in calls: print(f"Tool {tool} returned {result}") -> Option A

4. Quick Check:

   Tuple unpacking and f-string correct [OK]

Hint: Unpack tuples and use f-strings to log each call [OK]

Common Mistakes:

• Not unpacking tuples correctly
• Printing variable names as strings
• Missing f-string for variable insertion