Skip to content
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

docs(ruby): add hint to use distinct_id for group identify #10172

Merged
merged 3 commits into from
Dec 19, 2024
Merged

docs(ruby): add hint to use distinct_id for group identify #10172

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ecc85e6
docs(ruby): add hint to use distinct_id for group identify
thmsobrmlr Dec 18, 2024
567d087
Apply suggestions from code review
thmsobrmlr Dec 19, 2024
77ede9a
apply suggestion everywhere
thmsobrmlr Dec 19, 2024
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
4 changes: 3 additions & 1 deletion contents/docs/integrate/_snippets/install-ruby.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ gem "posthog-ruby"
In your app, set your API key **before** making any calls. If setting a custom `host`, make sure to include the protocol (e.g. `https://`).

```ruby
require 'posthog-ruby'

posthog = PostHog::Client.new({
api_key: "<ph_project_api_key>",
host: "<ph_client_api_host>", # TIP: You can remove this line if you're using https://app.posthog.com
host: "<ph_client_api_host>",
on_error: Proc.new { |status, msg| print msg }
})
```
Expand Down
2 changes: 2 additions & 0 deletions contents/docs/libraries/node/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,8 @@ client.groupIdentify({
})
```

The `name` is a special property which is used in the PostHog UI for the name of the Group. If you don't specify a `name` property, the group ID will be used instead.

If the optional `distinct_id` is not provided in the group identify call, it defaults to `${groupType}_${groupKey}` (e.g., `$company_company_id_in_your_db` in the example above). This default behavior will result in each group appearing as a separate person in PostHog. To avoid this, it's often more practical to use a consistent `distinct_id`, such as `group_identifier`.

## GeoIP properties
Expand Down
2 changes: 2 additions & 0 deletions contents/docs/libraries/ruby/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,8 @@ posthog.group_identify(

The `name` is a special property which is used in the PostHog UI for the name of the Group. If you don't specify a `name` property, the group ID will be used instead.

If the optional distinct_id is not provided in the group identify call, it defaults to ${groupType}_${groupKey} (e.g., $company_company_id_in_your_db in the example above). This default behavior will result in each group appearing as a separate person in PostHog. To avoid this, it's often more practical to use a consistent distinct_id, such as group_identifier.

## Thank you

This library is largely based on the `analytics-ruby` package.
Loading