Skip to content
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
merged 12 commits into from
Nov 26, 2024
53 changes: 53 additions & 0 deletions docs/architecture/deployment/private-saas/download-logs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: Download Logs
id: download-logs
description: Download Prophecy support logs
sidebar_position: 3
tags:
Copy link
Collaborator

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

- 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 Kubernetes services, including sandbox pods.

- Configuration Data Collection:

- Captures Kubernetes cluster configuration, such as resource quotas and node configuration.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we capture prophecy configuration i.e. prophecy CR and config map.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

- Collects Helm charts, deployment manifests, flags, and other configuration files.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

only configuration files.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

- Includes current versions of deployed services and Kubernetes components.

- Environment State Capture:
- Captures pod status, node health checks, and resource allocation across the cluster, such as kubectl describe nodes and kubectl describe pods.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we dont do that in this feature. for that we have health check and monitoring.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

- Includes resource consumption.

:::note

Sensitive information, such as customer preview data, credentials, tokens, or passwords, is scrubbed or redacted from the download bundle.

:::

### Navigating 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.
Loading