Configuration Reference

Settings for FactoryTX are stored as a JSON-formatted configuration file, factorytx.conf, in the conf.d directory.

The configuration file supports bash-like environment variables for string values.

  • Values such as ${PASSWORD} or ${PREFIX}-name can be configured.

  • If you want to prevent the environment variables from showing up or being stored in the logs, prefix them with ${FTX_CREDS}. For example: ${FTX_CREDS_PASSWORD}

The main sections of a configuration file are:

sight_machine_cloud

The sight_machine_cloud section specifies how to connect to the Sight Machine cloud. These settings are used for both uploading data as well as other features that require cloud connectivity.

{
    "sight_machine_cloud": {
        "base_url": "<URL of your service environment>",
        "api_key_id": "<Your API key ID>",
        "api_key": "<Your API key>"
    }
}

Required fields:

  • base_url: URL of your Service Environment (e.g. https://my-environment.sightmachine.io)

  • api_key_id: Edge API key ID used to connect to the Sight Machine platform

  • api_key: Edge API key used to connect to the Sight Machine platform

To get an api_key and api_key_id for the Sight Machine platform, please refer to the Getting an API key section of the Quickstart guide.

data_receiver

The data_receiver section contains settings for connecting to a data source, reading the input stream, and if necessary, parsing the received data. Settings for a data receiver will vary depending on the protocol of the data receiver.

FactoryTX has a few built-in data receivers available:

For information about available parsers and their configurations, please refer to the Parsers Configurations section.

To create your own custom receiver, please refer to the Creating a custom receiver guide in Tutorials.

transforms

The transforms section contains settings for transforming the records received from the data receivers before passing them to data transmits for upload. Transforms are a receiver-independent way to manipulate and clean data.

FactoryTX has a few built-in transforms ready to be used:

To indicate that no transforms are needed, set transforms to an empty list ([]).

To create your own custom transform, please refer to the Creating a custom transform guide in Tutorials.

data_transmit

The data_transmit section contains settings for transmitting the records to the Sight Machine cloud for storage and consumption.

Currently, FactoryTX has two options for transmitting data: