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

[DJM] Document custom host tags env variables #28577

Open
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

aboitreaud
Copy link
Contributor

What does this PR do? What is the motivation?

In the doc pages for the three DJM plarforms, document the possibility to add custom host tags with DD_TAGS and DD_EXTRA_TAGS.

Merge instructions

Merge readiness: Not ready

  • Ready for merge

For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass in CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.

If your branch doesn't follow this format, rename it or create a new branch and PR.

To have your PR automatically merged after it receives the required reviews, add the following PR comment:

/merge

Additional notes

@aboitreaud aboitreaud marked this pull request as ready for review April 5, 2025 20:29
@aboitreaud aboitreaud requested a review from a team as a code owner April 5, 2025 20:29
@@ -71,6 +71,16 @@ This setup does not work on Databricks clusters in <strong>Standard</strong> (fo
1. Click **Save Databricks Workspace** at the bottom of the browser window.
{{< img src="data_jobs/databricks/configure-data-jobs-monitoring-existing.png" alt="In the Datadog-Databricks integration tile, Datadog Agent Setup for a Databricks workspace already added to the integration. Datadog can install and manage a global init script." style="width:100%;" >}}

Optionally, you can add custom host tags to your Databricks clusters by configuring the following environment variable in the Advanced Configuration section of your cluster in the Databricks UI or as [Spark env vars][2] with the Databricks API:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Optionally, you can add custom host tags to your Databricks clusters by configuring the following environment variable in the Advanced Configuration section of your cluster in the Databricks UI or as [Spark env vars][2] with the Databricks API:
Optionally, you can add tags to your Databricks cluster and Spark performance metrics by configuring the following environment variable in the Advanced Configuration section of your cluster in the Databricks UI or as [Spark env vars][2] with the Databricks API:

Copy link
Contributor

Choose a reason for hiding this comment

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

@aboitreaud what API are you referring to at the end: "with the Databricks API" ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

https://docs.databricks.com/api/workspace/clusters/edit
It's the way StoneX are updating their cluster from what I understood in DJMS-46


| Variable | Description | Default |
|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
| DD_TAGS | Add host tags to Databricks clusters. Comma or space separated key:value pairs. Follow [Datadog tag conventions][1]. Example: `env:staging,team:data_engineering` | |
Copy link
Contributor

Choose a reason for hiding this comment

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

@aboitreaud do we actually want this as the method for showing how to set env? Isn't that DD_ENV ?

Co-authored-by: Ryan Warrier <ryan.warrier@datadoghq.com>
Copy link
Contributor

@michaelcretzman michaelcretzman left a comment

Choose a reason for hiding this comment

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

Approved with 2 suggested edits.

aboitreaud and others added 5 commits April 7, 2025 19:17
Co-authored-by: Michael Cretzman <58786311+michaelcretzman@users.noreply.github.com>
Co-authored-by: Ryan Warrier <ryan.warrier@datadoghq.com>
@aboitreaud aboitreaud force-pushed the adrien.boitreaud/host-tags-djm-doc branch from d40a1af to ea738e1 Compare April 8, 2025 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants