Getting started with API Observability

1.

Install Server Integration

Install a server SDK or API gateway plugin to automatically log API traffic.

View Integrations

2.

Create Users/Companies

Create users/companies in Moesif using moesif-browser-js or the API

View Company Profiles

3.

Install a client integration

Install moesif-browser-js or Segment to track custom actions in your apps.

View Integrations

For the best possible analytics and observability, it’s recommended to add as many integrations as possible.

The first step is to install a server integration to log API traffic to Moesif. Moesif has many server integrations including plugons for most API gateways like Kong and AWS API Gateway along with most web frameworks like Node.js and Django. You can also install multiple integrations such as in polygot environments using a number of different tech stacks. Your server integration should be configured to also identify the user or company. For most gateway plugins, this is handled automatically. However, the SDKs provide and identifyUser or identifyCompany option to define how to extract this from your request context.

While not required, it’s strongly recommended to also sync your customer data to Moesif. This can include the user email, company name, subscription info, etc. Moesif has connectors for tools like Segment, Hubspot, and Stripe which can sync this data automatically. You can also send this data directly from your app using [moesif-browser-js] or via an API lib

Lastly, you can also install a client integration like moesif-broser-js to track web activity such as sign up events, viewing doc pages, etc. This ensures you can track the end-to-end customer journey from sign up to first API call.