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

Consolidate spark logs #477

Merged
merged 10 commits into from
Dec 18, 2024
20 changes: 15 additions & 5 deletions docs/getting-started/getting-help/getting-help.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Getting Help with Prophecy
title: Getting help with Prophecy
id: getting-help
sidebar_position: 6
description: Getting Help with Prophecy
description: Getting help with Prophecy
sidebar_label: Getting Help
tags: []
---
Expand All @@ -13,10 +13,20 @@ At Prophecy, we're dedicated to ensuring you have the support you need, whether

- **Get Trial Support in Slack:** Have questions during your trial? Join the conversation in the #support channel on our Slack community. Our dynamic community is here to assist you. [Join #support on Slack](https://prophecy-io-support.slack.com/archives/C01P1PD7JJY).
- If you'd like to see Prophecy in action, sign up [here](https://www.prophecy.io/request-a-demo) for a live demo with our incredible team.
- _If you're a Trial customer and unable to signup for our Slack Community, please reach out to [email protected] for quick assistance._
- If you're a Trial customer and unable to signup for our Slack Community, please reach out to [email protected] for quick assistance.

## For Existing Customers

- **Log a Ticket in the Support Portal:** For our existing customers, the Customer Support Portal is your hub for logging tickets and getting personalized assistance. Log in to the Support Portal [here](https://prophecy.zendesk.com/).
- Please send Prophecy [logs](./logs/logs.md), Spark Cluster [Configuration](./logs/logs.md), and [Connectivity Check output](./logs/logs.md) (if applicable) via the Support Portal.
- _Trouble Logging In? If you're encountering issues accessing the Customer Support Portal, don't worry. Please reach out to [email protected], and we'll get you back on track!_
- Trouble Logging In? If you're encountering issues accessing the Customer Support Portal, don't worry. Please reach out to [email protected], and we'll get you back on track!

## Send details

To assist with resolving an issue, gather logs and configurations from your Prophecy and Spark environments and send them to our Support team. Review the table below to learn which items to send in the [Support Portal](https://prophecy.zendesk.com/) according to your use case.

| **Issue** | **Info to Send** |
| --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| General Prophecy issues | For the `app.prophecy.io` endpoint, support team can access [Prophecy logs](./prophecy-details.md) directly. For a `custom.prophecy.io` endpoint, provide [Prophecy logs](./prophecy-details.md) from the admin page. |
| Attaching a Pipeline to a Spark cluster | Connection logs from [Prophecy](./prophecy-details.md), Spark cluster [configuration](./spark-cluster-details.md#configurations) and [connectivity](./spark-cluster-details.md#connectivity-check) check. |
| Running a Pipeline | Prophecy [Pipeline](./prophecy-details.md) logs, Spark cluster [configuration](./spark-cluster-details.md#spark-configurations) and [connectivity](./spark-cluster-details.md#connectivity-check) check. |
| Spark application issues | Prophecy [Pipeline](./prophecy-details.md) logs and Spark [Driver](https://docs.databricks.com/en/compute/troubleshooting/debugging-spark-ui.html#driver-logs) logs. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 docs/getting-started/getting-help/img/prophecy_logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
61 changes: 0 additions & 61 deletions docs/getting-started/getting-help/logs/cluster-config-notebook.md

This file was deleted.

24 changes: 0 additions & 24 deletions docs/getting-started/getting-help/logs/cluster-config-ui.md

This file was deleted.

83 changes: 0 additions & 83 deletions docs/getting-started/getting-help/logs/logs.md

This file was deleted.

60 changes: 60 additions & 0 deletions docs/getting-started/getting-help/prophecy-details.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
title: Send Prophecy details to Support
id: prophecy-details
sidebar_position: 1
description: How to download logs and send for support
sidebar_label: Send info from Prophecy
tags: []
---

Gather logs from your Prophecy environment and send them to the support team via the [Support Portal](https://prophecy.zendesk.com/).

<table>
<thead>
<tr>
<th>Log to Send</th>
<th> Example</th>
</tr>
</thead>
<tbody>
<tr>
<td>Prophecy <a href="https://docs.prophecy.io/architecture/self-hosted/download-logs/#enable-prophecy-downloads-logs">System logs.</a></td>
kathweinschenkprophecy marked this conversation as resolved.
Show resolved Hide resolved
<td>
<br />
<img
src={require("./img/prophecy_logs.png").default}
alt="Download Prophecy logs"
width="75%"
/>
<br />
</td>
</tr>
<tr>
<td>Pipeline logs</td>
<td>
<br />
<img
src={require("./img/pipeline_logs.png").default}
alt="Download Pipeline logs"
width="75%"
/>
<br />
</td>
</tr>
<tr>
<td>Connection logs from Prophecy with error <a href="https://docs.prophecy.io/Spark/fabrics/fabric-diagnostics">code</a></td>
<td>
<br />
<img
src={require("./img/prophecy_connection_log.png").default}
alt="Connection logs from Prophecy"
width="75%"
/>
<br />
</td>
</tr>

</tbody>
</table>

**We look forward to hearing from you!**
Loading
Loading