Time Series Historian
      Back to home
      1. Timebase Knowledge Base
      2. Time Series Historian

      Time Series Historian Settings

      Adjust where the historian stores the history files, as well as some basic logging details and port settings.

      Begin by opening Windows File Explorer and navigating to the installation directory for the historian. The default is C:\Program Files\Flow Software\Timebase\Historian

      Within the Time Series Historian folder, open the file appsettings.json.

      Your file should look similar to the snippet below. 

      Modify as necessary based on your environment. To change the location of the Logs or the Data, uncomment the lines below and update the location. 

      Save the file and then restart the historian service.

      {
        //"Data": "C:\\ProgramData\\Flow Software\\Timebase\\Historian\\Data",
        //"Logs": "C:\\ProgramData\\Flow Software\\Timebase\\Historian\\Logs",

        "DetailedErrors": true,
        
        "Serilog": {
          "MinimumLevel": {
            "Default": "Warning",
            "Override": {
              "Timebase.Dataset": "Information",
              "Timebase.Historian": "Information"
            }
          }
        },

        "Kestrel": {
          "Endpoints": {
            "Http": {
              "Url": "http://0.0.0.0:4511"
            }
          }
        }
      }

      Section: DetailedErrors

      This option is commonly used to control whether detailed error messages are shown when something goes wrong.

      "DetailedErrors": true,
      • Set to either true or false. Setting this to true means that when an error occurs, the system will display more comprehensive error messages, which can help developers or users troubleshoot the issue more effectively.

      Section: Logging

      This section controls the logging behavior for different components of the application. To begin, it is recommended that you leave these settings at their default.

      "Serilog": {
        "MinimumLevel": {
          "Default": "Warning",
          "Override": {
            "Timebase.Dataset": "Information",
            "Timebase.Historian": "Information"
          }
        }
      },

      • LogLevel: Specifies the level of detail for logs for various components.

        • "Default": "Warning": Sets the default logging level to Warning. This means logs will capture warnings, and errors, but not detailed Debug information.
        • "Timebase.Dataset": "Information": This is specifically configuring the logging level for the Timebase.Dataset namespace. For additional support information, this setting can temporarily be set to Debug.
        • "Timebase.Historian": "Information": This sets the logging level for the Timebase.Historian namespace to Information. For additional support information, this setting can temporarily be set to Debug.

      Section: Kestrel

      Kestrel is a web server used in ASP.NET Core applications.

      "Kestrel": {
          "Endpoints": {
            "Http": {
              "Url": "http://0.0.0.0:4511"
            }
          }
        },
      • Endpoints: Defines where the application will listen for HTTP requests.
        • "Http": { "Url": "http://0.0.0.0:4511" }: This means that the web server will listen for HTTP requests on all network interfaces (0.0.0.0) on port 4511. This makes the application accessible from any IP address.

      Section: Data and Logs

      This specifies the paths on the server where the application's data and logs are stored.

      "Data": "C:\\ProgramData\\Flow Software\\Timebase\\Historian\\Data",
      "Logs": "C:\\ProgramData\\Flow Software\\Timebase\\Historian\\Logs",

       

      ⚠️ Important: When specifying a path on Windows, you must use double backslashes (\\) between folder names, as a single backslash is an escape character in JSON.