Skip to content

feat: Add user.ip_address #75

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.

Sign up for GitHub

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

Merged
AbhiPrasad merged 1 commit into from
Jul 14, 2025
Merged

feat: Add user.ip_address #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions generated/attributes/user.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
- [user.geo.subdivision](#usergeosubdivision)
- [user.hash](#userhash)
- [user.id](#userid)
- [user.ip_address](#userip_address)
- [user.name](#username)
- [user.roles](#userroles)

Expand Down Expand Up @@ -104,6 +105,17 @@ Unique identifier of the user.
| Exists in OpenTelemetry | Yes |
| Example | `S-1-5-21-202424912787-2692429404-2351956786-1000` |

### user.ip_address

The IP address of the user.

| Property | Value |
| --- | --- |
| Type | `string` |
| Has PII | true |
| Exists in OpenTelemetry | No |
| Example | `192.168.1.1` |

### user.name

Short name or login/username of the user.
Expand Down
22 changes: 22 additions & 0 deletions javascript/sentry-conventions/src/attributes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6066,6 +6066,26 @@ export const USER_ID = 'user.id';
*/
export type USER_ID_TYPE = string;

// Path: model/attributes/user/user__ip_address.json

/**
* The IP address of the user. `user.ip_address`
*
* Attribute Value Type: `string` {@link USER_IP_ADDRESS_TYPE}
*
* Contains PII: true
*
* Attribute defined in OTEL: No
*
* @example "192.168.1.1"
*/
export const USER_IP_ADDRESS = 'user.ip_address';

/**
* Type for {@link USER_IP_ADDRESS} user.ip_address
*/
export type USER_IP_ADDRESS_TYPE = string;

// Path: model/attributes/user/user__name.json

/**
Expand Down Expand Up @@ -6355,6 +6375,7 @@ export type Attributes = {
[USER_GEO_SUBDIVISION]?: USER_GEO_SUBDIVISION_TYPE;
[USER_HASH]?: USER_HASH_TYPE;
[USER_ID]?: USER_ID_TYPE;
[USER_IP_ADDRESS]?: USER_IP_ADDRESS_TYPE;
[USER_NAME]?: USER_NAME_TYPE;
[USER_ROLES]?: USER_ROLES_TYPE;
[USER_AGENT_ORIGINAL]?: USER_AGENT_ORIGINAL_TYPE;
Expand Down Expand Up @@ -6651,6 +6672,7 @@ export type FullAttributes = {
[USER_GEO_SUBDIVISION]?: USER_GEO_SUBDIVISION_TYPE;
[USER_HASH]?: USER_HASH_TYPE;
[USER_ID]?: USER_ID_TYPE;
[USER_IP_ADDRESS]?: USER_IP_ADDRESS_TYPE;
[USER_NAME]?: USER_NAME_TYPE;
[USER_ROLES]?: USER_ROLES_TYPE;
[USER_AGENT_ORIGINAL]?: USER_AGENT_ORIGINAL_TYPE;
Expand Down
10 changes: 10 additions & 0 deletions model/attributes/user/user__ip_address.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"key": "user.ip_address",
"brief": "The IP address of the user.",
"type": "string",
"pii": {
"key": "true"
},
"is_in_otel": false,
"example": "192.168.1.1"
}