87. Logs and failure investigation
Module 18 · 20 minutes · Lesson 86; earlier service and JavaScript fundamentals
Open Interactive LessonDiscover
How can you use logs and failure investigation without changing the wrong data?
- Explain logs and failure investigation in your own words
- Trace the actual console result from the source
- Repair the supplied failing operation and verify the result
Predict
Which values or resources will change, and which should stay unchanged? Write your prediction before execution.
Understand
Useful logs explain stage and record identity without leaking sensitive content. When a script fails after a partial write, inspect the resulting state rather than assuming rollback. A service timeline shows actual calls in order; it is not a full paused debugger. Start with the first meaningful error and reproduce it using small fictional data.
Example 1: Working automation
Stage logs localize the failure before counting. A missing tab is reported with context.
function main() {
console.log("Stage: locate sheet");
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Sales");
if (!sheet) throw new Error("Sales missing at locate stage");
console.log("Stage: count records");
console.log(sheet.getLastRow() - 1);
}Important line explanations
- Line 1: function main() {
- Define a named block of instructions. Run Script calls main; helpers run only when called.
- Line 2: console.log("Stage: locate sheet");
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 3: const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Sales");
- Resolve the current workbook. A real standalone project needs openById with a configured ID instead.
- Line 4: if (!sheet) throw new Error("Sales missing at locate stage");
- Reject the current operation with an explicit error instead of silently continuing on invalid assumptions.
- Line 5: console.log("Stage: count records");
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 6: console.log(sheet.getLastRow() - 1);
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 7: }
- Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
"logs": [
"Stage: locate sheet",
"Stage: count records",
"3"
],
"error": null,
"resource": "logs",
"value": null
}Example 2: Investigate a reproducible failure
Predict the effect of getSheetByName("Missing") and identify the first mismatch. This example is intentionally faulty.
function main() {
console.log("Stage: locate sheet");
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Missing");
if (!sheet) throw new Error("Sales missing at locate stage");
console.log("Stage: count records");
console.log(sheet.getLastRow() - 1);
}Important line explanations
- Line 1: function main() {
- Define a named block of instructions. Run Script calls main; helpers run only when called.
- Line 2: console.log("Stage: locate sheet");
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 3: const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Missing");
- Resolve the current workbook. A real standalone project needs openById with a configured ID instead.
- Line 4: if (!sheet) throw new Error("Sales missing at locate stage");
- Reject the current operation with an explicit error instead of silently continuing on invalid assumptions.
- Line 5: console.log("Stage: count records");
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 6: console.log(sheet.getLastRow() - 1);
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 7: }
- Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
"logs": [
"Stage: locate sheet"
],
"error": "Sales missing at locate stage",
"resource": "logs",
"value": null
}Example 3: Separate setup from execution and inspect repeat behavior
Call the same named operation twice. Compare outputs and resource counts to learn whether this operation is idempotent. Repeated creation is deliberately visible; real exports require a rerun policy.
function lessonAction() {
console.log("Stage: locate sheet");
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Sales");
if (!sheet) throw new Error("Sales missing at locate stage");
console.log("Stage: count records");
console.log(sheet.getLastRow() - 1);
}
function main() {
lessonAction();
lessonAction();
}Important line explanations
- Line 1: function lessonAction() {
- Define a named block of instructions. Run Script calls main; helpers run only when called.
- Line 2: console.log("Stage: locate sheet");
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 3: const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Sales");
- Resolve the current workbook. A real standalone project needs openById with a configured ID instead.
- Line 4: if (!sheet) throw new Error("Sales missing at locate stage");
- Reject the current operation with an explicit error instead of silently continuing on invalid assumptions.
- Line 5: console.log("Stage: count records");
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 6: console.log(sheet.getLastRow() - 1);
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 7: }
- Close the current block. Indentation makes scope and the function boundary visible.
- Line 8: function main() {
- Define a named block of instructions. Run Script calls main; helpers run only when called.
- Line 9: lessonAction();
- Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
- Line 10: lessonAction();
- Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
- Line 11: }
- Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
"logs": [
"Stage: locate sheet",
"Stage: count records",
"3",
"Stage: locate sheet",
"Stage: count records",
"3"
],
"error": null,
"resource": "logs",
"value": null
}Example 4: Add a diagnostic boundary around the operation
Observe start, successful completion or a rethrown failure. This optional professional pattern adds error context without swallowing the error or rolling back changes.
function lessonAction() {
console.log("Stage: locate sheet");
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Sales");
if (!sheet) throw new Error("Sales missing at locate stage");
console.log("Stage: count records");
console.log(sheet.getLastRow() - 1);
}
function main() {
console.log("Start: Logs and failure investigation");
try { lessonAction(); console.log("Completed operation"); }
catch(error) { console.error("Failed operation: " + error.message); throw error; }
}Important line explanations
- Line 1: function lessonAction() {
- Define a named block of instructions. Run Script calls main; helpers run only when called.
- Line 2: console.log("Stage: locate sheet");
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 3: const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Sales");
- Resolve the current workbook. A real standalone project needs openById with a configured ID instead.
- Line 4: if (!sheet) throw new Error("Sales missing at locate stage");
- Reject the current operation with an explicit error instead of silently continuing on invalid assumptions.
- Line 5: console.log("Stage: count records");
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 6: console.log(sheet.getLastRow() - 1);
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 7: }
- Close the current block. Indentation makes scope and the function boundary visible.
- Line 8: function main() {
- Define a named block of instructions. Run Script calls main; helpers run only when called.
- Line 9: console.log("Start: Logs and failure investigation");
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 10: try { lessonAction(); console.log("Completed operation"); }
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 11: catch(error) { console.error("Failed operation: " + error.message); throw error; }
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 12: }
- Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
"logs": [
"Start: Logs and failure investigation",
"Stage: locate sheet",
"Stage: count records",
"3",
"Completed operation"
],
"error": null,
"resource": "logs",
"value": null
}Build and test
Repair the supplied script so that: Stage logs localize the failure before counting. A missing tab is reported with context. Preserve other source data. Checks compare observable output and the named resource, not exact source text.
function main() {
console.log("Stage: locate sheet");
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Missing");
if (!sheet) throw new Error("Sales missing at locate stage");
console.log("Stage: count records");
console.log(sheet.getLastRow() - 1);
}Graduated hints
Hint 1
Inspect the operation containing getSheetByName("Missing"). Compare it with the stated rule and the first mismatch.
Hint 2
The repair concerns getSheetByName("Sales"). Change only the relevant argument, operator or method; rerun with fresh input.
Hint 3
The reference uses getSheetByName("Sales") where the broken source uses getSheetByName("Missing"). Explain why before applying it.
Reference solution
function main() {
console.log("Stage: locate sheet");
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Sales");
if (!sheet) throw new Error("Sales missing at locate stage");
console.log("Stage: count records");
console.log(sheet.getLastRow() - 1);
}Explain and reflect
Which operation proves the intended result in logs and failure investigation? Which wrong input would expose a weakness, and what would remain unchanged?
Adapt the calculation or validation to a second realistic case. Write its expected result before running. Demonstrate one invalid case and explain whether the side effects should be rolled back or retried.
Troubleshooting
If the console is empty, inspect the logs preview: this script may work through state changes. If the function is missing, select main. For a service error inspect the first failed timeline entry and its arguments. Use Manual unless investigating a trigger. Changing input data also changes the expected result; restore sample data before the authored checks.
Knowledge check
Explain the key method or operator. Give an exact output for a second input, plus one invalid case. Verify the result in the interactive lesson; written explanations need self or educator review.
Optional AI practice
Explain this concept using the source above. Help implement one small extension and define its tests. Review/debug the source using its actual expected output; cite real method references and never claim execution.