Skip to content

Core Data - Configuration

Please refer to the general Common Configuration documentation for configuration settings common to all services. Below are only the additional settings and sections that are specific to Core Data.

Edgex 3.0

For EdgeX 3.0 the MessageQueue configuration has been moved to MessageBus in Common Configuration

Property Default Value Description
Writable properties can be set and will dynamically take effect without service restart
LogLevel INFO log entry severity level. Log entries not of the default level or higher are ignored.
PersistData true When true, core data persists all sensor data sent to it in its associated database
Property Default Value Description
See Writable.Telemetry at Common Configuration for the Telemetry configuration common to all services
Metrics Service metrics that Core Data collects. Boolean value indicates if reporting of the metric is enabled.
Metrics.EventsPersisted false Enable/Disable reporting of number of events persisted.
Metrics.ReadingsPersisted false Enable/Disable reporting of number of readings persisted.
Tags <empty> List of arbitrary Core Data service level tags to be included with every metric that is reported.
Property Default Value Description
Unique settings for Core Data. The common settings can be found at Common Configuration
Port 59880 Micro service port number
StartupMsg This is the EdgeX Core Data Microservice Message logged when service completes bootstrap start-up
Property Default Value Description
Unique settings for Core Data. The common settings can be found at Common Configuration
Name coredata Database or document store name
Property Default Value Description
Unique settings for Core Data. The common settings can be found at Common Configuration
ClientId "core-data Id used when connecting to MQTT or NATS base MessageBus
Property Default Value Description
MaxEventSize 25000 maximum event size in kilobytes accepted via REST or MessageBus. 0 represents default to system max.
Property Default Value Description
Enabled false Enable or disable data retention.
Interval 30s Purging interval defines when the database should be rid of readings above the MaxCap.
MaxCap 10000 The maximum capacity defines where the high watermark of readings should be detected for purging the amount of the reading to the minimum capacity.
MinCap 8000 The minimum capacity defines where the total count of readings should be returned to during purging.

V3 Configuration Migration Guide

No configuration updated

See Common Configuration Reference for complete details on common configuration changes.