- Notifications
You must be signed in to change notification settings - Fork929
docs: document how to tag coder users in dx data cloud#17805
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
9 commits Select commitHold shift + click to select a range
e0ebcff
add dx data cloud
EdwardAngerta5c1949
add dxdc to manifest
EdwardAngert74a7616
Merge branch 'main' into tag-coder-users-dx
EdwardAngert23b4eeb
add cli link
EdwardAngert56e1c14
Merge branch 'main' into tag-coder-users-dx
EdwardAngert4c35fac
Update docs/admin/integrations/data-cloud.md
EdwardAngert72d97b5
Merge branch 'main' into tag-coder-users-dx
EdwardAngertda03104
rename file
EdwardAngert9810860
edits from dx
EdwardAngertFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
87 changes: 87 additions & 0 deletionsdocs/admin/integrations/dx-data-cloud.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
# DX Data Cloud | ||
[DX](https://getdx.com) is a developer intelligence platform used by engineering | ||
leaders and platform engineers. | ||
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. | ||
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 | ||
## Requirements | ||
- 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 DX Customer Success Manager | ||
## Extract Your Coder User List | ||
<div class="tabs"> | ||
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.md#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. | ||
</div> | ||
## Contact your DX Customer Success Manager | ||
Provide the file to your dedicated DX Customer Success Manager (CSM). | ||
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 attribute is uploaded, you'll have a Coder filter option within your DX reports allowing you to: | ||
- 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 | ||
- [DX Data Cloud Documentation](https://help.getdx.com/en/) | ||
- [Coder CLI](../../reference/cli/users.md) | ||
- [Coder API](../../reference/api/users.md) | ||
- [PlatformX Integration](./platformx.md) |
5 changes: 5 additions & 0 deletionsdocs/manifest.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.