[#1498] Provide historical API access functionality for things, policies, connections #1564
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* streaming of journal entries of a given entity (thing/policy) as DittoProtocol events (via Websocket/Connections/SSE) * accessing an entity (thing/policy/connection) "at" a specific revision or "at" a specific timestamp * added a configurable "history-retention-duration" config for things/policies/connections in order to delay the cleanup for at least that amount of time -> that way we can e.g. keep 30d of snapshots/events * made history API work via connectivity * added documentation for history capabilities Signed-off-by: Thomas Jaeckle <thomas.jaeckle@bosch.io>
…ing the status endpoint while still securing the devops endpoint Signed-off-by: Thomas Jaeckle <thomas.jaeckle@bosch.io>
…d" information * and made those queryable with "fields" selector same as for things+policies * made connection a full "Entity" Signed-off-by: Thomas Jaeckle <thomas.jaeckle@bosch.io>
Signed-off-by: Thomas Jaeckle <thomas.jaeckle@bosch.io>
thjaeckle
force-pushed
the
feature/history-api
branch
3 times, most recently
from
6348304
to
63efb2b
Compare
This pull request was closed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR enables "History API" support:
Resolves: #1498
There is a new FeatureToggle in
ditto-devops.confwith keyditto.devops.feature.historical-apis-enabledin order to disable the historical API access.Also, in order to be useful, the "cleanup" of entities has to be configured to have a
history-retention-durationof greater than 0.By default this is configured to
0dwhich means that events and snapshots may be deleted at any time of the cleanup strategy of Ditto decides so.If for example "things" should keep a history of up to one week, the configuration inside
things.confcan be adjusted tohistory-retention-duration = 7d.The added documentation page
basic-history.mddescribes the feature and its configuration in detail.