With Engine, you can get a birds-eye view of your GraphQL API delivered on a daily basis to the Slack channel of your choice. Here’s what an Engine Slack report looks like:
In this docs page, we’ll go over how to set up reports for a service in Engine, and how to use some of the data presented in the report.
Setting up reports
First, go to the Settings page of your service, then scroll down to the Integrations section. Next, enabled the toggle switch next to Daily Slack Reports.
After enabling Daily Slack Reports, you’ll see a pop-up like below:
Now, let’s follow the directions in the pop-up to set up a service.
- Visit the Incoming Webhooks app for your team.
- Select the channel you want Engine to post to.
- Click “Add Incoming Webhooks Integration”.
- Copy the “Webhook URL” on the next screen.
- Paste it into the “Slack Webhook URL” field in the form in the Engine UI.
- Click “Update”.
At this point, you should receive a confirmation message from Engine in the Slack channel you selected, that looks much like this:
After confirmation, the first report should appear up in the configured Slack channel within 24 hours, and additional reports should be delivered each day at 9am Pacific time.
If you don’t receive the confirmation or the report doesn’t show up after 24 hours, please reach out to support so we can help you get things set up!
Using the report
We’ve constructed the report provided to give you an actionable summary of what’s happened in your API in the last 24 hours. Here’s how you can use it to identify issues:
- Request rate: This shows you how many queries are hitting your server every minute, along with a list of the most popular operations. If you see a huge dip in this and it’s usually a busy time for your app, it might mean that queries aren’t able to reach your server, or some client is down.
- p95 service time: This shows you how long queries are taking to execute. We selected p95 since it’s the best overall representation of how your users are experiencing your app. You can use this to identify that your API is overloaded and users are seeing long loading delays, or to find out which queries are taking the longest to run. This is usually directly connected to UI performance, so a 500ms query probably means some part of your UI is taking that long to display.
- Error percentage: This will show you how many of your GraphQL requests end up with an error result. Spikes in errors might be the result of some underlying backend malfunctioning. You can also see which of your operations are most error-prone.
Getting operation details
Each operation that appears in the report is a link, so you can get right from the report in Slack to the relevant view in Engine to get more details about the issue. For example, you might want to look at the trace view to debug a performance problem, or the error page to get the message and reproduction info for a common error.