Serialization of Reports into JSON or Text Files

🧭 Context Introduction

After collecting system health data—CPU usage, memory stats, disk space, and running services—the next logical step is to save that data so it can be reviewed later, shared with teammates, or fed into monitoring dashboards. This process is called serialization: converting in-memory Python objects (like dictionaries and lists) into a storable format. The two most common formats for engineers are JSON (JavaScript Object Notation) and plain text files. JSON is structured and machine-readable, while text files are simple and human-friendly. This guide walks through both approaches so you can choose the right one for your system health reports.

⚙️ Why Serialize Reports?

• Persistence – Data survives after the script finishes running.
• Sharing – Reports can be emailed, uploaded, or stored in a shared directory.
• Automation – Other tools (like log aggregators or dashboards) can ingest JSON files.
• Audit Trail – Historical snapshots let you compare system health over time.

📊 JSON Serialization – Structured & Machine-Friendly

JSON is the go-to format when you need to parse the report programmatically. Python's built-in json module handles the conversion.

Key steps:

• Import the json module at the top of your script.
• Build a Python dictionary containing all your system health metrics (CPU, memory, disk, services).
• Use json.dumps() to convert the dictionary into a JSON string.
• Write that string to a file using Python's open() function with 'w' mode.
• For pretty printing (readable indentation), pass the indent=4 argument to json.dumps().

Example flow (no code blocks):

• Create a dictionary like report = {"timestamp": "2025-04-10 14:30", "cpu_percent": 45.2, "memory_used_mb": 2048}
• Call json.dumps(report, indent=4) to get a formatted JSON string.
• Open a file named system_report.json with open("system_report.json", "w") as f:
• Write the string with f.write(json_string) .

Result: A file that looks like a clean, indented JSON object—perfect for loading into other scripts or tools.

🛠️ Text File Serialization – Simple & Human-Readable

Sometimes you just want a quick, readable log. Text files are ideal for that. No special modules are needed—just Python's built-in file handling.

Key steps:

• Build a string that contains your report in plain English (or any format you prefer).
• Use open() with 'w' mode to create or overwrite a text file.
• Write each line with f.write() or use f.writelines() for a list of strings.
• Add timestamps and section headers to make the text file easy to scan.

Example flow (no code blocks):

• Construct a multi-line string: report_text = "System Health Report\nDate: 2025-04-10\nCPU: 45.2%\nMemory: 2048 MB used\n"
• Open system_report.txt with open("system_report.txt", "w") as f:
• Write the entire string with f.write(report_text) .

Result: A plain text file that can be opened in any editor or printed directly to the terminal with cat or type.

🕵️ JSON vs Text – When to Use Which

📁 File Naming & Organization Tips

• Use timestamps in filenames to avoid overwriting: system_report_2025-04-10.json
• Store reports in a dedicated directory like ./reports/ for clean project structure.
• For repeated runs, append to a single log file using 'a' (append) mode instead of 'w' (write).
• Consider compressing old JSON reports with gzip if disk space is a concern.

🧪 Common Pitfalls to Avoid

• Forgetting to close the file – Always use the with statement (context manager) so files close automatically.
• Trying to serialize non-serializable objects – JSON only supports dicts, lists, strings, numbers, booleans, and None. Convert custom objects (like datetime) to strings first.
• Overwriting previous reports – Use unique filenames (timestamped) or append mode to preserve history.
• Writing binary data to text mode – Use 'wb' for binary files (like compressed JSON) and 'w' for text.

🚀 Next Steps for Your Project

• Combine both formats: save a JSON file for automation and a text file for quick viewing.
• Add error handling with try/except blocks around file operations to handle permission errors or missing directories.
• Extend your report to include network stats, disk I/O, or running process counts.
• Schedule your script with cron (Linux) or Task Scheduler (Windows) to generate reports automatically.

✅ Summary

Serialization turns your live system health data into permanent, shareable reports. JSON gives you structure and machine readability—perfect for feeding into other tools. Text files give you simplicity and immediate human readability—great for quick checks and logs. By mastering both, you can build a flexible reporting system that serves both automated pipelines and manual reviews. Start with one format, then add the other as your project grows.

