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.

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

New analytics section #2826

Merged
merged 8 commits into from
May 27, 2024
Merged

New analytics section #2826

merged 8 commits into from
May 27, 2024

Conversation

guimachiavelli
Copy link
Member

@guimachiavelli guimachiavelli commented May 16, 2024

Currently, we have a "Cloud" section for cloud-only features. This PR continues our move towards a "cloud-first documentation" approach by creating a dedicated documentation section for the analytics and monitoring features. It also expands the analytics documentation by adding a small reference for /events and the click and conversion events.

@meili-bot
Copy link
Collaborator

How to see the preview of this PR?

⚠️ Private link, only accessible to Meilisearch employees.

Go to this URL: https://website-git-deploy-preview-mei-16-meili.vercel.app/docs/branch:analytics-section

Credentials to access the page are in the company's password manager as "Docs deploy preview".

@guimachiavelli guimachiavelli marked this pull request as ready for review May 20, 2024 16:47
@guimachiavelli guimachiavelli requested a review from a team as a code owner May 20, 2024 16:47
@gmourier
Copy link
Member

gmourier commented May 20, 2024

We could benefit from a proper section on user identification and the total user metric. The X-MS-USER-ID is a bit hidden inside a callout. I had a customer request how to get the right Total Users metric while running the searches from the backend side.

Happy to help!

macraig
macraig previously approved these changes May 21, 2024
Copy link
Contributor

@macraig macraig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super clear and easy to read 👌

Edit: @gmourier is the technical expert on these, so my review is mostly from a user's perspective not a technical one

CaroFG
CaroFG previously approved these changes May 21, 2024
Copy link
Contributor

@CaroFG CaroFG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌

gmourier
gmourier previously approved these changes May 22, 2024
Copy link
Member

@gmourier gmourier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All good to me as well for the part being delivered here @guimachiavelli, next iteration would be to think of the user identification via X-MS-USER-ID!

@guimachiavelli guimachiavelli dismissed stale reviews from gmourier, CaroFG, and macraig via d8e8370 May 22, 2024 15:59
@guimachiavelli
Copy link
Member Author

Your wish is my command, @gmourier. I wrote a very short guide on X-MS-USER-ID. Should improve visibility and give clear indications of what users need to do.

Can you take a quick look?

Copy link
Member

@gmourier gmourier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the guide about X-MS-USER-ID @guimachiavelli, I tried to add precisions by reworking some sections! Let me know if it's unclear 🙏

cc @curquiza @brunoocasali A way to ease the DX for cloud users using SDKs and in the need to provide their custom way to identify their users across search analytics would be to instantiate the client with the userId so the X-MS-USER-ID header is sent for search requests and events (when they will there in the SDKs!)

learn/analytics/bind_events_user.mdx Outdated Show resolved Hide resolved
learn/analytics/bind_events_user.mdx Outdated Show resolved Hide resolved
learn/analytics/bind_events_user.mdx Outdated Show resolved Hide resolved
learn/analytics/bind_events_user.mdx Outdated Show resolved Hide resolved
learn/analytics/bind_events_user.mdx Outdated Show resolved Hide resolved
@guimachiavelli
Copy link
Member Author

Obtained final approval via private message. Merging.

@guimachiavelli guimachiavelli merged commit fef5639 into main May 27, 2024
1 check passed
@guimachiavelli guimachiavelli deleted the analytics-section branch May 27, 2024 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants