Updated 91_version_history file for 2.2.0 release #1205
Conversation
Signed-off-by: Mohit Singh Tomar <[email protected]>
docs/91_version_history.rst
Outdated
| - A number of optimisations to the SQLite in-memory storage plugin and the SQLiteLB storage plugin have been added that increase the rate at which readings can be stored with these plugins. | ||
| - Changes have been made to the purge process in the sqlitelb and sqlite-in-memory plugins in order to improve performance. | ||
| - The SQLite storage plugins have been updated to improve the error reporting around database contention issues. | ||
| - The default interval for running the purge process has been reduced, the purge process will not run every 5 minutes. This change only affects new installations, the purge process will run as before on systems that are upgraded. |
There was a problem hiding this comment.
Both of these sentences are too long. They would be better if you started new sentences where the commas are now. I don't understand the meaning of "the purge process will not run every 5 minutes." Would it not be better to document the frequency the purge process does run at?
There was a problem hiding this comment.
Previous versions are having its schedule interval evey hour. And now on fresh/vanilla systems it should have default 10 mins. We need to update the sentence to avoid confusion.
docs/91_version_history.rst
Outdated
| - A number of changes have been made to improve the performance of sending data north from the system. | ||
| - The performance of the statistics history task has been improved. It now makes fewer calls to the storage subsystem, improving the overall system performance. | ||
| - Changes have been made to the purge process in the sqlitelb and sqliteinmemory plugins in order to improve performance. | ||
| - The public API has been updated to include the ability to make control requests via the public API. |
There was a problem hiding this comment.
"The public API" appears at both the beginning and end of this sentence. It would be sufficient to end the sentence at "... to make control requests."
docs/91_version_history.rst
Outdated
| - The public API of the system has been updated to allow selection of readings from the storage buffer for given time intervals. | ||
| - New public API Entry Points have been added to allow for the creation and manipulation of control pipelines. | ||
| - The public API that is used to retrieve reading data from the storage layer has been updated to allow data for multiple assets to be retrieved in a single call. | ||
| - The ingestion of data from asynchronous south service paid no attention to the advanced configuration option "Throttle". This meant that very fast asynchronous south plugins could build extremely large queues of data within the south service, using system resources and taking a long time to shutdown. This has now been rectified, with asynchronous south services now subject to flow control if the "Throttle" option is set for the service. Unconstrained input is still available if the "Throttle" option is not checked. |
There was a problem hiding this comment.
Should be "The ingestion of data from asynchronous south services..." (that is, "services" instead of "service")
docs/91_version_history.rst
Outdated
| - The south plugin now supports three different modes of polling. Polling at fixed intervals from the time started, polling at fixed times or polling on demand via the control mechanisms. | ||
| - Support has been added to allow filters to ingest pass data onwards during a shutdown of the filter. This allows any buffered data to be flushed to the next filter in the pipeline. |
There was a problem hiding this comment.
"...ingest pass data..." -> "ingest passed data" (?)
docs/91_version_history.rst
Outdated
| - The south plugin now supports three different modes of polling. Polling at fixed intervals from the time started, polling at fixed times or polling on demand via the control mechanisms. | ||
| - Support has been added to allow filters to ingest pass data onwards during a shutdown of the filter. This allows any buffered data to be flushed to the next filter in the pipeline. | ||
| - A security vulnerability in one of the PIP packages used by some of the Python components used by the system. |
There was a problem hiding this comment.
Need a verb. Do you mean "A security vulnerability in one of the PIP packages used by some of the Python components has been found?"
There was a problem hiding this comment.
This has not been updated.
docs/91_version_history.rst
Outdated
| - A problem with incorrect timestamps in the readings graphs when the timezone of the machine was something other than UTC has been resolved. | ||
| - A number of inconsistencies in the timezone returned by API calls have been resolved. All API calls should return timestamps in the UTC timezone unless a timezones explicitly included in the response. |
There was a problem hiding this comment.
I think the end of the sentence should read "...in the UTC timezone unless a timezone is explicitly included in the response."
docs/91_version_history.rst
Outdated
| - An issue with the code update mechanism that could cause multiple updates to occur has been resolved. Only a single update should be executed and then the flag allowing for updates to be applied should be removed. This prevents the update mechanism triggering on each restart of the system. | ||
| - A problem that prevented the modbusC south plugin from being updated in the same way as other plugins has been resolved. | ||
| - The command line interface to view the status of the system has been updated to correctly show the statistics history collection task when it is running. | ||
| - When switch a south plugin from a slow poll rate to a faster one the new poll rate does not take effect until the en dot the current poll cycle. This could be a very long time, this has now been changed such that the south service will take the new poll rate as soon as possible rather than wait for the endow the current poll cycle. | ||
| - When switching a south plugin from a slow poll rate to a faster one the new poll rate does not take effect until the end of the current poll cycle. This could be a very long time, this has now been changed such that the south service will take the new poll rate as soon as possible rather than wait for the end of the current poll cycle. |
There was a problem hiding this comment.
The sentence "This could be a very long time, this has now been changed such that the south service will take the new poll rate as soon as possible rather than wait for the end of the current poll cycle" should be split into 2 sentences at the comma. It would also be better to change "has been changed such that" to "has been changed so that."
There was a problem hiding this comment.
This sentence still needs to be split into two at the comma.
docs/91_version_history.rst
Outdated
| - The command line interface to view the status of the system has been updated to correctly show the statistics history collection task when it is running. | ||
| - When switch a south plugin from a slow poll rate to a faster one the new poll rate does not take effect until the en dot the current poll cycle. This could be a very long time, this has now been changed such that the south service will take the new poll rate as soon as possible rather than wait for the endow the current poll cycle. | ||
| - When switching a south plugin from a slow poll rate to a faster one the new poll rate does not take effect until the end of the current poll cycle. This could be a very long time, this has now been changed such that the south service will take the new poll rate as soon as possible rather than wait for the end of the current poll cycle. | ||
| - A bug that prevents notification rules being executed for readings with asset codes starting with numeric values has been resolved. |
There was a problem hiding this comment.
"A bug that prevents notification rules from being executed for readings with asset codes starting with numeric values has been resolved."
docs/91_version_history.rst
Outdated
| - The date format has been made more flexible in the asset and readings graph. | ||
| - A new user interface option has been added to the control menu to create control pipelines. | ||
| - The user interface has been updated such that if the backend system is not available then the user interface components are made insensitive. |
There was a problem hiding this comment.
"...user interface components are made insensitive." What does insensitive mean in this context? Grayed out? Case insensitive?
There was a problem hiding this comment.
This has not been updated.
docs/91_version_history.rst
Outdated
| - The documentation for the asset filter has been improved to include more examples and explanation for the various uses of the plugin and to include all the different operations that can be performed with the filter. | ||
| - The PI Server south plugin now allows the Asset Framework location to be added as a datapoint. This can then be used in the OMFHint filter to create the location in the destination PI server or otters north destination for the data. If going to another PI server the macro substitution feature that has been added to the OMF Hint filter can be used. | ||
| - The OMF north plugin has been updated to make an additional test for the server hostname when it is configured. This will give clearer feedback in the error log if a bad hostname is entered or the hostname can not be resolved. This will also confirm that IP addresses entered are in the correct format. | ||
| - There have been improvements to the OMF north plugin to prevent an issue that could cause the plugging to stop sending data if the type of an individual datapoint changed repeatedly between integer and floating point values. The logging of the plugin has also been improved, with clearing messages and less repetition of error conditions that persist for long periods. |
There was a problem hiding this comment.
First sentence: plugging -> plugin. Last sentence: clearing -> clearer.
docs/91_version_history.rst
Outdated
| - Notifications can now register for audit log entries to be sent to notification rules. This allows notification to be made based on internal state changes of the system. | ||
| - The north opcuaclient has been updated to support multiple values in a single write. | ||
| - The north opcuaclient plugin has been updated to support security mode and security policy. |
There was a problem hiding this comment.
I would mention OPC UA here, as in "to support OPC UA security modes and security policies." There are more than one of each so I made them plural.
docs/91_version_history.rst
Outdated
| - The average and watchdog rules have been updated to allow selection of data sources other than the readings to be sent to the rules. | ||
| - The email notification plugin has been updated to allow custom alert messages to be created. | ||
| - The email notification delivery plugin has been updated to hide the password from view. | ||
| - Some devices were not compatible with the optimized block reading of registers performed by the ModbusC south plugin. The ModbusC plugin has been updated to provide controls that can determine how it reads data from the modus device. This allows single register reads, single object reads and the current optimized block reads. |
There was a problem hiding this comment.
Typo: modus device -> modbus device.
docs/91_version_history.rst
Outdated
| - Some devices were not compatible with the optimized block reading of registers performed by the ModbusC south plugin. The ModbusC plugin has been updated to provide controls that can determine how it reads data from the modus device. This allows single register reads, single object reads and the current optimized block reads. | ||
| - The S2OPCUA South plugin now supports an optional datapoint in its Readings that shows the full path of the OPC UA Variable in the server's namespace. | ||
| - The option to configure and use a username and password for authentication to the MQTT broker has been added to the fledge-south-mqtt plugin. | ||
| - A set of Jiras has been created for the S2OPCUA South plugin to fully incorporate all unique features of the FreeOPCUA South plugin. |
There was a problem hiding this comment.
I don't think this item should be in the public release notes document at all. This was just for us to itemize how much would be needed to allow S2OPCUA to be our only OPC UA south plugin.
docs/91_version_history.rst
Outdated
| @@ -385,7 +343,7 @@ Release Date: 2022-09-09 | |||
| - When the data stream from a south plugin included an OMF Hint of AFLocation, performance of the OMF North plugin would degrade. In addition, process memory would grow over time. These issues have been fixed. | |||
| - The version of the PostgreSQL database used by the Postgres storage plugin has been updated to PostgreSQL 13. | |||
| - An enhancement has been added to the North service to allow the user to specify the block size to use when sending data to the plugin. This helps tune the north services and is described in the tuning guide within the documentation. | |||
| - The notification server would previously output warning messages when it was starting, these were not an indication of a problem and should have been information messages. This has now been resolved. | |||
| - The notification service would previously output warning messages when it was starting, these were not an indication of a problem and should have been information messages. This has now been resolved. | |||
There was a problem hiding this comment.
Split the first sentence into two at the comma.
There was a problem hiding this comment.
This has not been updated.
There was a problem hiding this comment.
I believe we should categorise more in appropriate way:
a) group the related items.
For example: New Feature section should have in some order with group
i) new support
ii) optimisations
iii) performance
iv) documentation related; though documentation should have separate section
b) keep documentation related changes at the bottom of each section; though it should have separate sub section
c) For plugins and service - we should give the package name instead of plugin name
For example - A fixes have been made for http north plugin. As we have two versions of http. So we need to be specific.
d) Also I see there are some fixes/improvements have been made for the same plugin and that is used with 2-3 separate points. We should try to club/combine into one.
docs/91_version_history.rst
Outdated
| @@ -35,229 +35,186 @@ Release Date: 2023-10-17 | |||
| - New Features: | |||
|
|
|||
| - New performance monitors have been added to the north service and the running guide updated to discuss how these can be used. | |||
There was a problem hiding this comment.
Performance monitoring added for this version only and exist for both South & North services. Therefore wording needs to be changed here.
docs/91_version_history.rst
Outdated
| - The support bundle creation process has been updated to include any performance counters available in the system. | ||
| - The ability to monitor performance counters has been added to Fledge. Currently only south services offer performance counters that can be captured by the system. These are designed to provide information useful for tuning the south service. | ||
| - The asset tracker component has been optimized in order to improve the ingress and egress performance of Fledge |
There was a problem hiding this comment.
end the sentence with a period (.)
docs/91_version_history.rst
Outdated
| - The SQLite In-Memory storage plugin now has an option that allows the data to be persisted when shutting the system down and reloaded on startup. | ||
| - A number of optimisations to the SQLite in-memory storage plugin and the SQLiteLB storage plugin have been added that increase the rate at which readings can be stored with these plugins. | ||
| - Changes have been made to the purge process in the sqlitelb and sqlite-in-memory plugins in order to improve performance. |
There was a problem hiding this comment.
We should be consistent for the terms SQLite in-memory, SQLiteLB
docs/91_version_history.rst
Outdated
| - A number of optimisations to the SQLite in-memory storage plugin and the SQLiteLB storage plugin have been added that increase the rate at which readings can be stored with these plugins. | ||
| - Changes have been made to the purge process in the sqlitelb and sqlite-in-memory plugins in order to improve performance. | ||
| - The SQLite storage plugins have been updated to improve the error reporting around database contention issues. | ||
| - The default interval for running the purge process has been reduced, the purge process will not run every 5 minutes. This change only affects new installations, the purge process will run as before on systems that are upgraded. |
There was a problem hiding this comment.
Previous versions are having its schedule interval evey hour. And now on fresh/vanilla systems it should have default 10 mins. We need to update the sentence to avoid confusion.
docs/91_version_history.rst
Outdated
| - The south plugin now supports three different modes of polling. Polling at fixed intervals from the time started, polling at fixed times or polling on demand via the control mechanisms. | ||
| - Support has been added to allow filters to ingest pass data onwards during a shutdown of the filter. This allows any buffered data to be flushed to the next filter in the pipeline. | ||
| - A security vulnerability in one of the PIP packages used by some of the Python components used by the system. | ||
| - The format of Python back traces has been improved to use multiple lines within the log. This makes the trace easier to understand and prevents the truncation that can occur. |
docs/91_version_history.rst
Outdated
| - Some devices were not compatible with the optimized block reading of registers performed by the ModbusC south plugin. The ModbusC plugin has been updated to provide controls that can determine how it reads data from the modus device. This allows single register reads, single object reads and the current optimized block reads. | ||
| - The S2OPCUA South plugin now supports an optional datapoint in its Readings that shows the full path of the OPC UA Variable in the server's namespace. | ||
| - The option to configure and use a username and password for authentication to the MQTT broker has been added to the fledge-south-mqtt plugin. | ||
| - A set of Jiras has been created for the S2OPCUA South plugin to fully incorporate all unique features of the FreeOPCUA South plugin. |
| - The S2OPCUA South plugin now supports an optional datapoint in its Readings that shows the full path of the OPC UA Variable in the server's namespace. | ||
| - The option to configure and use a username and password for authentication to the MQTT broker has been added to the fledge-south-mqtt plugin. | ||
| - A set of Jiras has been created for the S2OPCUA South plugin to fully incorporate all unique features of the FreeOPCUA South plugin. | ||
| - The North service could crash if it retrieved invalid JSON while processing a reconfiguration request. This was addressed by adding an exception handler to prevent the crash. |
There was a problem hiding this comment.
Move to Core-> Bug Fix section
docs/91_version_history.rst
Outdated
| - A problem with the J1708 & J1939 plugins that cased them to fail if added disabled and then later enabling them has been resolved. | ||
| - The HTTP North C plugin now supports sending audit log data as well as readings and statistics. | ||
| - A problem that caused the Azure IoT Core north plugin to fail to send data has been corrected. | ||
| - The control map configuration item of the Modbus C plugin was incorrectly described, this has now been resolved. | ||
| - A product version check was made incorrectly if the OMF endpoint type was not PI Web API. This has been fixed. | ||
| - The OMF North plugin that is used to send Data a to the AVEVA PI Server has been updated to improve the performance of the plugin. |
There was a problem hiding this comment.
send Data to the AVEVA....
docs/91_version_history.rst
Outdated
| - The north OPCUA client plugin has been updated to support higher data transfer rates. | ||
| - The Fledge S2OPCUA South plugin has been updated to support large numbers of Monitored Items. |
docs/91_version_history.rst
Outdated
| - An issue that prevented the installation of the person detection plugin on Ubuntu 20 has been resolved. | ||
| - The control map configuration item of the Modbus C plugin was incorrectly described, this has now been resolved. | ||
| - The threshold filter interface has been tidied up, removing duplicate information. | ||
| - The HTTP North C plugin now supports sending audit log data as well as readings and statistics. |
Signed-off-by: Mohit Singh Tomar <[email protected]>
Signed-off-by: Mohit Singh Tomar <[email protected]>
Signed-off-by: Praveen Garg <[email protected]>
Signed-off-by: Praveen Garg <[email protected]>
No description provided.