Update user.hash referrence to user.authentication.id everywhere

open-telemetry · Aug 8, 2024 · 5a6d337 · 5a6d337
1 parent 6f7dc08
commit 5a6d337
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/docs/attributes-registry/user.md b/docs/attributes-registry/user.md
@@ -26,4 +26,4 @@ Describes information about the user.
 
 **[3]:** The `user.id`, when populated, is expected to be generated before user is authenticated and SHOULD NOT change after the user logs in. In browser scenarios `user.id` is usually stored in cookies.
 It's NOT RECOMMENDED to populate this attribute when unauthenticated users are not tracked or identified by the system.
-It can be a random guid or a hash of the user's IP address. This is different from `user.hash` which is a hash of a known `user.id` or `user.name`.
+It can be a random guid or a hash of the user's IP address. This is different from `user.hash` which is a hash of a known `user.authentication.id` or `user.name`.
diff --git a/docs/general/attributes.md b/docs/general/attributes.md
@@ -415,7 +415,7 @@ These attributes may be used for any operation with an authenticated and/or auth
 
 **[1]:** The `user.id`, when populated, is expected to be generated before user is authenticated and SHOULD NOT change after the user logs in. In browser scenarios `user.id` is usually stored in cookies.
 It's NOT RECOMMENDED to populate this attribute when unauthenticated users are not tracked or identified by the system.
-It can be a random guid or a hash of the user's IP address. This is different from `user.hash` which is a hash of a known `user.id` or `user.name`.
+It can be a random guid or a hash of the user's IP address. This is different from `user.hash` which is a hash of a known `user.authentication.id` or `user.name`.
 
 **[2]:** If instrumentation supports tracking unauthenticated users and if `user.authentication.id` is set, recommended otherwise.
 

diff --git a/model/registry/user.yaml b/model/registry/user.yaml
@@ -35,7 +35,7 @@ groups:
 
           It's NOT RECOMMENDED to populate this attribute when unauthenticated users are not tracked or identified by the system.
 
-          It can be a random guid or a hash of the user's IP address. This is different from `user.hash` which is a hash of a known `user.id` or `user.name`.
+          It can be a random guid or a hash of the user's IP address. This is different from `user.hash` which is a hash of a known `user.authentication.id` or `user.name`.
         examples: ['QdH5CAWJgqVT4rOr0qtumf']
       - id: user.authentication.id
         type: string