2020-08-17 01:16:35 -07:00
|
|
|
const beeline = require("honeycomb-beeline")({
|
|
|
|
writeKey: process.env["HONEYCOMB_WRITE_KEY"],
|
|
|
|
dataset:
|
|
|
|
process.env["NODE_ENV"] === "production"
|
|
|
|
? "Dress to Impress (2020)"
|
|
|
|
: "Dress to Impress (2020, dev)",
|
|
|
|
serviceName: "impress-2020-gql-server",
|
Apply sampling rates to Honeycomb events
Oops, we get a _lot_ of outfit image requests, and it's pushing the limits of our free Honeycomb plan! But I don't really need all that much detail, because there's so many.
So, we here apply sampling! `api/outfitImage` is getting a 1/10 rate, and for GraphQL, `ApiOutfitImage` is getting 1/10, and `SearchPanel` is getting 1/5.
I had to add a `addTraceContext` call, to give all the child events awareness of what operation they're being called in, too!
I haven't actually tested that this is working-working, just that the endpoints still return good data. We'll see how it shakes out in prod!
But I did add `console.log(sampleRate, shouldSample, data);` to the `samplerHook` briefly, to see the data flow through, and I reloaded a `SearchPanel` request a few times and observed a plausibly 20% success rate.
2021-05-26 18:50:19 -07:00
|
|
|
samplerHook,
|
2020-08-17 01:16:35 -07:00
|
|
|
});
|
|
|
|
|
2021-11-01 22:25:43 -07:00
|
|
|
const { ApolloServer } = require("../../src/server/lib/apollo-server-vercel");
|
|
|
|
const { config } = require("../../src/server");
|
Apply sampling rates to Honeycomb events
Oops, we get a _lot_ of outfit image requests, and it's pushing the limits of our free Honeycomb plan! But I don't really need all that much detail, because there's so many.
So, we here apply sampling! `api/outfitImage` is getting a 1/10 rate, and for GraphQL, `ApiOutfitImage` is getting 1/10, and `SearchPanel` is getting 1/5.
I had to add a `addTraceContext` call, to give all the child events awareness of what operation they're being called in, too!
I haven't actually tested that this is working-working, just that the endpoints still return good data. We'll see how it shakes out in prod!
But I did add `console.log(sampleRate, shouldSample, data);` to the `samplerHook` briefly, to see the data flow through, and I reloaded a `SearchPanel` request a few times and observed a plausibly 20% success rate.
2021-05-26 18:50:19 -07:00
|
|
|
const crypto = require("crypto");
|
2020-04-22 13:03:32 -07:00
|
|
|
|
|
|
|
const server = new ApolloServer(config);
|
2020-08-17 01:16:35 -07:00
|
|
|
const serverHandler = server.createHandler();
|
|
|
|
|
Apply sampling rates to Honeycomb events
Oops, we get a _lot_ of outfit image requests, and it's pushing the limits of our free Honeycomb plan! But I don't really need all that much detail, because there's so many.
So, we here apply sampling! `api/outfitImage` is getting a 1/10 rate, and for GraphQL, `ApiOutfitImage` is getting 1/10, and `SearchPanel` is getting 1/5.
I had to add a `addTraceContext` call, to give all the child events awareness of what operation they're being called in, too!
I haven't actually tested that this is working-working, just that the endpoints still return good data. We'll see how it shakes out in prod!
But I did add `console.log(sampleRate, shouldSample, data);` to the `samplerHook` briefly, to see the data flow through, and I reloaded a `SearchPanel` request a few times and observed a plausibly 20% success rate.
2021-05-26 18:50:19 -07:00
|
|
|
// We apply different sampling rates for different GraphQL operations
|
|
|
|
// (according to the client-defined query name), depending on how much load
|
|
|
|
// we're getting on them. For most operations, we just save all the events, but
|
|
|
|
// especially heavy-load operations get a lower sampling rate!
|
|
|
|
const OPERATION_SAMPLE_RATES = {
|
|
|
|
ApiOutfitImage: 10, // save 1 out of every 10, ignore the others
|
|
|
|
SearchPanel: 5, // save 1 out of every 5, ignore the others
|
|
|
|
};
|
|
|
|
function samplerHook(data) {
|
|
|
|
// Use the sample rate from the table above.
|
|
|
|
// Defaults to 1 (all) for most operations.
|
|
|
|
let sampleRate = OPERATION_SAMPLE_RATES[data["app.operation_name"]] || 1;
|
|
|
|
|
|
|
|
// Use the `deterministicSampler` to decide whether this event should be
|
|
|
|
// sampled. This might be a child event of a higher-level trace, and we want
|
|
|
|
// to make sure that we always return all child events of traces we've
|
|
|
|
// sampled, and no child events of traces we haven't. Deterministically
|
|
|
|
// sampling by trace ID does this for us!
|
|
|
|
//
|
|
|
|
// This strategy is outlined in: https://docs.honeycomb.io/getting-data-in/javascript/beeline-nodejs/#sampling-events.
|
|
|
|
const shouldSample = deterministicSampler(data["trace.trace_id"], sampleRate);
|
|
|
|
|
|
|
|
return { shouldSample, sampleRate };
|
|
|
|
}
|
|
|
|
function deterministicSampler(traceId, sampleRate) {
|
|
|
|
// Copied from https://docs.honeycomb.io/getting-data-in/javascript/beeline-nodejs/#sampling-events
|
|
|
|
const MAX_UINT32 = Math.pow(2, 32) - 1;
|
|
|
|
const sum = crypto.createHash("sha1").update(traceId).digest();
|
|
|
|
const upperBound = (MAX_UINT32 / sampleRate) >>> 0;
|
|
|
|
return sum.readUInt32BE(0) <= upperBound;
|
|
|
|
}
|
|
|
|
|
2021-05-13 01:13:21 -07:00
|
|
|
async function handle(req, res) {
|
2021-05-27 16:41:52 -07:00
|
|
|
// CAREFUL! We here allow any website to use our GraphQL API, so our data can
|
|
|
|
// be more useful to the public. Using the * wildcard means that, in modern
|
|
|
|
// browsers, requests should be sent without credentials. Additionally, we
|
|
|
|
// don't store credentials in cookies; the client is responsible for setting
|
|
|
|
// an Authorization header. So, I don't think there's any CSRF danger here.
|
|
|
|
// But, let's be careful and make sure this continues to be true!
|
|
|
|
res.setHeader("Access-Control-Allow-Origin", "*");
|
|
|
|
|
2020-08-17 01:16:35 -07:00
|
|
|
await serverHandler(req, res);
|
|
|
|
|
|
|
|
// As a sneaky trick, we require the Honeycomb trace to finish before the
|
|
|
|
// request formally finishes. This... is technically a slowdown, I'm not sure
|
|
|
|
// how much of one. Hopefully not too much?
|
|
|
|
// https://vercel.com/docs/platform/limits#streaming-responses
|
|
|
|
await beeline.flush();
|
|
|
|
res.end();
|
2021-05-13 01:13:21 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
export default handle;
|