Python examples
Manage Collectors
Creating a collector
This code creates a collector with (my Swagger):
- Name: My CSV Collector
- Description: Collector for CSV imports
- Status: Initial
def create_collector(name: str, description: Optional[str]):
payload = {"Name": name, "Description": description, "Status": "Initial"}
resp = session.post(f"{BASE_URL}/collectors", json=payload, timeout=60)
resp.raise_for_status()
return resp.json()
new_collector = create_collector("My CSV Collector", "Collector for CSV imports")
print(json.dumps(new_collector, indent=2)){
"UUID": "5e3068f8-94b6-11f0-8c78-a25bd411a45c",
"CreatedBy": "6c8ef372-5c29-11ef-9e88-0242ac12000a",
"CreatedAt": "2025-09-18T17:39:03.363129Z",
"UpdatedBy": "6c8ef372-5c29-11ef-9e88-0242ac12000a",
"UpdatedAt": "2025-09-18T17:39:03.363129Z",
"Attributes": {},
"Metadata": {},
"OrganizationUUID": "fbf184b2-5c29-11ef-8bf9-0242ac12000a",
"Settings": {},
"Name": "My CSV Collector",
"CollectorType": null,
"BuildVersion": null,
"BuildOs": null,
"BuildArch": null,
"Description": "Collector for CSV imports",
"Status": "Initial",
"MeasurementSettingsSchema": {},
"SettingsSchema": {},
"State": {},
"LastSeen": "0001-01-01T00:00:00Z",
"IPAddress": "",
"HAUUID": null,
"DefaultDatabaseUUID": null,
"UpdateCollectorTo": null
}At this point, the collector is ready to be installed: Installing a collectorInstalling a collector.
Upon installation, the collector will register itself to add information such as:
- Collector type
- Build version
- Settings
- ...
While it is technically possible to register the collector yourself, you should not change the built-in behavior of shipped collectors (OPC-UA, OPC-DA, etc.) using the collectors API unless you know exactly what you’re doing.
Activating the collector
This code sets the collector status to active using the collector UUID (my Swagger).
PATCH https://historian.mycompany.com:18000/api/collectors/{collector_uuid}/status (replace {collector_uuid} with your collector uuid)
def set_collector_status(collector_uuid: str, status: str):
resp = session.patch(
f"{BASE_URL}/collectors/{collector_uuid}/status",
json=status,
timeout=30
)
resp.raise_for_status()
return resp.json()
collector_uuid = new_collector["UUID"]
activated_collector = set_collector_status(collector_uuid, "Active")
print(json.dumps(activated_collector, indent=2)){
"UUID": "5e3068f8-94b6-11f0-8c78-a25bd411a45c",
"CreatedBy": "6c8ef372-5c29-11ef-9e88-0242ac12000a",
"CreatedAt": "2025-09-18T17:39:03.363129Z",
"UpdatedBy": "6c8ef372-5c29-11ef-9e88-0242ac12000a",
"UpdatedAt": "2025-09-18T17:46:07.518838629Z",
"Attributes": {},
"Metadata": {},
"OrganizationUUID": "fbf184b2-5c29-11ef-8bf9-0242ac12000a",
"Settings": {},
"Name": "My CSV Collector",
"CollectorType": "csv",
"BuildVersion": "5.2.3",
"BuildOs": "linux",
"BuildArch": "arm64",
"Description": "Collector for CSV imports",
"Status": "Active",
"MeasurementSettingsSchema": {
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {},
"id": "http://factry.io/measurementsettings.json",
"properties": {
"Filter": {
"additionalProperties": false,
"default": {},
"description": "Filter to parse only the rows that match the filter. The filter is a JSON object where the key is the column index (as a string) and the value is the value to match. If multiple values in the same column should be matched, separate them with a semicolon.. Use {} to leave empty.",
"examples": [
"{\"1\":\"G10391\"}"
],
"id": "/properties/Filter",
"minProperties": 0,
"order": 2,
"patternProperties": {
"[0-9]+": {
"type": "string"
}
},
"title": "Filter",
"type": "object"
},
"StatusGood": {
"description": "All values that are mapped to status 'Good'. Multiple statuses can be configured using semicolon separated values",
"id": "/properties/StatusGood",
"order": 3,
"title": "StatusGood",
"type": "string"
},
"TagsInCSV": {
"additionalProperties": false,
"default": {},
"description": "An optional json configuration to add values from a certain column index (starts from 0) to a tag. Mutiple mappings can be foreseen using one column index and one tag name. Use {} to leave empty.",
"examples": [
"{\"1\":\"tagName\"}"
],
"id": "/properties/TagsInCSV",
"minProperties": 0,
"order": 5,
"patternProperties": {
"[0-9]+": {
"type": "string"
}
},
"title": "TagsInCSV",
"type": "object"
},
"TimestampLayout": {
"description": "The layout of the timestamp, default the TimestampLayout setting on the collector will be used. More info: https://pkg.go.dev/time#Layout",
"id": "/properties/TimestampLayout",
"order": 4,
"title": "TimestampLayout",
"type": "string"
},
"ValueColumn": {
"default": 2,
"description": "Index of column holding the value (starts from 0)",
"id": "/properties/ValueColumn",
"order": 1,
"title": "ValueColumn",
"type": "integer"
}
},
"required": [
"ValueColumn"
],
"type": "object"
},
"SettingsSchema": {
"$id": "http://factry.io/collectorsettings.json",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {},
"properties": {
"AlternativeTimezone": {
"$id": "/properties/AlternativeTimezone",
"description": "This changes the timestamp of points, statistics and logs to the machine local timezone, strips off the timezone and indicates the timezone to be the alternative timezone. The timezone name is taken from the IANA Time Zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
"isAdvanced": true,
"order": 14,
"title": "AlternativeTimezone",
"type": "string"
},
"BasePath": {
"description": "Default directory where the incoming, processed and error directories are in. By default these directory names are respectively, incoming, processed and error. Paths are absolute. Add a trailing forward slash for linux or a trailing backslash for windows",
"id": "/properties/BasePath",
"order": 201,
"title": "BasePath",
"type": "string"
},
"BufferDiskBatches": {
"$id": "/properties/BufferDiskBatches",
"default": 100,
"description": "The maximum amount of batches that will be written to a buffer file.",
"isAdvanced": true,
"order": 8,
"title": "BufferDiskBatches",
"type": "integer"
},
"BufferMaxBatchSize": {
"$id": "/properties/BufferMaxBatchSize",
"default": 5000,
"description": "The maximum size of a batch.",
"isAdvanced": true,
"order": 6,
"title": "BufferMaxBatchSize",
"type": "integer"
},
"BufferMaxBatches": {
"$id": "/properties/BufferMaxBatches",
"default": 20,
"description": "The maximum amount of batches the buffer will keep in memory.",
"isAdvanced": true,
"order": 7,
"title": "BufferMaxBatches",
"type": "integer"
},
"BufferMaxDiskSpace": {
"$id": "/properties/BufferMaxDiskSpace",
"default": "0MB",
"description": "The maximum disk space that the buffer files may take up. Default no limit.",
"isAdvanced": true,
"order": 10,
"pattern": "[0-9]+(T|G|M|K)?B",
"title": "BufferMaxDiskSpace",
"type": "string"
},
"BufferMinFreeDiskSpace": {
"$id": "/properties/BufferMinFreeDiskSpace",
"default": "2GB",
"description": "The buffer wont write to more files if the minimum free disk space is reached.",
"isAdvanced": true,
"order": 9,
"pattern": "[0-9]+(T|G|M|K)?B",
"title": "BufferMinFreeDiskSpace",
"type": "string"
},
"BufferProcessInterval": {
"$id": "/properties/BufferProcessInterval",
"default": 250,
"description": "The interval in milliseconds that the buffer processes the buffer.",
"isAdvanced": true,
"minimum": 250,
"order": 5,
"title": "BufferProcessInterval",
"type": "integer"
},
"CSVHeader": {
"default": "false",
"description": "Indicates if there is a header in the csv files.",
"enum": [
"true",
"false"
],
"id": "/properties/CSVHeader",
"order": 107,
"title": "CSVHeader",
"type": "string"
},
"CompressionLevel": {
"$id": "/properties/CompressionLevel",
"default": -1,
"description": "The compression level GRPC uses, for default compression. 1-9: 1 = fastest, 9 = most compressed, -1 = default.",
"isAdvanced": true,
"maximum": 9,
"minimum": -1,
"order": 12,
"title": "CompressionLevel",
"type": "integer"
},
"Delimiter": {
"default": ",",
"description": "The delimiter used in the csv file.",
"id": "/properties/Delimiter",
"order": 106,
"title": "Delimiter",
"type": "string"
},
"ErrorDirectoryPath": {
"description": "Override directory in which files that contained an error will be put. Invalid CSV files will be stored here",
"id": "/properties/ErrorDirectoryPath",
"order": 204,
"title": "ErrorDirectoryPath",
"type": "string"
},
"FailedMaxAge": {
"default": 129600,
"description": "The maximum time in minutes to keep failed files. 0 will keep the files indefinitely",
"id": "/properties/FailedMaxAge",
"isAdvanced": true,
"order": 216,
"title": "FailedMaxAge",
"type": "integer"
},
"FileMask": {
"default": "*.csv",
"description": "File mask of the files to use",
"id": "/properties/FileMask",
"order": 205,
"pattern": "\\*\\.*[a-z]",
"title": "FileMask",
"type": "string"
},
"GRPCMaxMessageSize": {
"$id": "/properties/GRPCMaxMessageSize",
"default": "64MB",
"description": "The maximum message size for GRPC messages.",
"isAdvanced": true,
"order": 13,
"pattern": "[0-9]+(T|G|M|K)?B",
"title": "GRPCMaxMessageSize",
"type": "string"
},
"HAPollingInterval": {
"$id": "/properties/HAPollingInterval",
"default": 1000,
"description": "The interval in milliseconds at which the backup collector polls the main collector's health.",
"isAdvanced": true,
"order": 11,
"title": "HAPollingInterval",
"type": "integer"
},
"IncomingDirectoryPath": {
"description": "Override directory to monitor for files matching FileMask. Paths are absolute",
"id": "/properties/IncomingDirectoryPath",
"order": 202,
"title": "IncomingDirectoryPath",
"type": "string"
},
"LogLevel": {
"$id": "/properties/LogLevel",
"default": "info",
"description": "The log level of the collector.",
"enum": [
"trace",
"debug",
"info"
],
"isAdvanced": true,
"order": 1,
"title": "LogLevel",
"type": "string"
},
"ProcessDelay": {
"default": 3000,
"description": "Delay in milliseconds for processing new files after they were detected",
"id": "/properties/ProcessDelay",
"isAdvanced": true,
"order": 213,
"title": "ProcessDelay",
"type": "integer"
},
"ProcessInterval": {
"default": 10000,
"description": "Interval in milliseconds in which the incoming directory is checked for new files",
"id": "/properties/ProcessInterval",
"isAdvanced": true,
"order": 212,
"title": "ProcessInterval",
"type": "integer"
},
"ProcessedDirectoryPath": {
"description": "Override directory to which successfully processed files are moved. Paths are absolute",
"id": "/properties/ProcessedDirectoryPath",
"order": 203,
"title": "ProcessedDirectoryPath",
"type": "string"
},
"ProcessedMaxAge": {
"default": 43200,
"description": "The maximum time in minutes to keep processed files. 0 will keep the files indefinitely",
"id": "/properties/ProcessedMaxAge",
"isAdvanced": true,
"order": 215,
"title": "ProcessedMaxAge",
"type": "integer"
},
"SourceTimezone": {
"$id": "/properties/SourceTimezone",
"description": "This changes the timestamp of points by stripping off the timezone from the timestamp and indicating the timezone to be the source timezone (f.e. 0h UTC -> 0h UTC+2). Do not use if the points could come from different source devices (f.e. polling vs monitored), since these source devices can have different time settings! The timezone name is taken from the IANA Time Zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
"isAdvanced": true,
"order": 15,
"title": "SourceTimezone",
"type": "string"
},
"StartupDelay": {
"default": 9000,
"description": "Initial delay for checking the incoming directory in milliseconds",
"id": "/properties/StartupDelay",
"isAdvanced": true,
"order": 214,
"title": "StartupDelay",
"type": "integer"
},
"StatusColumn": {
"description": "Index of column holding the status (starts from 0)",
"id": "/properties/StatusColumn",
"order": 110,
"pattern": "[0-9]*",
"title": "StatusColumn",
"type": "string"
},
"StatusGood": {
"$id": "/properties/StatusGood",
"description": "A comma separated list of status strings that will be interpreted as a Good status.",
"isAdvanced": true,
"order": 16,
"title": "StatusGood",
"type": "string"
},
"TickerInterval": {
"$id": "/properties/TickerInterval",
"default": 1000,
"description": "The interval for the base ticker in milliseconds. This ticker is used for the polling of measurements.",
"isAdvanced": true,
"minimum": 250,
"order": 2,
"title": "TickerInterval",
"type": "integer"
},
"TickerMaxDrift": {
"$id": "/properties/TickerMaxDrift",
"default": 125,
"description": "The maximum drift a tick may have in milliseconds. Must be lower than the interval.",
"isAdvanced": true,
"order": 4,
"title": "TickerMaxDrift",
"type": "integer"
},
"TickerResolution": {
"$id": "/properties/TickerResolution",
"default": 25,
"description": "The resolution for the base ticker in milliseconds. Maximum 1/10th of the the interval.",
"isAdvanced": true,
"minimum": 2,
"order": 3,
"title": "TickerResolution",
"type": "integer"
},
"TimestampColumn": {
"default": 1,
"description": "Index of column holding the timestamp (starts from 0)",
"id": "/properties/TimestampColumn",
"order": 108,
"title": "TimestampColumn",
"type": "integer"
},
"TimestampLayout": {
"description": "The layout of the timestamp of the measurements, default RFC3339 will be used. More info: https://pkg.go.dev/time#Layout",
"id": "/properties/TimestampLayout",
"order": 109,
"title": "TimestampLayout",
"type": "string"
},
"TrimString": {
"description": "The string to trim (leading and trailing) from the csv cells used (values, mappings, status, ...)",
"id": "/properties/TrimString",
"order": 111,
"title": "TrimString",
"type": "string"
}
},
"required": [
"TimestampColumn",
"Delimiter",
"CSVHeader",
"BasePath",
"FileMask"
],
"type": "object"
},
"State": {},
"Health": {
"Health": "Initializing collector",
"Timestamp": "2025-09-18T17:43:34.164741Z",
"CollectorUUID": "5e3068f8-94b6-11f0-8c78-a25bd411a45c"
},
"LastSeen": "2025-09-18T17:46:04.436823086Z",
"IPAddress": "192.168.65.1:54314",
"HAUUID": null,
"DefaultDatabaseUUID": null,
"UpdateCollectorTo": null
}
List Collectors in an Organization
This code lists the collectors in the Factry Historian organization (my Swagger).
def list_collectors():
resp = session.get(f"{BASE_URL}/collectors", timeout=30)
resp.raise_for_status()
return resp.json()
collectors = list_collectors()[
{
"UUID": "fbfbc206-5c29-11ef-8bf9-0242ac12000a",
"CreatedBy": "6c8ef372-5c29-11ef-9e88-0242ac12000a",
"CreatedAt": "2024-08-16T23:48:06.275993Z",
"UpdatedBy": "6c8ef372-5c29-11ef-9e88-0242ac12000a",
"UpdatedAt": "2025-09-14T17:36:31.62295Z",
"Attributes": {},
"Metadata": {},
"OrganizationUUID": "fbf184b2-5c29-11ef-8bf9-0242ac12000a",
"Settings": {
"BatchSize": 360,
"BufferDiskBatches": 100,
"BufferEnableDiskQueue": false,
"BufferMaxBatchSize": 5000,
"BufferMaxBatches": 20,
"BufferMaxDiskSpace": "0MB",
"BufferMinFreeDiskSpace": "2GB",
"BufferProcessInterval": 250,
"LogLevel": "info",
"MaxQueryPeriod": "12h",
"SaveStateRate": 5,
"ScriptTimeout": 10000,
"UpdateRate": 5000
},
"Name": "Calculation collector",
"CollectorType": "calculation",
"BuildVersion": "7.3.3",
"BuildOs": "linux",
"BuildArch": "amd64",
"Description": "Internal collector for calculations",
"Status": "Active",
"MeasurementSettingsSchema": {
"$defs": {
"inputdatareference": {
"properties": {
"Aggregation": {
"description": "The aggregation used",
"enum": [
"count",
"integral",
"mean",
"median",
"mode",
"spread",
"stddev",
"sum",
"first",
"last",
"max",
"min"
],
"examples": [
""
],
"order": 3,
"title": "Aggregation",
"type": "string"
},
"Alias": {
"description": "An alias for the input measurement name",
"order": 4,
"title": "Alias",
"type": "string"
},
"Name": {
"description": "The name of the input measurement",
"order": 1,
"title": "Name",
"type": "string"
},
"UUID": {
"description": "The UUID of the input measurement",
"order": 2,
"title": "UUID",
"type": "string"
}
},
"required": [
"UUID",
"Alias"
],
"type": "object"
},
"rawsettings": {
"properties": {
"InputDataReference": {
"$ref": "#/$defs/inputdatareference"
},
"Script": {
"order": 4
},
"Type": {
"const": "raw",
"title": "Name"
}
},
"required": [
"Type",
"InputDataReference",
"Script"
]
},
"sampledsettings": {
"properties": {
"InputDataReferences": {
"description": "The input measurements",
"items": {
"$ref": "#/$defs/inputdatareference"
},
"order": 3,
"title": "InputDataReferences",
"type": "array"
},
"Interval": {
"title": "Interval",
"type": "string"
},
"IntervalOffset": {
"title": "IntervalOffset",
"type": "string"
},
"Script": {
"$ref": "#/$defs/script",
"order": 4
},
"Type": {
"const": "sampled",
"title": "Name"
}
},
"required": [
"Type",
"Interval",
"IntervalOffset",
"Script"
]
},
"script": {
"description": "The script",
"title": "Script",
"type": "string"
}
},
"$id": "http://factry.io/calculationsettings.json",
"$schema": "http://json-schema.org/draft-06/schema#",
"oneOf": [
{
"$ref": "#/$defs/rawsettings"
},
{
"$ref": "#/$defs/sampledsettings"
}
],
"type": "object"
},
"SettingsSchema": {
"$id": "http://factry.io/calculationcollectorsettings.json",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {},
"properties": {
"BatchSize": {
"$id": "/properties/BatchSize",
"default": 3600,
"description": "Defines the maximum number of points that get processed per run.",
"isAdvanced": true,
"minimum": 1,
"order": 2,
"title": "BatchSize",
"type": "integer"
},
"BufferDiskBatches": {
"$id": "/properties/BufferDiskBatches",
"default": 100,
"description": "The maximum amount of batches that will be written to a buffer file.",
"isAdvanced": true,
"order": 108,
"title": "BufferDiskBatches",
"type": "integer"
},
"BufferEnableDiskQueue": {
"$id": "/properties/BufferEnableDiskQueue",
"default": true,
"description": "Enable the disk queue.",
"isAdvanced": true,
"order": 111,
"title": "BufferEnableDiskQueue",
"type": "boolean"
},
"BufferMaxBatchSize": {
"$id": "/properties/BufferMaxBatchSize",
"default": 5000,
"description": "The maximum size of a batch.",
"isAdvanced": true,
"order": 106,
"title": "BufferMaxBatchSize",
"type": "integer"
},
"BufferMaxBatches": {
"$id": "/properties/BufferMaxBatches",
"default": 20,
"description": "The maximum amount of batches the buffer will keep in memory.",
"isAdvanced": true,
"order": 107,
"title": "BufferMaxBatches",
"type": "integer"
},
"BufferMaxDiskSpace": {
"$id": "/properties/BufferMaxDiskSpace",
"default": "0MB",
"description": "The maximum disk space that the buffer files may take up. Default no limit.",
"isAdvanced": true,
"order": 110,
"pattern": "[0-9]+(T|G|M|K)?B",
"title": "BufferMaxDiskSpace",
"type": "string"
},
"BufferMinFreeDiskSpace": {
"$id": "/properties/BufferMinFreeDiskSpace",
"default": "2GB",
"description": "The buffer wont write to more files if the minimum free disk space is reached.",
"isAdvanced": true,
"order": 109,
"pattern": "[0-9]+(T|G|M|K)?B",
"title": "BufferMinFreeDiskSpace",
"type": "string"
},
"BufferProcessInterval": {
"$id": "/properties/BufferProcessInterval",
"default": 250,
"description": "The interval in milliseconds that the buffer processes the buffer.",
"isAdvanced": true,
"minimum": 250,
"order": 105,
"title": "BufferProcessInterval",
"type": "integer"
},
"LogLevel": {
"$id": "/properties/LogLevel",
"default": "info",
"description": "The log level for this calculation collector logs.",
"enum": [
"trace",
"debug",
"info",
"warning",
"error",
"fatal",
"panic"
],
"isAdvanced": true,
"order": 6,
"title": "LogLevel",
"type": "string"
},
"MaxQueryPeriod": {
"$id": "/properties/MaxQueryPeriod",
"default": "7d",
"description": "The maximum query period for a calculation.",
"isAdvanced": true,
"order": 4,
"pattern": "^(\\d+[w,d,h,m,s])+$",
"title": "MaxQueryPeriod",
"type": "string"
},
"SaveStateRate": {
"$id": "/properties/SaveStateRate",
"default": 5,
"description": "The rate in minutes at which calculation states are saved.",
"isAdvanced": true,
"minimum": 1,
"order": 5,
"title": "SaveStateRate",
"type": "integer"
},
"ScriptTimeout": {
"$id": "/properties/ScriptTimeout",
"default": 10000,
"description": "The timeout for a calculation script in ms.",
"minimum": 1000,
"order": 1,
"title": "ScriptTimeout",
"type": "integer"
},
"UpdateRate": {
"$id": "/properties/UpdateRate",
"default": 5000,
"description": "The update rate at which calculations are evaluated.",
"isAdvanced": true,
"minimum": 1000,
"order": 3,
"title": "UpdateRate",
"type": "integer"
}
},
"required": [],
"type": "object"
},
"State": {},
"Health": {
"Health": "Collecting",
"Timestamp": "2025-09-18T18:18:08.722798Z",
"CollectorUUID": "fbfbc206-5c29-11ef-8bf9-0242ac12000a"
},
"LastSeen": "2025-09-18T18:21:55.628658471Z",
"IPAddress": "",
"HAUUID": null,
"DefaultDatabaseUUID": null,
"UpdateCollectorTo": null
},
{
"UUID": "fbfd4dec-5c29-11ef-8bf9-0242ac12000a",
"CreatedBy": "6c8ef372-5c29-11ef-9e88-0242ac12000a",
"CreatedAt": "2024-08-16T23:48:06.286763Z",
"UpdatedBy": "6c8ef372-5c29-11ef-9e88-0242ac12000a",
"UpdatedAt": "2024-08-16T23:48:06.288012Z",
"Attributes": {},
"Metadata": {},
"OrganizationUUID": "fbf184b2-5c29-11ef-8bf9-0242ac12000a",
"Settings": {},
"Name": "Internal collector",
"CollectorType": "internal",
"BuildVersion": null,
"BuildOs": null,
"BuildArch": null,
"Description": "Internal collector",
"Status": "Active",
"MeasurementSettingsSchema": {},
"SettingsSchema": {},
"State": {},
"Health": {
"Health": "Collecting",
"Timestamp": "2025-09-18T18:18:08.912794Z",
"CollectorUUID": "fbfd4dec-5c29-11ef-8bf9-0242ac12000a"
},
"LastSeen": "2025-09-18T18:21:55.628647304Z",
"IPAddress": "",
"HAUUID": null,
"DefaultDatabaseUUID": null,
"UpdateCollectorTo": null
},
{
"UUID": "2369d6fe-94bc-11f0-acc7-a25bd411a45c",
"CreatedBy": "6c8ef372-5c29-11ef-9e88-0242ac12000a",
"CreatedAt": "2025-09-18T18:20:21.736927Z",
"UpdatedBy": "6c8ef372-5c29-11ef-9e88-0242ac12000a",
"UpdatedAt": "2025-09-18T18:21:46.542773Z",
"Attributes": {},
"Metadata": {},
"OrganizationUUID": "fbf184b2-5c29-11ef-8bf9-0242ac12000a",
"Settings": {},
"Name": "My CSV Collector",
"CollectorType": "csv",
"BuildVersion": "5.2.3",
"BuildOs": "linux",
"BuildArch": "arm64",
"Description": "Collector for CSV imports",
"Status": "Active",
"MeasurementSettingsSchema": {
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {},
"id": "http://factry.io/measurementsettings.json",
"properties": {
"Filter": {
"additionalProperties": false,
"default": {},
"description": "Filter to parse only the rows that match the filter. The filter is a JSON object where the key is the column index (as a string) and the value is the value to match. If multiple values in the same column should be matched, separate them with a semicolon.. Use {} to leave empty.",
"examples": [
"{\"1\":\"G10391\"}"
],
"id": "/properties/Filter",
"minProperties": 0,
"order": 2,
"patternProperties": {
"[0-9]+": {
"type": "string"
}
},
"title": "Filter",
"type": "object"
},
"StatusGood": {
"description": "All values that are mapped to status 'Good'. Multiple statuses can be configured using semicolon separated values",
"id": "/properties/StatusGood",
"order": 3,
"title": "StatusGood",
"type": "string"
},
"TagsInCSV": {
"additionalProperties": false,
"default": {},
"description": "An optional json configuration to add values from a certain column index (starts from 0) to a tag. Mutiple mappings can be foreseen using one column index and one tag name. Use {} to leave empty.",
"examples": [
"{\"1\":\"tagName\"}"
],
"id": "/properties/TagsInCSV",
"minProperties": 0,
"order": 5,
"patternProperties": {
"[0-9]+": {
"type": "string"
}
},
"title": "TagsInCSV",
"type": "object"
},
"TimestampLayout": {
"description": "The layout of the timestamp, default the TimestampLayout setting on the collector will be used. More info: https://pkg.go.dev/time#Layout",
"id": "/properties/TimestampLayout",
"order": 4,
"title": "TimestampLayout",
"type": "string"
},
"ValueColumn": {
"default": 2,
"description": "Index of column holding the value (starts from 0)",
"id": "/properties/ValueColumn",
"order": 1,
"title": "ValueColumn",
"type": "integer"
}
},
"required": [
"ValueColumn"
],
"type": "object"
},
"SettingsSchema": {
"$id": "http://factry.io/collectorsettings.json",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {},
"properties": {
"AlternativeTimezone": {
"$id": "/properties/AlternativeTimezone",
"description": "This changes the timestamp of points, statistics and logs to the machine local timezone, strips off the timezone and indicates the timezone to be the alternative timezone. The timezone name is taken from the IANA Time Zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
"isAdvanced": true,
"order": 14,
"title": "AlternativeTimezone",
"type": "string"
},
"BasePath": {
"description": "Default directory where the incoming, processed and error directories are in. By default these directory names are respectively, incoming, processed and error. Paths are absolute. Add a trailing forward slash for linux or a trailing backslash for windows",
"id": "/properties/BasePath",
"order": 201,
"title": "BasePath",
"type": "string"
},
"BufferDiskBatches": {
"$id": "/properties/BufferDiskBatches",
"default": 100,
"description": "The maximum amount of batches that will be written to a buffer file.",
"isAdvanced": true,
"order": 8,
"title": "BufferDiskBatches",
"type": "integer"
},
"BufferMaxBatchSize": {
"$id": "/properties/BufferMaxBatchSize",
"default": 5000,
"description": "The maximum size of a batch.",
"isAdvanced": true,
"order": 6,
"title": "BufferMaxBatchSize",
"type": "integer"
},
"BufferMaxBatches": {
"$id": "/properties/BufferMaxBatches",
"default": 20,
"description": "The maximum amount of batches the buffer will keep in memory.",
"isAdvanced": true,
"order": 7,
"title": "BufferMaxBatches",
"type": "integer"
},
"BufferMaxDiskSpace": {
"$id": "/properties/BufferMaxDiskSpace",
"default": "0MB",
"description": "The maximum disk space that the buffer files may take up. Default no limit.",
"isAdvanced": true,
"order": 10,
"pattern": "[0-9]+(T|G|M|K)?B",
"title": "BufferMaxDiskSpace",
"type": "string"
},
"BufferMinFreeDiskSpace": {
"$id": "/properties/BufferMinFreeDiskSpace",
"default": "2GB",
"description": "The buffer wont write to more files if the minimum free disk space is reached.",
"isAdvanced": true,
"order": 9,
"pattern": "[0-9]+(T|G|M|K)?B",
"title": "BufferMinFreeDiskSpace",
"type": "string"
},
"BufferProcessInterval": {
"$id": "/properties/BufferProcessInterval",
"default": 250,
"description": "The interval in milliseconds that the buffer processes the buffer.",
"isAdvanced": true,
"minimum": 250,
"order": 5,
"title": "BufferProcessInterval",
"type": "integer"
},
"CSVHeader": {
"default": "false",
"description": "Indicates if there is a header in the csv files.",
"enum": [
"true",
"false"
],
"id": "/properties/CSVHeader",
"order": 107,
"title": "CSVHeader",
"type": "string"
},
"CompressionLevel": {
"$id": "/properties/CompressionLevel",
"default": -1,
"description": "The compression level GRPC uses, for default compression. 1-9: 1 = fastest, 9 = most compressed, -1 = default.",
"isAdvanced": true,
"maximum": 9,
"minimum": -1,
"order": 12,
"title": "CompressionLevel",
"type": "integer"
},
"Delimiter": {
"default": ",",
"description": "The delimiter used in the csv file.",
"id": "/properties/Delimiter",
"order": 106,
"title": "Delimiter",
"type": "string"
},
"ErrorDirectoryPath": {
"description": "Override directory in which files that contained an error will be put. Invalid CSV files will be stored here",
"id": "/properties/ErrorDirectoryPath",
"order": 204,
"title": "ErrorDirectoryPath",
"type": "string"
},
"FailedMaxAge": {
"default": 129600,
"description": "The maximum time in minutes to keep failed files. 0 will keep the files indefinitely",
"id": "/properties/FailedMaxAge",
"isAdvanced": true,
"order": 216,
"title": "FailedMaxAge",
"type": "integer"
},
"FileMask": {
"default": "*.csv",
"description": "File mask of the files to use",
"id": "/properties/FileMask",
"order": 205,
"pattern": "\\*\\.*[a-z]",
"title": "FileMask",
"type": "string"
},
"GRPCMaxMessageSize": {
"$id": "/properties/GRPCMaxMessageSize",
"default": "64MB",
"description": "The maximum message size for GRPC messages.",
"isAdvanced": true,
"order": 13,
"pattern": "[0-9]+(T|G|M|K)?B",
"title": "GRPCMaxMessageSize",
"type": "string"
},
"HAPollingInterval": {
"$id": "/properties/HAPollingInterval",
"default": 1000,
"description": "The interval in milliseconds at which the backup collector polls the main collector's health.",
"isAdvanced": true,
"order": 11,
"title": "HAPollingInterval",
"type": "integer"
},
"IncomingDirectoryPath": {
"description": "Override directory to monitor for files matching FileMask. Paths are absolute",
"id": "/properties/IncomingDirectoryPath",
"order": 202,
"title": "IncomingDirectoryPath",
"type": "string"
},
"LogLevel": {
"$id": "/properties/LogLevel",
"default": "info",
"description": "The log level of the collector.",
"enum": [
"trace",
"debug",
"info"
],
"isAdvanced": true,
"order": 1,
"title": "LogLevel",
"type": "string"
},
"ProcessDelay": {
"default": 3000,
"description": "Delay in milliseconds for processing new files after they were detected",
"id": "/properties/ProcessDelay",
"isAdvanced": true,
"order": 213,
"title": "ProcessDelay",
"type": "integer"
},
"ProcessInterval": {
"default": 10000,
"description": "Interval in milliseconds in which the incoming directory is checked for new files",
"id": "/properties/ProcessInterval",
"isAdvanced": true,
"order": 212,
"title": "ProcessInterval",
"type": "integer"
},
"ProcessedDirectoryPath": {
"description": "Override directory to which successfully processed files are moved. Paths are absolute",
"id": "/properties/ProcessedDirectoryPath",
"order": 203,
"title": "ProcessedDirectoryPath",
"type": "string"
},
"ProcessedMaxAge": {
"default": 43200,
"description": "The maximum time in minutes to keep processed files. 0 will keep the files indefinitely",
"id": "/properties/ProcessedMaxAge",
"isAdvanced": true,
"order": 215,
"title": "ProcessedMaxAge",
"type": "integer"
},
"SourceTimezone": {
"$id": "/properties/SourceTimezone",
"description": "This changes the timestamp of points by stripping off the timezone from the timestamp and indicating the timezone to be the source timezone (f.e. 0h UTC -> 0h UTC+2). Do not use if the points could come from different source devices (f.e. polling vs monitored), since these source devices can have different time settings! The timezone name is taken from the IANA Time Zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
"isAdvanced": true,
"order": 15,
"title": "SourceTimezone",
"type": "string"
},
"StartupDelay": {
"default": 9000,
"description": "Initial delay for checking the incoming directory in milliseconds",
"id": "/properties/StartupDelay",
"isAdvanced": true,
"order": 214,
"title": "StartupDelay",
"type": "integer"
},
"StatusColumn": {
"description": "Index of column holding the status (starts from 0)",
"id": "/properties/StatusColumn",
"order": 110,
"pattern": "[0-9]*",
"title": "StatusColumn",
"type": "string"
},
"StatusGood": {
"$id": "/properties/StatusGood",
"description": "A comma separated list of status strings that will be interpreted as a Good status.",
"isAdvanced": true,
"order": 16,
"title": "StatusGood",
"type": "string"
},
"TickerInterval": {
"$id": "/properties/TickerInterval",
"default": 1000,
"description": "The interval for the base ticker in milliseconds. This ticker is used for the polling of measurements.",
"isAdvanced": true,
"minimum": 250,
"order": 2,
"title": "TickerInterval",
"type": "integer"
},
"TickerMaxDrift": {
"$id": "/properties/TickerMaxDrift",
"default": 125,
"description": "The maximum drift a tick may have in milliseconds. Must be lower than the interval.",
"isAdvanced": true,
"order": 4,
"title": "TickerMaxDrift",
"type": "integer"
},
"TickerResolution": {
"$id": "/properties/TickerResolution",
"default": 25,
"description": "The resolution for the base ticker in milliseconds. Maximum 1/10th of the the interval.",
"isAdvanced": true,
"minimum": 2,
"order": 3,
"title": "TickerResolution",
"type": "integer"
},
"TimestampColumn": {
"default": 1,
"description": "Index of column holding the timestamp (starts from 0)",
"id": "/properties/TimestampColumn",
"order": 108,
"title": "TimestampColumn",
"type": "integer"
},
"TimestampLayout": {
"description": "The layout of the timestamp of the measurements, default RFC3339 will be used. More info: https://pkg.go.dev/time#Layout",
"id": "/properties/TimestampLayout",
"order": 109,
"title": "TimestampLayout",
"type": "string"
},
"TrimString": {
"description": "The string to trim (leading and trailing) from the csv cells used (values, mappings, status, ...)",
"id": "/properties/TrimString",
"order": 111,
"title": "TrimString",
"type": "string"
}
},
"required": [
"TimestampColumn",
"Delimiter",
"CSVHeader",
"BasePath",
"FileMask"
],
"type": "object"
},
"State": {},
"Health": {
"Health": "Collecting",
"Timestamp": "2025-09-18T18:21:48.821003Z",
"CollectorUUID": "2369d6fe-94bc-11f0-acc7-a25bd411a45c"
},
"LastSeen": "2025-09-18T18:21:53.79472347Z",
"IPAddress": "134.209.86.11:41496",
"HAUUID": null,
"DefaultDatabaseUUID": null,
"UpdateCollectorTo": null
}
]