This topic shows how to save system health report data into JSON and text files so engineers can store and share results.

📄 Example 1: Writing a simple string to a text file

This example writes a single line of text into a new file.

report = "System health: OK"
with open("report.txt", "w") as file:
    file.write(report)

📤 Output: report.txt file created with content "System health: OK"

📄 Example 2: Writing multiple lines to a text file

This example writes a multi-line report using a list of strings.

lines = ["CPU: 45%", "Memory: 2.1 GB used", "Disk: 120 GB free"]
with open("report.txt", "w") as file:
    for line in lines:
        file.write(line + "\n")

📤 Output: report.txt file created with three lines of health data

📄 Example 3: Converting a dictionary to JSON and saving it

This example takes a Python dictionary and writes it as a JSON file.

import json

report_data = {
    "cpu_usage": 45,
    "memory_used_gb": 2.1,
    "disk_free_gb": 120
}

with open("report.json", "w") as file:
    json.dump(report_data, file)

📤 Output: report.json file created with JSON-formatted dictionary

📄 Example 4: Reading a JSON file back into Python

This example loads the JSON file created in Example 3 and prints the data.

import json

with open("report.json", "r") as file:
    loaded_data = json.load(file)

print(loaded_data)

📤 Output: {'cpu_usage': 45, 'memory_used_gb': 2.1, 'disk_free_gb': 120}

📄 Example 5: Writing a list of reports to JSON with pretty printing

This example saves multiple system health snapshots with readable indentation.

import json

reports = [
    {"timestamp": "2024-01-15 10:00", "cpu": 45, "memory": 2.1},
    {"timestamp": "2024-01-15 11:00", "cpu": 62, "memory": 3.4},
    {"timestamp": "2024-01-15 12:00", "cpu": 38, "memory": 1.8}
]

with open("reports.json", "w") as file:
    json.dump(reports, file, indent=4)

📤 Output: reports.json file created with three report entries, each indented for readability

Comparison Table: Text Files vs JSON Files

🧭 Context Introduction

After collecting system health data—CPU usage, memory stats, disk space, and running services—the next logical step is to save that data so it can be reviewed later, shared with teammates, or fed into monitoring dashboards. This process is called serialization: converting in-memory Python objects (like dictionaries and lists) into a storable format. The two most common formats for engineers are JSON (JavaScript Object Notation) and plain text files. JSON is structured and machine-readable, while text files are simple and human-friendly. This guide walks through both approaches so you can choose the right one for your system health reports.

⚙️ Why Serialize Reports?

• Persistence – Data survives after the script finishes running.
• Sharing – Reports can be emailed, uploaded, or stored in a shared directory.
• Automation – Other tools (like log aggregators or dashboards) can ingest JSON files.
• Audit Trail – Historical snapshots let you compare system health over time.

📊 JSON Serialization – Structured & Machine-Friendly

JSON is the go-to format when you need to parse the report programmatically. Python's built-in json module handles the conversion.

Key steps:

• Import the json module at the top of your script.
• Build a Python dictionary containing all your system health metrics (CPU, memory, disk, services).
• Use json.dumps() to convert the dictionary into a JSON string.
• Write that string to a file using Python's open() function with 'w' mode.
• For pretty printing (readable indentation), pass the indent=4 argument to json.dumps().

Example flow (no code blocks):

• Create a dictionary like report = {"timestamp": "2025-04-10 14:30", "cpu_percent": 45.2, "memory_used_mb": 2048}
• Call json.dumps(report, indent=4) to get a formatted JSON string.
• Open a file named system_report.json with open("system_report.json", "w") as f:
• Write the string with f.write(json_string) .

Result: A file that looks like a clean, indented JSON object—perfect for loading into other scripts or tools.

🛠️ Text File Serialization – Simple & Human-Readable

Sometimes you just want a quick, readable log. Text files are ideal for that. No special modules are needed—just Python's built-in file handling.

Key steps:

