Various documentation updates #80
Draft
Conversation
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
richturner
changed the title
|
Is there a reason why this is still a draft PR @richturner? |
|
Hey @wborn I want to add some additional info about the dashboard and want to combine it with any changes I make in openremote/openremote#1853 |
ebariaux
reviewed
Jun 27, 2025
| @@ -0,0 +1,65 @@ | |||
| # Metrics | |||
|
|
|||
| Prometheus formatted metrics endpoints can be configured for each container (including the OpenRemote Manager), you will either need Prometheus server running to scrape these endpoints or use a cloud provider service; here's an example using AWs Cloudwatch: | |||
There was a problem hiding this comment.
Suggested change
| Prometheus formatted metrics endpoints can be configured for each container (including the OpenRemote Manager), you will either need Prometheus server running to scrape these endpoints or use a cloud provider service; here's an example using AWs Cloudwatch: | |
| Prometheus formatted metrics endpoints can be configured for each container (including the OpenRemote Manager), you will either need Prometheus server running to scrape these endpoints or use a cloud provider service; here's an example using AWS Cloudwatch: |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation with new content for monitoring metrics and enhances the backup/restore instructions for the OpenRemote database.
- Added a comprehensive metrics table for various container components in the user guide
- Enhanced backup instructions with additional options and removed outdated steps in the developer guide
- Introduced a new Bash section demonstrating how to set up an SSH tunnel for accessing HAProxy stats
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/user-guide/metrics.md | New documentation presenting container metrics including detailed tables |
| docs/developer-guide/useful-commands-and-queries.md | Updated backup/restore commands and added a Bash section for SSH tunnel guidance |
Comment on lines
+3
to
+6
| Prometheus formatted metrics endpoints can be configured for each container (including the OpenRemote Manager), you will either need Prometheus server running to scrape these endpoints or use a cloud provider service; here's an example using AWs Cloudwatch: | ||
|
|
||
|  | ||
| _Image of metrics endpoints and AWS Cloudwatch configuration_ |
There was a problem hiding this comment.
Typo in 'AWs Cloudwatch': it should be corrected to 'AWS CloudWatch'.
Suggested change
| Prometheus formatted metrics endpoints can be configured for each container (including the OpenRemote Manager), you will either need Prometheus server running to scrape these endpoints or use a cloud provider service; here's an example using AWs Cloudwatch: | |
|  | |
| _Image of metrics endpoints and AWS Cloudwatch configuration_ | |
| Prometheus formatted metrics endpoints can be configured for each container (including the OpenRemote Manager), you will either need Prometheus server running to scrape these endpoints or use a cloud provider service; here's an example using AWS CloudWatch: | |
|  | |
| _Image of metrics endpoints and AWS CloudWatch configuration_ |
Copilot uses AI. Check for mistakes.
| @@ -40,9 +40,10 @@ docker cp <PROJECT_NAME>_postgresql_1:/deployment/datapoints.csv ./ | |||
|
|
|||
| ### Backup/Restore OpenRemote DB | |||
|
|
|||
| * Create backup: `docker exec or-postgresql-1 pg_dump -Fc openremote -f /tmp/db.bak` | |||
| * Create backup: `docker exec or-postgresql-1 pg_dump -Fc openremote -f /tmp/db.bak` (can also be useful to exclude datapoint records from the backup by using this command `docker exec or-postgresql-1 pg_dump -Fc openremote -f /tmp/db.bak --exclude-table-data='_timescaledb_internal._hyper_*'`) | |||
There was a problem hiding this comment.
[nitpick] Consider reformatting this long command description by separating the backup command and the additional exclusion note into distinct bullet points or lines to improve readability.
Suggested change
| * Create backup: `docker exec or-postgresql-1 pg_dump -Fc openremote -f /tmp/db.bak` (can also be useful to exclude datapoint records from the backup by using this command `docker exec or-postgresql-1 pg_dump -Fc openremote -f /tmp/db.bak --exclude-table-data='_timescaledb_internal._hyper_*'`) | |
| * Create backup: `docker exec or-postgresql-1 pg_dump -Fc openremote -f /tmp/db.bak` | |
| * Optional: Exclude datapoint records from the backup using the following command: `docker exec or-postgresql-1 pg_dump -Fc openremote -f /tmp/db.bak --exclude-table-data='_timescaledb_internal._hyper_*'` |
Copilot uses AI. Check for mistakes.
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.
No description provided.