Metrics

ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started

Sending Logs to ReadMe with CloudFlare

Any issues?

Integrations can be tricky! Contact support if you have any questions/issues.

If you do not use Node.js or PHP, then you cannot use our SDKs to send your logs to us. We do have another approach: CloudFlare Workers.

What are they?

CloudFlare workers are pieces of JavaScript code that run at the edge of CloudFlare's CDN. You can read more about this over on their blog: https://blog.cloudflare.com/introducing-cloudflare-workers/

How does this work with ReadMe?

We have released an app on Cloudflare's Worker App Store, which enables you to send your log data to us at the CDN layer instead of at your application layer. This means your API can be written in any language, and you can send logs to ReadMe as long as you are using Cloudflare. You can view our Cloudflare Worker module here: https://www.npmjs.com/package/@readme/cloudflare-worker.

How do I set this up?

It's super easy! There are only two steps required to get our Cloudflare working setup with your API.

First, you will need to modify your API to return two headers with your request. This will allow ReadMe to know more information about who is making the call, which normally isn't present in the API request/response.

Header
Description

x-readme-id

Unique identifier for the caller. This can be anything that is unique such as an id of this user in your database

x-readme-label

This will be used to display the user in ReadMe, since it's much easier to remember a name than a unique identifier

Once you are properly returning theses headers from your API requests, all you need to do is install the Cloudflare worker!

In the Cloudflare dashboard for your domain, click into the Apps section in the upper right. From here you will be able to search for the ReadMe API Metrics Cloudflare worker, and install it.

Once you start the install process, you will be taken to a screen that previews your site, and allows you to configure which routes the worker should run on. You will need to log into your ReadMe account to give Cloudflare access to your ReadMe project info.

Once you log in with ReadMe and setup your routes to match your API, we should be good to go! Click the install button and logs should start appearing in your dashboard as requests come in.

DNS Records Setting

In order for API Metrics to function correctly, your DNS Records setting in Cloudflare must use Cloudflare's proxy.

Updated 6 days ago


Sending Logs to ReadMe with CloudFlare


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.