Configure a simulator connector
The features described in this section are currently in beta testing and are subject to change.
Simulator connectors can be downloaded from Data management > Integrate > Extractors in Cognite Data Fusion (CDF). Then search for a connector by name; for example PROSPER.
To configure a simulator connector, you must edit the configuration file. The file is in YAML format, and the sample configuration file contains all valid options with default values. You can exclude fields entirely to let the connector use default values. The configuration file separates settings by component, and you can remove an entire component to disable it or use the default values.
You'll find configuration file examples listed under the config
folder in the directory where the connector is installed.
Don't base your configuration on the config.example.yml
file. Instead, use config.minimal.yml
as your base and copy the parts you need from config.example.yml
.
Using values from environment variables
In the configuration file, values wrapped in ${}
are replaced with environment variables with that name. For example, ${COGNITE_PROJECT}
will be replaced with the value of the environment variable called COGNITE_PROJECT
.
The configuration file also contains the global parameter version
, which holds the version of the configuration schema used in the configuration file. This document describes version 1 of the configuration schema.
You can set up extraction pipelines to use versioned connector configuration files stored in the cloud.
Connector
This section contains information on how the current connector appears in Simulators.
Parameter | Description |
---|---|
connector.name-prefix | Enter the connector name that is registered on the API. |
connector.add-machine-name-suffix | Set to true to have the connector name appear as name@vm-host-name . |
connector.api-logger.enabled | Insert boolean of whether to push logs to CDF or not. The default value is false . |
connector.api-logger.level | Enter the minimum level of logs to push to CDF. Valid values are Information , Debug , Error , and Warning . |
Logger
Log entries are either Fatal
, Error
, Warning
, Information
, Debug
, Verbose
, in order of decreasing importance. Each level covers the ones of higher importance.
Parameter | Description |
---|---|
console | Configuration for logging to the console. |
console.level | Set the minimum level of log events to write to the console. Set this parameter to enable console logging. |
console.stderr-level | Log events at this level or above are redirected to standard error. |
file | Configuration for logging to a rotating log file. |
file.level | Set the minimum level of log events to write to file. |
file.path | Enter the path to the files to be logged. For instance, if this is set to logs/log.txt , logs on the form logs/log[date].txt will be created, depending on rolling-interval . |
file.retention-limit | Set the maximum number of log files that are kept in the log folder. |
file.rolling-interval | Enter a rolling interval for log files as day or hour . The default value is day . |