• Build a string that contains your report in plain English (or any format you prefer).
• Use open() with 'w' mode to create or overwrite a text file.
• Write each line with f.write() or use f.writelines() for a list of strings.
• Add timestamps and section headers to make the text file easy to scan.

Example flow (no code blocks):

• Construct a multi-line string: report_text = "System Health Report\nDate: 2025-04-10\nCPU: 45.2%\nMemory: 2048 MB used\n"
• Open system_report.txt with open("system_report.txt", "w") as f:
• Write the entire string with f.write(report_text) .

Result: A plain text file that can be opened in any editor or printed directly to the terminal with cat or type.

🕵️ JSON vs Text – When to Use Which

📁 File Naming & Organization Tips

• Use timestamps in filenames to avoid overwriting: system_report_2025-04-10.json
• Store reports in a dedicated directory like ./reports/ for clean project structure.
• For repeated runs, append to a single log file using 'a' (append) mode instead of 'w' (write).
• Consider compressing old JSON reports with gzip if disk space is a concern.

🧪 Common Pitfalls to Avoid

• Forgetting to close the file – Always use the with statement (context manager) so files close automatically.
• Trying to serialize non-serializable objects – JSON only supports dicts, lists, strings, numbers, booleans, and None. Convert custom objects (like datetime) to strings first.
• Overwriting previous reports – Use unique filenames (timestamped) or append mode to preserve history.
• Writing binary data to text mode – Use 'wb' for binary files (like compressed JSON) and 'w' for text.

🚀 Next Steps for Your Project

• Combine both formats: save a JSON file for automation and a text file for quick viewing.
• Add error handling with try/except blocks around file operations to handle permission errors or missing directories.
• Extend your report to include network stats, disk I/O, or running process counts.
• Schedule your script with cron (Linux) or Task Scheduler (Windows) to generate reports automatically.

✅ Summary

Serialization turns your live system health data into permanent, shareable reports. JSON gives you structure and machine readability—perfect for feeding into other tools. Text files give you simplicity and immediate human readability—great for quick checks and logs. By mastering both, you can build a flexible reporting system that serves both automated pipelines and manual reviews. Start with one format, then add the other as your project grows.

This topic shows how to save system health report data into JSON and text files so engineers can store and share results.

📄 Example 1: Writing a simple string to a text file

This example writes a single line of text into a new file.

report = "System health: OK"
with open("report.txt", "w") as file:
    file.write(report)

📤 Output: report.txt file created with content "System health: OK"

📄 Example 2: Writing multiple lines to a text file

This example writes a multi-line report using a list of strings.

lines = ["CPU: 45%", "Memory: 2.1 GB used", "Disk: 120 GB free"]
with open("report.txt", "w") as file:
    for line in lines:
        file.write(line + "\n")

📤 Output: report.txt file created with three lines of health data

📄 Example 3: Converting a dictionary to JSON and saving it

This example takes a Python dictionary and writes it as a JSON file.

import json

report_data = {
    "cpu_usage": 45,
    "memory_used_gb": 2.1,
    "disk_free_gb": 120
}

with open("report.json", "w") as file:
    json.dump(report_data, file)

📤 Output: report.json file created with JSON-formatted dictionary

📄 Example 4: Reading a JSON file back into Python

This example loads the JSON file created in Example 3 and prints the data.

import json

with open("report.json", "r") as file:
    loaded_data = json.load(file)

print(loaded_data)

📤 Output: {'cpu_usage': 45, 'memory_used_gb': 2.1, 'disk_free_gb': 120}

📄 Example 5: Writing a list of reports to JSON with pretty printing

This example saves multiple system health snapshots with readable indentation.

import json

reports = [
    {"timestamp": "2024-01-15 10:00", "cpu": 45, "memory": 2.1},
    {"timestamp": "2024-01-15 11:00", "cpu": 62, "memory": 3.4},
    {"timestamp": "2024-01-15 12:00", "cpu": 38, "memory": 1.8}
]

with open("reports.json", "w") as file:
    json.dump(reports, file, indent=4)

📤 Output: reports.json file created with three report entries, each indented for readability

Comparison Table: Text Files vs JSON Files