ReadMe Documentation

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

Cloudflare Workers + API Metrics

🚧

Any issues?

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

If you'd rather not use one of our language-oriented SDKs, we have another option: Cloudflare Workers!

What are Cloudflare Workers?

Cloudflare Workers are JavaScript snippets that are deployed and run at the edge on 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 a service worker app on Cloudflare's App Store, which enables you to send your log data to us at the network layer instead of through your application. This means your API can be written in any language, and you can send logs to ReadMe as long as you are using Cloudflare with the proxy turned on! You can view our worker here.

How do I set this up?

It's super easy if you're a developer! There are only two steps required to get our worker setup with your API.

In Your API

First, you will need to modify your API to return two new headers with your request. These allow ReadMe to understand who is making the call.

Header

Description

x-readme-id

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

x-readme-label

This will be augment the log in ReadMe, since it's much easier to remember a label than a unique identifier

x-readme-email

(Optional) For further insight into API calls, you can send an email along with your request to target users more easily.

Here's an example of setting these headers in Express.js:

const express = require('express');
const app = express();

app.use((req, res, next) => {
  if (req.user) {
    res.set('x-readme-id', req.user._id);
    res.set('x-readme-label', req.user.name);
    res.set('x-readme-email', req.user.email);
  }

  next();
});

In Cloudflare's Console

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

Navigate to your domain in Cloudflare's dashboard, then select the Apps tab in the upper right. From here you will be able to search for "ReadMe API Metrics" and preview the app.

To install:

  1. Click the blue "Preview on your site" button.
  2. In the page that opens, which allows you to sign in to ReadMe via OAuth:
  • Select your project
  • Give Cloudflare your doc project's API key (which you can find at dash.readme.io/yourProject/api-key)
  • Configure which routes the worker should be applied to, i.e., which API routes you want to get usage metrics about.

Once you log in with ReadMe and configure which routes to track on your API, you are all set! Just click the install button to finish the process 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. This means your "Orange Cloud" should be enabled for your domain!

Updated about a month ago


Cloudflare Workers + API Metrics


Suggested Edits are limited on API Reference Pages

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