[DJM] Add troubleshooting section after setup instructions #26333
Conversation
aboitreaud
changed the title
Preview links (active after the
|
aboitreaud
force-pushed
the
adrien.boitreaud/djm-troubleshooting-doc
branch
2 times, most recently
from
a8a1dc1
to
67b2a3a
Compare
aboitreaud
force-pushed
the
adrien.boitreaud/djm-troubleshooting-doc
branch
from
67b2a3a
to
851f05f
Compare
| @@ -0,0 +1,10 @@ | |||
| Data Jobs Monitoring requires to have the Datadog Agent running in the background. You can check that it is correctly installed and running on your cluster with this command: | |||
There was a problem hiding this comment.
| Data Jobs Monitoring requires to have the Datadog Agent running in the background. You can check that it is correctly installed and running on your cluster with this command: | |
| Data Jobs Monitoring requires a Datadog Agent running in the background. You can check that it is correctly installed and running on your cluster with this command: |
| ```shell | ||
| sudo datadog-agent status | ||
| ``` | ||
| If it is not the case, you may want to check the log file of the installation. On your cluster, these logs are located in `/tmp/datadog-djm-init.log`. |
There was a problem hiding this comment.
| If it is not the case, you may want to check the log file of the installation. On your cluster, these logs are located in `/tmp/datadog-djm-init.log`. | |
| If there is no Agent running, check the log file of the installation. On your cluster, these logs are located in `/tmp/datadog-djm-init.log`. |
There was a problem hiding this comment.
Hi Heston, I'm sorry I had unpushed changes suggesed by my team. I just pushed them, can you take another look please ?
| ``` | ||
| If it is not the case, you may want to check the log file of the installation. On your cluster, these logs are located in `/tmp/datadog-djm-init.log`. | ||
|
|
||
| For further support, make sure the init script contains the following line so that the install logs are sent to the Datadog support team. |
There was a problem hiding this comment.
| For further support, make sure the init script contains the following line so that the install logs are sent to the Datadog support team. | |
| For further support, make sure the init script contains the following line to ensure that the install logs are sent to the Datadog support team. |
|
Hi Heston, I'm sorry I had unpushed changes suggesed by my team. I just pushed them, can you take another look please ? |
Co-authored-by: Heston Hoffman <[email protected]>
Co-authored-by: Heston Hoffman <[email protected]>
| @@ -0,0 +1,10 @@ | |||
| The init script installs the Datadog Agent. To make sure it is properly installed, run the Agent status command: | |||
There was a problem hiding this comment.
Can you add details of where and how you can run this? e.g. could just be links to how to ssh into a node on the cluster for the different platforms.
There was a problem hiding this comment.
Added some words saying that this should be run after ssh-ing into the cluster, but since this doc is shared by all DJM platforms, it's not easy for now to add platform-specific guidelines. We can do that later in a broader doc revamp to make this a FAQ section.
| @@ -0,0 +1,10 @@ | |||
| The init script installs the Datadog Agent. To make sure it is properly installed, run the Agent status command: | |||
There was a problem hiding this comment.
Let's start this as more of a FAQ section. e.g. let's have this content under the question:
I installed Data Jobs Monitoring but don't see any data in the product.
- The init script installs...
There was a problem hiding this comment.
I see, thanks. For now, I believe "I installed Data Jobs Monitoring but don't see any data in the product." is the only question that this troubleshooting section aims to answer. I agree that checking the Agent status is only the first part of the answer, we intended to add a second point on checking the Tracer injection later.
I would be in favor of keeping the current structure for now so that the customer that we know is trying to set up DJM can find some answers quickly, and then plan in the backlog a task to create a more exhaustive FAQ. Is that ok for you ?
I've added a sentence at the top of the section, saying it specifically adresses the lack of data after installation in DJM.
What does this PR do? What is the motivation?
Add a troubleshooting section on the DJM documentation page, common to Databricks, Dataproc, and EMR.
We've seen customers trying to install the product and struggling to understand what was the error so this section fulfills that need.
Merge instructions
Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the
<yourname>/descriptionnaming convention) and then add the following PR comment:Additional notes