Skip to content

Commit

Permalink
fix: address pr feedback
Browse files Browse the repository at this point in the history
Signed-off-by: Elizabeth J Lee <elizabeth.j.lee@intel.com>
  • Loading branch information
ejlee3 committed Oct 4, 2023
1 parent a51d59c commit 9440ced
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs_src/microservices/core/data/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Below are only the additional settings and sections that are specific to Core Da
| 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 included with every metric that is reported. |
|Tags|`<empty>`|List of arbitrary Core Data service level tags to be included with every metric that is reported. |
=== "Service"
|Property|Default Value|Description|
|---|---|---|
Expand Down
6 changes: 3 additions & 3 deletions docs_src/microservices/core/data/EventsAndReadings.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

Data collected from sensors is marshalled into EdgeX event and reading objects (delivered as JSON objects or a binary object encoded as [CBOR](../../../general/Definitions.md#cbor) to core data).
An event represents a collection of one or more sensor readings.
The number of readings depends on the connected device/sensor.
The number of readings depend on the connected device/sensor.

An event must have at least one reading.
Events are associated with a sensor or device – the “thing” that sensed the environment and produced the readings.
Readings are a component an event. Readings are a simple key/value pair where the key ([ResourceName](../../../general/Definitions.md#resource)) is the metric sensed and the value is the actual data sensed.
Readings are a component of an event. Readings are a simple key/value pair where the key ([ResourceName](../../../general/Definitions.md#resource)) is the metric sensed and the value is the actual data sensed.
A reading may include other bits of information to provide more context (for example, the data type of the value) for the users of that data.
Consumers of the reading data could include things like user interfaces, data visualization systems and analytics tools.
Reading data can be consumed via interfaces, data visualization systems and analytics tools.

!!! example
The event coming from the “motor123” device has two readings (or sensed values).
Expand Down
5 changes: 2 additions & 3 deletions docs_src/microservices/core/data/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ The simplest way to run all the required services is to use the [Compose Builder
4. Remove core-data from the compose file and resolve any depends on for core-data.
5. Run the compsoe file.
```
docker compose -p edgex -f docker-compose.yml up -d
make up
```

This runs, in non-secure mode, all the standard EdgeX services, except for core data, along with the Device Virtual.
Core Data will use the Redis database as its datastore.
This runs, in non-secure mode, all the standard EdgeX services, except for core data, along with the Device Virtual.
4 changes: 2 additions & 2 deletions docs_src/microservices/core/data/Purpose.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Core Data microservice provides a centralized persistence for data collected
Device services that collect sensor data call on the core data service to
store the sensor data on the edge system (such as in a [gateway](../../../general/Definitions.md#gateway)) until the data gets moved "north" and then exported to Enterprise and cloud systems.
Core data persists the data in a local database.
[Redis](https://redis.io/) is used by default, but a database abstraction layer allows for other databases to be used.
[Redis](https://redis.io/) is used by default, but a database abstraction layer allows for other database implementations to be added.

![image](EdgeX_CoreData.png)

Expand All @@ -29,7 +29,7 @@ Sensor data can be sent to core data via two different means:
![image](EdgeX_CoreDataSubscriber.png)

2. Services and systems can call on the core data REST API to send data to core data and have the data put in local storage.
This REST method of sending data to core data is an alternative method to send data to core data.
The REST method is an alternative method to send data to core data.
When data is sent via REST to core data, core data re-publishes the data on to message bus so that other services can subscribe to it.
![image](EdgeX_CoreDataRESTEndpoint.png)

Expand Down
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ nav:
- Configuration: microservices/core/data/Configuration.md
- API Reference: microservices/core/data/APIReference.md
- Source Code: microservices/core/data/SourceCode.md
- Events and Readings: microservices/core/data/EventsAndReadings.md
- Additional Details:
- Events and Readings: microservices/core/data/EventsAndReadings.md
- microservices/core/metadata/Ch-Metadata.md
- microservices/core/command/Ch-Command.md
- microservices/core/database/Ch-Redis.md
Expand Down

0 comments on commit 9440ced

Please sign in to comment.