Configuration

DetectMateService can be configured using a YAML settings file or environment variables. Environment variables take precedence over the YAML file.

Service settings

These settings control the service infrastructure.

Setting	Env Variable	Default	Description
component_name	DETECTMATE_COMPONENT_NAME	None	A human-readable name for the service instance.
component_id	DETECTMATE_COMPONENT_ID	None (computed)	Unique identifier for the component; computed automatically if not provided.
component_type	DETECTMATE_COMPONENT_TYPE	core	Python import path for the component class (e.g., detectors.MyDetector).
component_config_class	DETECTMATE_COMPONENT_CONFIG_CLASS	None	Python import path of the configuration class used by the component (e.g., detectors.MyDetectorConfig).
log_level	DETECTMATE_LOG_LEVEL	INFO	Logging level (DEBUG, INFO, WARNING, ERROR).
log_dir	DETECTMATE_LOG_DIR	./logs	Directory for log files.
log_to_console	DETECTMATE_LOG_TO_CONSOLE	true	Whether logs are written to stdout/stderr.
log_to_file	DETECTMATE_LOG_TO_FILE	true	Whether logs are written to files in log_dir.
http_host	DETECTMATE_HTTP_HOST	127.0.0.1	Host address for the HTTP server.
http_port	DETECTMATE_HTTP_PORT	8000	Port for the HTTP server.
manager_recv_timeout	DETECTMATE_MANAGER_RECV_TIMEOUT	100	Receive timeout (ms) for the manager command channel.
manager_thread_join_timeout	DETECTMATE_MANAGER_THREAD_JOIN_TIMEOUT	1.0	Timeout (s) when waiting for the manager thread to stop.
engine_addr	DETECTMATE_ENGINE_ADDR	ipc:///tmp/detectmate.engine.ipc	Address for data processing (PAIR0/1).
engine_autostart	DETECTMATE_ENGINE_AUTOSTART	true	Whether the engine channel is started automatically.
engine_recv_timeout	DETECTMATE_ENGINE_RECV_TIMEOUT	100	Receive timeout (ms) for the engine channel.
out_addr	DETECTMATE_OUT_ADDR	[]	List of output addresses (strongly typed NNG URLs).
out_dial_timeout	DETECTMATE_OUT_DIAL_TIMEOUT	1000	Timeout (ms) for connecting to output addresses.

YAML files

You can provide a YAML file containing the service settings. Below is an example settings.yaml:

component_name: "my-detector"
log_level: "DEBUG"
log_dir: "./logs"

# Manager Interface
http_host: 127.0.0.1
http_port: 8000

# Engine Interface (Data Channel)
engine_addr: "ipc:///tmp/detectmate.engine.ipc"
engine_autostart: true

# Output Destinations (where processed data is sent)
out_addr:
  - "tcp://127.0.0.1:5000"
  - "ipc:///tmp/output.ipc"

out_dial_timeout: 1000

Environment variables

Environment variables override values in the YAML file. They are prefixed with DETECTMATE_.

Example:

export DETECTMATE_LOG_LEVEL=DEBUG
export DETECTMATE_COMPONENT_NAME=worker-1
detectmate start

Component configuration

In addition to the service settings (which configure the runner), you can also pass a separate configuration file for the specific component logic (e.g., detector parameters) using the --config flag in the CLI. This file is specific to the implementation of the component you are running.

Component configuration controls the specific logic of the detector or parser. To support dynamic library loading, this file uses a nested structure. The configuration must be namespaced by the component category (detectors or parsers) and the specific class name to allow the library to correctly route parameters. Example detector_config.yaml

detectors:                 # Category Level
  NewValueDetector:        # Class Name Level
    auto_config: false
    method_type: new_value_detector
    params:                # Implementation Specific Level
      log_variables:
        - id: test
          template: dummy_template
          variables:
            - name: var1
              pos: 0
              params:
                threshold: 0.0

You can read more about Components in the Using a Library Component section.

HTTP Admin Interface

The service provides a REST API for runtime management and monitoring.

Core Endpoints

Method	Endpoint	Description
GET	/admin/status	Returns the health, running state, and current effective configurations.
POST	/admin/start	Starts the data processing engine thread.
POST	/admin/stop	Stops the data processing engine thread.
POST	/admin/reconfigure	Updates component parameters dynamically.
POST	/admin/shutdown	Gracefully terminates the entire service process.