​
Introduction

HoneyHive allows you to set user properties in your traces to gain more insights into your application.

​
Prerequisites

You have already set tracing for your code as described in our quickstart guide.

​
Setting

You can set on both the trace level or the span level. If the applies to the entire trace, then set it on the trace level. If the applies to a specific span, then set it on the span level. For more details, refer to the enrich traces documentation.

User Properties can only be set on the trace level.

In Python, you can use the enrich_session function to set on the trace level.

To pass to HoneyHive, pass it to the param in the enrich_session function. This function is used to enrich the session with additional information. Remember that enrich_session will update, not overwrite, the existing object on the trace.

Read more about the enrich_session function in the Python SDK reference.

Here’s an example of how to set on the trace level in Python:

Python
from honeyhive import HoneyHiveTracer, enrich_session

HoneyHiveTracer.init(
  api_key="my-api-key",
  project="my-project",
)

# ...

enrich_session(user_properties={
  "user_id": "12345",
  "user_email": "user@example.com",
  "user_properties": {
    "is_premium": True,
    "subscription_plan": "pro",
    "last_login": "2024-01-01T12:00:00Z"
  }
})

​
Concepts

​
What are User Properties?

User properties are additional attributes that you can set on your traces to gain more insights into your application.

Examples include:

  • User ID
  • User email
  • User properties
  • User payment plan details
  • User experiment group

User properties can help you link traces to specific users, improving your ability to group and filter traces using user-centric attributes.

​
SDK Reference

Read more about the enrich_session function in the Python SDK reference.

Tags and MetadataDistributed Tracing