[Synthetics] Increase project API payload limit

[shahzad31]

Summary

Increase synthetics monitors project push API payload limit to 20MB !!

[awahab07]

Tested the PR by pushing browser monitors with various payloads. Kibana server did error out when payload exceeded the limit. However, on my machine, Kibana server times out when payload is closer to (but less than) 20 MB.

Monitor 1 Payload	Monitor 1 Bundle	Monitor 2 Pyalod	Monitor 2 Bundle	Result	Observation
25MB	18.80MB	-	-		Restricted by Kibana Server
20MB	15.04MB	-	-		Restricted by Kibana Server
18MB	13.54MB	-	-		Timed out
15MB	11.28MB	-	-	-	Pushed successfully 👍
8MB	6.02MB	8MB	6.02MB	-	Pushed successfully 👍
10MB	7.52MB	8MB	6.02MB		Timed out
9MB	6.77MB	8MB	6.02MB	-	Pushed successfully 👍

Based on the above results, it LGTM.

How did I test

Since @elastic/synthetics also restricts pushing a monitor with > 800KB bundle size (per monitor), I changed the limit to 20 MB when testing a single monitor and 10MB when testing two monitors. I changed here.

I used the following node script to generate a random string payload in MBs

// helpers/generate-payload.js
const fs = require('fs');
const path = require('path');
const size = Number(process.argv[2]);

if(isNaN(size) || size <= 0) {
  console.error(`Error: Provide a valid size in MBs e.g. \`node ../generate-payload.js 20\` for 20 MB payload.`);
}

const payload = genPayload(size * 1024 * 1024);
const exportScript = `export const payload = '${payload}';`;
const outputPath = path.resolve(__dirname, `./payload-${size}MB.ts`);
fs.writeFileSync(outputPath, exportScript, { flag: 'w+' });
console.info(`Successfully written payload of ${size}MB to ${outputPath}`);

function genPayload(length) {
  const characters       = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
  const charactersLength = characters.length;

  let result = '';
  for ( let i = 0; i < length; i++ ) {
    result += characters.charAt(Math.floor(Math.random() * charactersLength));
  }
  return result;
}

e.g. Usage

$node <dir-path>/synthetics/examples/push-project-07/helpers/generate-payload.js 9

# Successfully written payload of 9MB to <dir-path>/synthetics/examples/push-project-07/helpers/payload-9MB.ts

The monitor script

// journeys/payload-01.journey.ts
import { journey, step, monitor, expect } from '@elastic/synthetics';

import { payload } from '../helpers/payload-9MB';

journey('Payload Test 01', ({ page, params }) => {
  // Only relevant for the push command to create
  // monitors in Kibana
  monitor.use({
    id: 'payload-test-001',
    schedule: 10,
  });

  step('Goto Amazon', async () => {
    await page.goto(params.url);
  });

  step('Search', async () => {
    await page.locator('#twotabsearchtextbox').type(payload);
  });
});

[elasticmachine]

Pinging @elastic/uptime (Team:uptime)

[vigneshshanmugam]

nit: this is MiB not MB

[jloleysens]

Did not test locally, code changes make sense. Thanks @shahzad31 !

[jloleysens]

nit+question: looks like we can combine this type import with @kbn/core/server?

not actually sure which to use now that there are two sources from which the same types can be imported, I guess we should trend toward using the types from the package @kbn/core-http-server?

[shahzad31]

I will leave it up to the experts on this :)
I guess once everything migrates to packages, this will be auto resolved?

[kibana-ci]

💚 Build Succeeded

• Buildkite Build
• Commit: d27952d

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
bfetch	71	72	+1

Unknown metric groups

API count

id	before	after	diff
bfetch	80	81	+1

History

• 💔 Build #77818 failed 623bf00
• 💛 Build #76842 was flaky 1b9b2a2
• 💔 Build #76586 failed c10c008a353a82dec0c5e264cc0f3036c985e6e9

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @shahzad31

[kibanamachine]

💚 All backports created successfully

Status	Branch	Result
✅	8.5

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation