From e0ebcffb627d98b7685713bf9a7ac91497ef365a Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Tue, 13 May 2025 18:42:09 +0000 Subject: [PATCH 1/6] add dx data cloud --- docs/admin/integrations/data-cloud.md | 90 +++++++++++++++++++++++++++ 1 file changed, 90 insertions(+) create mode 100644 docs/admin/integrations/data-cloud.md diff --git a/docs/admin/integrations/data-cloud.md b/docs/admin/integrations/data-cloud.md new file mode 100644 index 0000000000000..11b424bb3b86b --- /dev/null +++ b/docs/admin/integrations/data-cloud.md @@ -0,0 +1,90 @@ +# DX Data Cloud + +[DX](https://getdx.com) is a developer intelligence platform used by engineering +leaders and platform engineers. + +You can tag your Coder users in DX Data Cloud to filter and analyze user activity data to: + +- Measure adoption and impact +- Identify feature usage patterns +- Personalize user experiences +- Proactively address issues + +## Requirements + +- A DX Data Cloud subscription +- Access to Coder user data through the Coder CLI, Coder API, an IdP, or and existing Coder-DX integration +- Coordination with your Data Cloud Customer Success Manager + +## Extract Your Coder User List + +
+ +You can use the Coder CLI, Coder API, or your Identity Provider (IdP) to extract your list of users. + +If your organization already uses the Coder-DX integration, you can find a list of active Coder users directly within DX. + +### CLI + +Use `users list` to export the list of users to a CSV file: + +```shell +coder users list > users.csv +``` + +Visit the [users list](../../reference/cli/users_list.md) documentation for more options. + +### API + +Use [get users](../../reference/api/users#get-users): + +```bash +curl -X GET http://coder-server:8080/api/v2/users \ + -H 'Accept: application/json' \ + -H 'Coder-Session-Token: API_KEY' +``` + +To export the results to a CSV file, you can use the `jq` tool to process the JSON response: + +```bash +curl -X GET http://coder-server:8080/api/v2/users \ + -H 'Accept: application/json' \ + -H 'Coder-Session-Token: API_KEY' | \ + jq -r '.users | (map(keys) | add | unique) as $cols | $cols, (.[] | [.[$cols[]]] | @csv)' > users.csv +``` + +Visit the [get users](../../reference/api/users.md#get-users) documentation for more options. + +### IdP + +If your organization uses a centralized IdP to manage user accounts, you can extract user data directly from your IdP. + +This is particularly useful if you need additional user attributes managed within your IdP. + +
+ +## Engage your DX Data Cloud Customer Success Manager + +Provide the file to your dedicated DX Data Cloud Customer Success Manager (CSM). + +Your CSM will: + +1. Import the CSV file into the Data Cloud platform +1. Associate Coder user identifiers with corresponding records in your Data Cloud environment +1. Create the necessary links between your Coder users and their activity data + +## Use Coder as a Data Cloud Filter + +After the tagging process is complete, you'll have a **Coder** filter option within your Data Cloud dashboards, +reports, and analysis tools that you can use to: + +- Segment your data based on Coder usage +- Filter by additional user attributes that are included in your CSV file +- Perform granular analysis on specific segments of your Coder user base +- Understand unique behaviors and patterns across your Coder users + +## Related Resources + +- [DX Data Cloud Documentation](https://help.getdx.com/en/) +- [Coder API Documentation](../../reference/api/users) +- [PlatformX Integration](./platformx.md) From a5c19498a5ff6960088158502ef38fea49937a4b Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Tue, 13 May 2025 18:44:34 +0000 Subject: [PATCH 2/6] add dxdc to manifest --- docs/manifest.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/manifest.json b/docs/manifest.json index 4519767b071dd..74b7681f40256 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -591,6 +591,11 @@ "description": "Integrate Coder with DX PlatformX", "path": "./admin/integrations/platformx.md" }, + { + "title": "DX Data Cloud", + "description": "Tag Coder Users with DX Data Cloud", + "path": "./admin/integrations/data-cloud.md" + }, { "title": "Hashicorp Vault", "description": "Integrate Coder with Hashicorp Vault", From 23b4eeb386f1b2358f63dc46d61663ede84cb50e Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Tue, 13 May 2025 18:52:53 +0000 Subject: [PATCH 3/6] add cli link --- docs/admin/integrations/data-cloud.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/admin/integrations/data-cloud.md b/docs/admin/integrations/data-cloud.md index e9f5cf0edd2df..81c9986af7358 100644 --- a/docs/admin/integrations/data-cloud.md +++ b/docs/admin/integrations/data-cloud.md @@ -86,5 +86,6 @@ reports, and analysis tools that you can use to: ## Related Resources - [DX Data Cloud Documentation](https://help.getdx.com/en/) -- [Coder API Documentation](../../reference/api/users) +- [Coder CLI](../../reference/cli/users.md) +- [Coder API](../../reference/api/users.md) - [PlatformX Integration](./platformx.md) From 4c35face0ae92da09f5f93a2c9560367b957689e Mon Sep 17 00:00:00 2001 From: Edward Angert Date: Wed, 4 Jun 2025 13:03:02 -0400 Subject: [PATCH 4/6] Update docs/admin/integrations/data-cloud.md --- docs/admin/integrations/data-cloud.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/admin/integrations/data-cloud.md b/docs/admin/integrations/data-cloud.md index 81c9986af7358..9b58243f646e5 100644 --- a/docs/admin/integrations/data-cloud.md +++ b/docs/admin/integrations/data-cloud.md @@ -13,7 +13,7 @@ You can tag your Coder users in DX Data Cloud to filter and analyze user activit ## Requirements - A DX Data Cloud subscription -- Access to Coder user data through the Coder CLI, Coder API, an IdP, or and existing Coder-DX integration +- Access to Coder user data through the Coder CLI, Coder API, an IdP, or an existing Coder-DX integration - Coordination with your Data Cloud Customer Success Manager ## Extract Your Coder User List From da03104c3716acd7b740dc1c002d8683dfcae9be Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Fri, 20 Jun 2025 19:03:07 +0000 Subject: [PATCH 5/6] rename file --- docs/admin/integrations/{data-cloud.md => dx-data-cloud.md} | 0 docs/manifest.json | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename docs/admin/integrations/{data-cloud.md => dx-data-cloud.md} (100%) diff --git a/docs/admin/integrations/data-cloud.md b/docs/admin/integrations/dx-data-cloud.md similarity index 100% rename from docs/admin/integrations/data-cloud.md rename to docs/admin/integrations/dx-data-cloud.md diff --git a/docs/manifest.json b/docs/manifest.json index 04fbef0a7fbbb..c01eb828ac3a1 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -700,7 +700,7 @@ { "title": "DX Data Cloud", "description": "Tag Coder Users with DX Data Cloud", - "path": "./admin/integrations/data-cloud.md" + "path": "./admin/integrations/dx-data-cloud.md" }, { "title": "Hashicorp Vault", From 98108609fba8af0e93a0d9221b3c97bf95c2ae4d Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Fri, 20 Jun 2025 20:59:39 +0000 Subject: [PATCH 6/6] edits from dx --- docs/admin/integrations/dx-data-cloud.md | 36 +++++++++++------------- 1 file changed, 16 insertions(+), 20 deletions(-) diff --git a/docs/admin/integrations/dx-data-cloud.md b/docs/admin/integrations/dx-data-cloud.md index 9b58243f646e5..62055d69f5f1a 100644 --- a/docs/admin/integrations/dx-data-cloud.md +++ b/docs/admin/integrations/dx-data-cloud.md @@ -3,18 +3,22 @@ [DX](https://getdx.com) is a developer intelligence platform used by engineering leaders and platform engineers. -You can tag your Coder users in DX Data Cloud to filter and analyze user activity data to: +DX uses metadata attributes to assign information to individual users. +While it's common to segment users by `role`, `level`, or `geo`, it’s become increasingly +common to use DX attributes to better understand usage and adoption of tools. -- Measure adoption and impact -- Identify feature usage patterns +You can create a `Coder` attribute in DX to segment and analyze the impact of Coder usage on a developer’s work, including: + +- Understanding the needs of power users or low Coder usage across the org +- Correlate Coder usage with qualitative and quantitative engineering metrics, + such as PR throughput, deployment frequency, deep work, dev environment toil, and more. - Personalize user experiences -- Proactively address issues ## Requirements -- A DX Data Cloud subscription +- A DX subscription - Access to Coder user data through the Coder CLI, Coder API, an IdP, or an existing Coder-DX integration -- Coordination with your Data Cloud Customer Success Manager +- Coordination with your DX Customer Success Manager ## Extract Your Coder User List @@ -63,25 +67,17 @@ This is particularly useful if you need additional user attributes managed withi -## Engage your DX Data Cloud Customer Success Manager - -Provide the file to your dedicated DX Data Cloud Customer Success Manager (CSM). - -Your CSM will: +## Contact your DX Customer Success Manager -1. Import the CSV file into the Data Cloud platform -1. Associate Coder user identifiers with corresponding records in your Data Cloud environment -1. Create the necessary links between your Coder users and their activity data +Provide the file to your dedicated DX Customer Success Manager (CSM). -## Use Coder as a Data Cloud Filter +Your CSM will import the CSV of individuals using Coder, as well as usage frequency (if applicable) into DX to create a `Coder` attribute. -After the tagging process is complete, you'll have a **Coder** filter option within your Data Cloud dashboards, -reports, and analysis tools that you can use to: +After the attribute is uploaded, you'll have a Coder filter option within your DX reports allowing you to: -- Segment your data based on Coder usage -- Filter by additional user attributes that are included in your CSV file -- Perform granular analysis on specific segments of your Coder user base +- Perform cohort analysis (Coder user vs non-user) - Understand unique behaviors and patterns across your Coder users +- Run a [study](https://getdx.com/studies/) or setup a [PlatformX](https://getdx.com/platformx/) event for deeper analysis ## Related Resources