What is the best way to integrate Scarf analytics with Mkdocs?

[ccmao1130]

Maybe I'm not looking in the right place, but I'm trying to integrate Scarf Analytics with my Mkdocs documentation to track metrics. Has anyone does this already and what did your setup look like?

[niclasheinz]

Hi @ccmao1130
You recently marked this discussion as Resolved. May I ask you how you solved your question? Maybe someone wants to set up site analytics with Scarf again in the future and would then see your solution.

[ccmao1130]

Haha I have to preface this by saying I'm not very technical therefore very novice at coding, so this may seem like an obvious solution 😃

I thought there was some particular syntax for mkdocs.yml but dropping the pixel in the copyright works just fine, I took inspiration from Scarf's mkdocs.yml setup:

# Project Information
site_name: Scarf Documentation
site_description: |
  Scarf's Technical Documentation & API Reference
copyright: Copyright &copy; 2019 - 2025 Scarf Systems, Inc. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=c9065f3a-a090-4243-8f69-145d5de7bfca" />

Scarf also offers custom telemetry and included an example from Unstructured. Here is Unstructured's implementation where they put the method in utils.py and called it in logger.py. Seems pretty straightforward, I haven't personally implemented this yet, but I'll add a comment here when I do!

[ccmao1130]

Can confirm that custom telemetry instructions were clear and easy to setup! There was only 1 detail that caused me trouble. On the Custom Telemetry Documentation Page, it says:

# ENDPOINT is a DNS CNAME configured within your Scarf account
# FILE_PACKAGE_NAME is the Scarf collection under which these data points will be collected
       "https://ENDPOINT.scarf.sh/FILE_PACKAGE_NAME?version="

FILE_PACKAGE_NAME was not actually the file package name. When you set up your file package, you're asked for a Desired path format. This is what you should put in place of FILE_PACKAGE_NAME. (At least it was not intuitive to me)