Skip to content

Integrations: expose integrations meta-data to simplify analytics #4517

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

Jump to bottom
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Integrations: expose integrations meta-data to simplify analytics #4517

wants to merge 3 commits into from

Conversation

Blargian
Copy link
Member

@Blargian Blargian commented Oct 2, 2025 •
edited
Loading

Summary

Currently it's challenging to analyze our docs traffic data for integrations per integration category or support level without some level of manual effort. For example if you want to see how much more popular language client integrations pages are, than data ingestion pages you will need to manually input a list of the slugs for filtering which is inconvenient.

What's needed?

Meta data in integrations docs pages such as:

  • category
  • support level
  • website link (link to repository for example)

This meta data in the doc front-matter will then be exposed via the page header and we can collect it via Google Analytics.
This will simplify SQL queries so we can analyze patterns in our docs for integrations.

Change introduced

It's now possible to add a new integration property with child metadata to the front-matter section:

---
sidebar_label: 'Overview'
slug: /integrations/dbt
sidebar_position: 1
description: 'Users can transform and model their data in ClickHouse using dbt'
title: 'Integrating dbt and ClickHouse'
doc_type: 'guide'
integration:
  - support_level: 'core'
  - category: 'data_integration'
  - website: 'https://github.com/ClickHouse/dbt-clickhouse'
---

Docusaurus has been customized to expose this data in the head element of the page. For example:

<head>
<meta name="keywords" content="clickhouse,cs,c#,.net,dotnet,csharp,client,driver,connect,integrate" data-rh="true">
<meta name="integration_support_level" content="core" data-rh="true">
<meta name="integration_category" content="language_client" data-rh="true">
<meta name="integration_website" content="https://github.com/ClickHouse/clickhouse-cs" data-rh="true">
</head>

I've added these to get tracked in Google Tag Manager:

function() {
  var meta = document.querySelector('meta[name="integration_support_level"]');
  return meta ? meta.content : undefined;
}

Checklist

@Blargian Blargian requested review from a team as code owners October 2, 2025 10:58
@vercel Vercel
Copy link

vercel bot commented Oct 2, 2025

@Blargian is attempting to deploy a commit to the ClickHouse Team on Vercel.

A member of the Team first needs to authorize it.

Blargian
Blargian commented Oct 2, 2025
View reviewed changes
@vercel Vercel
Copy link

vercel bot commented Oct 2, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Updated (UTC)
clickhouse-docs Error Error Oct 2, 2025 0:12am

@Blargian Blargian linked an issue Oct 2, 2025 that may be closed by this pull request
Send page metadata to Google Analytics #4053
Open
mshustov
mshustov reviewed Oct 6, 2025
View reviewed changes
docs/integrations/data-ingestion/clickpipes/postgres/index.md
doc_type: 'guide'
integration:
- support_level: 'core'
- category: 'clickpipes'
Copy link
Member

Choose a reason for hiding this comment

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

@morsapaes Do we need something to distinguish between different ClickPipes data sources?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mshustov mshustov mshustov left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Send page metadata to Google Analytics
2 participants
@Blargian @mshustov