-
Notifications
You must be signed in to change notification settings - Fork 1
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
Add Support Bundle "Download Logs" docs #442
Merged
+123
−10
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
5260f2c
Update admin-settings.md
alexanderahn 471aa85
Create download-logs.md
alexanderahn 9a8354a
Merge branch 'main' into support-bundle
alexanderahn fffec6b
Update admin-settings.md
alexanderahn 220e560
Merge branch 'support-bundle' of https://github.com/SimpleDataLabsInc…
alexanderahn 79a4470
Update download-logs.md
alexanderahn 1dba33d
Update download-logs.md
alexanderahn f82b013
Merge branch 'main' into support-bundle
alexanderahn 12f73e1
Merge branch 'main' into support-bundle
alexanderahn 2d42457
Add enable logs steps
alexanderahn 5ff9dd7
Merge branch 'support-bundle' of https://github.com/SimpleDataLabsInc…
alexanderahn 208cdea
Reorder pages
alexanderahn 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 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
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
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
113 changes: 113 additions & 0 deletions
113
docs/architecture/deployment/private-saas/download-logs.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,113 @@ | ||
--- | ||
title: Download logs | ||
id: download-logs | ||
description: Download Prophecy support logs | ||
sidebar_position: 3 | ||
tags: | ||
- download | ||
- support logs | ||
--- | ||
|
||
As an admin user, you can download your environment logs from Prophecy without needing access to your Prophecy cluster or the assistance of Prophecy Support. This reduces the delay in debugging any issues with your Prophecy services. | ||
|
||
## Use case | ||
|
||
- The overarching objective is to debug what is going on with your Prophecy services. | ||
- To achieve this, we've enabled admins to be able to download Prophecy logs and environment information so that they can upload them to Zendesk. | ||
|
||
### Download logs features | ||
|
||
You can use the Download Logs feature to capture logs using the Services and time selectors. | ||
|
||
- All services are selected by default. | ||
- The download supports one hour of logs from the Start Time. | ||
|
||
The captured logs include all relevant Prophecy configurations, such as the following items: | ||
|
||
- Kubernetes cluster configuration | ||
- Resource quotas | ||
- Node configuration | ||
- Cluster custom resources | ||
- Config maps and files | ||
- Resource consumption logs | ||
|
||
:::note | ||
|
||
Sensitive information, such as customer preview data, credentials, tokens, or passwords, is scrubbed or redacted from the download bundle. | ||
|
||
::: | ||
|
||
## Enable Prophecy Downloads logs | ||
|
||
Before you can download logs, you must enable it in your private SAAS deployment. | ||
|
||
See the following requirements for enabling the Prophecy logs: | ||
|
||
- Prophecy collects the logs of all pods and stores it in the Athena Pod. | ||
- Each pod uses an additional 500 MB ephemeral storage for temporary storage. | ||
- Athena requires additional storage of around 100 GB to store one week of logs. | ||
- A new container image fluentbit (`gcr.io/prophecy-share/fluent-bit:2.2.3`) is required for this feature. | ||
|
||
To enable Minio in Athena and provide it a volume, follow these steps: | ||
|
||
1. Add env variables to Athena STS: | ||
|
||
``` | ||
- name: MINIO_ENDPOINT | ||
value: athena:9000 | ||
- name: ENABLE_FLUENTBIT_SIDECARS | ||
value: "true" | ||
- name: RUN_ATHENA_MINIO | ||
value: "true" | ||
``` | ||
|
||
2. Add volume to Athena STS: | ||
|
||
``` | ||
volumeClaimTemplates: | ||
... | ||
- apiVersion: v1 | ||
kind: PersistentVolumeClaim | ||
metadata: | ||
creationTimestamp: null | ||
name: minio-storage | ||
spec: | ||
accessModes: | ||
- ReadWriteOnce | ||
resources: | ||
requests: | ||
storage: 10Gi | ||
volumeMode: Filesystem | ||
``` | ||
|
||
3. Add volume mount to Athena: | ||
|
||
``` | ||
volumeMounts: | ||
... | ||
- mountPath: /minio/data | ||
name: minio-storage | ||
``` | ||
|
||
4. Add the Minio port to Athena SVC: | ||
|
||
``` | ||
ports: | ||
... | ||
- name: minio | ||
port: 9000 | ||
protocol: TCP | ||
targetPort: 9000 | ||
``` | ||
|
||
## Navigate to the Download logs UI | ||
|
||
To download logs in the Prophecy UI, follow these steps: | ||
|
||
1. Log in to the Prophecy UI as an admin user. | ||
1. Click on the **three dots** at the bottom left corner and select the **Settings** icon from the submenu. | ||
1. Navigate to the **Admin** main tab. | ||
1. Within the Admin main tab, access the **Logs** sub tab. | ||
1. Set the **Services** and **Start Date/Time**, and then click **Download** | ||
|
||
After several seconds, the file will download via your browser. The download generates a compressed file containing logs, suitable for sharing with a Prophecy support engineer. |
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
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
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.
we have some pre-requisite for enabling this feature for private SAAS: documented here : https://coda.io/d/Cloud_dptsTdZM0LD/Setting-up-prophecy-log-download-options_suDxgcHw#_luDrg_xx
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.
Done.