-
Notifications
You must be signed in to change notification settings - Fork 69
Extend storage integration page content #1434
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
PavelJankoski
wants to merge
2
commits into
master
Choose a base branch
from
doc/storage-integration
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,21 +14,53 @@ The Storage Integration is implemented as an Application Package, and can be ena | |
|
||
## How it works | ||
|
||
The Storage Integration runs on the Application Server and watches for upstream traffic (join requests, data uplink message, data downlink message, etc). When an upstream message is received from an end device for which the integration has been configured, the message data (Payload, FPort, Decoded Fields, as well as all relevant metadata) are written in a persistent database. | ||
The Storage Integration runs on the Application Server and watches for upstream traffic (join requests, data uplink messages, data downlink messages, etc). When an upstream message is received from an end device for which the integration has been configured, the message data (Payload, FPort, Decoded Fields, as well as all relevant metadata) are written to a persistent database. | ||
|
||
Data retention period is 30 days for {{% tts %}} Cloud and 24 hours for {{% ttss %}} distributions. For {{% tts %}} Enterprise distributions, data retention period can be [configured]({{< ref "/integrations/storage/configuration" >}}). | ||
|
||
A gRPC service and an HTTP API are exposed so that stored messages can then be retrieved. | ||
|
||
{{< note >}} {{% tts %}} Cloud stores only uplink messages. {{</ note >}} | ||
{{< note >}} | ||
{{% tts %}} Cloud stores only uplink messages. | ||
{{</ note >}} | ||
|
||
{{< warning >}} | ||
The Storage Integration should not be used for querying realtime data. For scalability reasons, writes to the Storage Integration database are performed in batches and there may be a delay after an uplink is received, before it is available. For realtime alerts, use [Webhooks]({{< ref "integrations/webhooks" >}}). | ||
{{</ warning >}} | ||
|
||
## Typical use cases | ||
--- | ||
|
||
## Viewing stored messages | ||
|
||
The Console offers a view for checking the Storage Integration status and displays recently stored messages. | ||
|
||
{{< figure src="enable/activated-storage-integration.png" alt="Activated storage integration" >}} | ||
|
||
This view allows filtering by end device and time range, and displays stored messages along with decoded payloads and metadata. | ||
|
||
{{< note >}} | ||
For performance reasons, only the first 10 results are shown in the Console. | ||
{{</ note >}} | ||
Comment on lines
+39
to
+43
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please add a screenshot of active data in an application. |
||
|
||
--- | ||
|
||
## Downloading messages | ||
|
||
The Console allows you to download the **messages currently displayed in the table** view. This provides a quick way to extract and inspect recent stored messages. | ||
|
||
{{< figure src="download-stored-messages.png" alt="Download stored messages" >}} | ||
|
||
Click the **Download** button to download the visible messages in one of the following formats: | ||
|
||
- **JSON**: Ideal for programmatic access or integration with other systems. | ||
- **CSV**: Convenient for spreadsheets, quick inspection, or basic analysis. | ||
|
||
--- | ||
|
||
## Typical use cases | ||
|
||
- Long-term storage of historical data for end-devices. | ||
- No need to maintain a connection with {{% tts %}} at all times, e.g. for end devices that send messages infrequently. | ||
- Reliable message persistence for low-frequency or offline-capable devices. | ||
- Decoupled integrations where message delivery doesn't require constant connectivity. | ||
Comment on lines
+63
to
+64
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not sure this is better than what it was. |
||
|
||
Detailed instructions about storage integration are in the topics below. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-107 KB
(71%)
doc/content/integrations/storage/enable/activate-storage-integration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-128 KB
(72%)
doc/content/integrations/storage/enable/activated-storage-integration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This needs to be tagged with to the version where this was implemented
## Viewing stored messages {{< new-in-version "3.34.1">}}