feat: support cross-linking synthetics & apm

[vigneshshanmugam]

• fix [Proposal] Crosslinking Synthetics with APM #265

• Relies on the properties being injected from the Heartbeat side to make it work seamless.

• Adds support for crosslinking the Synthetics Waterfall information with the APM data to be able to understand the performance monitoring data across Elastic observability solutions. The key fields that are added to make the transition easier are

  • synthetics.monitor.id - monitor id of the synthetics monitor
  • syntheitcs.monitor.type - type of the synthetics monitor, can be browser or http
  • synthetics.trace.id - checkgroup/exec id that denotes execution of a journey at any point
  • synthetics.monitor.location - location id where the monitor was run from
  • tracestate: es=s:1 - Sampling decision is propagated via tracestate header which is understood by APM agents

• Adds the relevant headers only for the routes/urls that are configured via the apm.traceUrls. Sampling decision can also be propagated via apm.sampleRate. These options can be modified via CLI or Synthetics config file.

journey("test", () => {
   step("trace check", async() => {
      await page.goto("https://example.com")
   });
});

// config 
{
  "apm": { "traceUrls":  ["**/*"] } // add to all requests
}

// Headers
baggage: `synthetics.trace.id=<test>;synthetics.monitor.id=<test>;`
tracestate: `es=s:1`

• Env variables will be added by the Heartbeat to make this complete - [Heartbeat] Cross linking APM with Synthetics beats#36249

[ghost]

💔 Build Failed

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

• Start Time: 2022-09-14T06:01:55.758+0000

• Duration: 5 min 2 sec

Steps errors

Expand to view the steps failures

Checks linting

• Took 0 min 4 sec . View more details here
• Description: npm run-script lint

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

• /test : Re-trigger the build.

[syepes]

+1

[shahzad31]

@vigneshshanmugam is there a plan to revisit this?