Add audit log explorer app #45
Open
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
evanRetool
suggested changes
Mar 29, 2023
|
|
||
| ### 0. Make sure you have access! | ||
|
|
||
| You should have the right approvals and know where to look to find the `POSTGRES_HOST`, `POSTGRES_PORT`, `POSTGRES_DB`, `POSTGRES_USER`, `POSTGRES_PASSWORD` environment variables in your deployment configuration. |
There was a problem hiding this comment.
What should the user do if they don't know where to look to find these environment variables?
| 1. Navigate to the `/resources` page in your instance and click "Create a new resource" | ||
| 2. Select Postgres as the resource type | ||
| 3. Name the resource “Retool Audit Log” | ||
| 4. To fill out the following details, depending on your deployment, check your secrets file in your deployment configuration. The relevant environment variables are: |
There was a problem hiding this comment.
Where might the user find the secrets file?
| If the Usage Analytics app doesn't populate with data, it's likely you'll need to update the Resource for each query. | ||
|
|
||
| To update the queries to use the correct Resource, load the Usage Analytics app in editor mode and open the bottom panel to view the queries. Edit each query and select your Retool Postgres database from the Resource dropdown. (Don't forget to save your queries after editing them!) | ||
|
|
There was a problem hiding this comment.
Could you add a section on how the user might start using the app? Are there some common operations they should start with? Also, is there any information we can provide about how to interpret the audit log events?
| @@ -0,0 +1,78 @@ | |||
| # Importable Audit Log Explorer App | |||
There was a problem hiding this comment.
I see a warning in the app about not running large queries due to the potential impact on other users of the instance. I think we should call that out here prominently since users may not click in to see those instructions in the app.
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.
https://demos.retool.dev/apps/App%20Exchange/Audit%20Log%20Explorer