Time Series Historian Settings
What the Historian's settings.config contains as shipped: the Pulse connection and certificate management, logging, the listeners, and the PostgreSQL-compatible SQL endpoint that ships switched on.
The Historian's settings.config has the same shape as every other component's. Component Settings explains the file, where it lives, the settings editor in the interface, and the sections every component shares: DetailedErrors, Serilog, Kestrel and Pulse. This page covers what is particular to the Historian.
The file as shipped#
{
"DetailedErrors": false,
"Pulse": {
"Host": "localhost",
"Port": 4542,
"UseTls": true,
"Cert": { "Enabled": true, "Install": true, "Names": [], "AutoNames": true },
"Gage": { "Enabled": true, "Agents": {} },
"Auth": { "Enabled": true, "ClientId": "Historian", "ClientSecret": "" }
},
"Serilog": {
"MinimumLevel": {
"Default": "Warning",
"Override": {
"Timebase.Dataset": "Information",
"Timebase.Historian": "Information",
"Timebase.Core.Agent": "Information",
"Timebase.Core.Licensing": "Information"
}
}
},
"Kestrel": {
"Endpoints": {
"Http": { "Url": "http://0.0.0.0:4511" },
"Https": { "Url": "https://0.0.0.0:4512", "Certificate": { "Path": "", "Password": "" } }
}
},
"PGWire": { "Enabled": true, "Port": 5432, "Username": "postgres", "Password": "timebase" }
}
What is particular to the Historian#
It ships secured, with the secret left for you. Pulse:Auth:Enabled is true and the client is Historian. ClientSecret is blank in the shipped file, and the Historian's web page asks for it the first time it opens and saves it into the file, so you can supply the secret from Pulse without editing anything. See Enabling User Management in Historian Utilizing Pulse.
The certificate in Kestrel is read only when Pulse's certificate management is off. While Pulse:Cert:Enabled is true, the Historian generates and serves its own certificate, has Pulse sign it, and ignores the Certificate block entirely. Set Pulse:Cert:Enabled to false to serve a certificate of your own, and then fill in Path and, for an encrypted PFX, Password. See Timebase Certificates.
Logging is turned up for the Historian's own namespaces. The default minimum level is Warning, with Timebase.Dataset, Timebase.Historian, the AI harness and licensing at Information, so the log records what the Historian does without recording every request. Raise or lower levels in the settings editor or in the file; see Changing The Verbosity Of Timebase Logging.
PGWire ships switched on. The PGWire section opens a PostgreSQL-compatible SQL endpoint on port 5432, on every network interface, with the login postgres / timebase. Change the password before the machine is reachable by anyone else; the Historian keeps the endpoint closed while either the username or the password is blank, so blanking the password is also how you switch it off without touching Enabled. What the endpoint accepts and which clients work with it are in Querying the Historian with SQL.
Nothing about datasets, purging or late data lives here. Those are properties of each dataset and are set on the dataset itself, in the interface or through the API. See Late Data Handling and Historian Data Sizing Guide and Best Practises.