{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "0",
   "metadata": {},
   "source": [
    "# Logging \n",
    "\n",
    "The toolkit generates logging messages, that can warn and help the users. By default, only **Warnings** are logged to the console. If you want to read the logs, you can do this by:\n",
    "\n",
    "* forwarding the logs to a file --> this file will be updated with log messages (live). Use the ``metobs_toolkit.add_FileHandler()`` method.\n",
    "\n",
    "* Print logs in your console (i.g. your coding environment) --> this will print out the logs in your coding environment (live). Use the ``metobs_toolkit.add_StreamHandler()`` method.\n"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "1",
   "metadata": {},
   "source": [
    "## Stream Logs\n",
    "\n",
    "To stream logs, call the ``add_StreamHandler()`` function."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "2",
   "metadata": {},
   "outputs": [
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "LOG:: INFO - StreamHandler set at 2025-12-19 14:41:41.459611\n",
      "LOG:: INFO - Reading the templatefile\n",
      "LOG:: WARNING - Luchtdruk is present in the datafile, but not found in the template! This column will be ignored.\n",
      "LOG:: WARNING - Neerslagintensiteit is present in the datafile, but not found in the template! This column will be ignored.\n",
      "LOG:: WARNING - Neerslagsom is present in the datafile, but not found in the template! This column will be ignored.\n",
      "LOG:: WARNING - Rukwind is present in the datafile, but not found in the template! This column will be ignored.\n",
      "LOG:: WARNING - Luchtdruk_Zeeniveau is present in the datafile, but not found in the template! This column will be ignored.\n",
      "LOG:: WARNING - Globe Temperatuur is present in the datafile, but not found in the template! This column will be ignored.\n",
      "LOG:: WARNING - The following columns are present in the data file, but not in the template! They are skipped!\n",
      " ['Neerslagintensiteit', 'Rukwind', 'Neerslagsom', 'Luchtdruk_Zeeniveau', 'Luchtdruk', 'Globe Temperatuur']\n",
      "LOG:: INFO - Data parsing completed.\n",
      "LOG:: WARNING - The following columns are found in the metadata, but not in the template and are therefore ignored: \n",
      "['sponsor', 'stad', 'Network', 'benaming']\n",
      "LOG:: INFO - Entering get_df method of <metobs_toolkit.io_collection.dataparser.DataParser object at 0x7fa39be063d0>.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n"
     ]
    }
   ],
   "source": [
    "import metobs_toolkit \n",
    "\n",
    "# Forward the logs to the coding environment\n",
    "metobs_toolkit.add_StreamHandler(setlvl='INFO')\n",
    "\n",
    "#Import a dataset to generate logs\n",
    "dataset = metobs_toolkit.Dataset()\n",
    "dataset.import_data_from_file(\n",
    "        input_data_file=metobs_toolkit.demo_datafile,\n",
    "        input_metadata_file=metobs_toolkit.demo_metadatafile,\n",
    "        template_file=metobs_toolkit.demo_template,\n",
    "        )\n"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "3",
   "metadata": {},
   "source": [
    "## File logs\n",
    "\n",
    "To write logs to a file, call the ``add_FileHandler()`` function, and specify the path."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "id": "4",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "\n",
       "            <style>\n",
       "                .geemap-dark {\n",
       "                    --jp-widgets-color: white;\n",
       "                    --jp-widgets-label-color: white;\n",
       "                    --jp-ui-font-color1: white;\n",
       "                    --jp-layout-color2: #454545;\n",
       "                    background-color: #383838;\n",
       "                }\n",
       "\n",
       "                .geemap-dark .jupyter-button {\n",
       "                    --jp-layout-color3: #383838;\n",
       "                }\n",
       "\n",
       "                .geemap-colab {\n",
       "                    background-color: var(--colab-primary-surface-color, white);\n",
       "                }\n",
       "\n",
       "                .geemap-colab .jupyter-button {\n",
       "                    --jp-layout-color3: var(--colab-primary-surface-color, white);\n",
       "                }\n",
       "            </style>\n",
       "            "
      ],
      "text/plain": [
       "<IPython.core.display.HTML object>"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    },
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "LOG:: INFO - File /home/thoverga/Documents/VLINDER_github/MetObs_toolkit/docs/topics/example_logfile.log exists but will be overwritten.\n",
      "LOG:: INFO - Reading the templatefile\n",
      "LOG:: WARNING - Luchtdruk is present in the datafile, but not found in the template! This column will be ignored.\n",
      "LOG:: WARNING - Neerslagintensiteit is present in the datafile, but not found in the template! This column will be ignored.\n",
      "LOG:: WARNING - Neerslagsom is present in the datafile, but not found in the template! This column will be ignored.\n",
      "LOG:: WARNING - Rukwind is present in the datafile, but not found in the template! This column will be ignored.\n",
      "LOG:: WARNING - Luchtdruk_Zeeniveau is present in the datafile, but not found in the template! This column will be ignored.\n",
      "LOG:: WARNING - Globe Temperatuur is present in the datafile, but not found in the template! This column will be ignored.\n",
      "LOG:: WARNING - The following columns are present in the data file, but not in the template! They are skipped!\n",
      " ['Neerslagintensiteit', 'Rukwind', 'Neerslagsom', 'Luchtdruk_Zeeniveau', 'Luchtdruk', 'Globe Temperatuur']\n",
      "LOG:: INFO - Data parsing completed.\n",
      "LOG:: WARNING - The following columns are found in the metadata, but not in the template and are therefore ignored: \n",
      "['sponsor', 'stad', 'Network', 'benaming']\n",
      "LOG:: INFO - Entering get_df method of <metobs_toolkit.io_collection.dataparser.DataParser object at 0x7fa39c0d5a90>.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n",
      "LOG:: INFO - SensorData initialized successfully.\n"
     ]
    }
   ],
   "source": [
    "from pathlib import Path\n",
    "\n",
    "target_logfile = Path.cwd() / 'example_logfile.log'\n",
    "metobs_toolkit.add_FileHandler(filepath=target_logfile, #path to the logfile (can be nonexisting)\n",
    "                               setlvl = 'INFO',\n",
    "                               clearlog=True)\n",
    "\n",
    "#Import a dataset to generate logs\n",
    "dataset = metobs_toolkit.Dataset()\n",
    "dataset.import_data_from_file(\n",
    "        input_data_file=metobs_toolkit.demo_datafile,\n",
    "        input_metadata_file=metobs_toolkit.demo_metadatafile,\n",
    "        template_file=metobs_toolkit.demo_template,\n",
    "        )"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.11.5"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}