[Screenshotting] instrument for benchmark tests using new EventLogger class

[tsullivan]

This PR follows the model of using a central event logger that was set by Reporting in #124762, and integrates APM within the logger.

Summary

We want benchmarks on basic stats encountered by the screenshotting plugin when it runs a screenshot operation.

See JSON logging format, and ECS data documentation: https://www.elastic.co/guide/en/kibana/master/logging-configuration.html#json-layout

Logging configuration

To test this PR, use the following logging configuration in the kibana.yml file. As you create test screenshot reports, the kibana.log file will be populated with data that Filebeat can ingest.

logging:
  appenders.file:
    type: file
    fileName: kibana.log
    layout.type: json
  loggers:
    - name: plugins.screenshotting
      appenders: [file]
      level: debug

Checklist

Delete any items that are not applicable to this PR.

• Unit or functional tests were updated or added to match the most common scenarios
• Test APM data
• Report errors to APM

Example logs

{ "message": "screenshot-pipeline starting",
  "kibana": {
    "screenshotting": {
      "action": "screenshot-pipeline-start",
      "session_id": "fdb42c7b-505b-4676-9a5c-6bb1a8971167"
    }
  },
  "event": { "provider": "screenshotting" },
  "ecs": { "version": "8.0.0" },
  "@timestamp": "2022-04-18T11:03:46.219-07:00",
  "log": {
    "level": "DEBUG",
    "logger": "plugins.screenshotting.events"
  },
  "process": { "pid": 428095 },
  "trace": { "id": "140f9fa09315b0dcc196dd91443798c5" },
  "transaction": { "id": "ae31694f8944d22e" } }

{ "message": "opening url",
  "kibana": {
    "screenshotting": {
      "action": "open-url-start",
      "session_id": "fdb42c7b-505b-4676-9a5c-6bb1a8971167"
    }
  },
  "event": { "provider": "screenshotting" },
  "ecs": { "version": "8.0.0" },
  "@timestamp": "2022-04-18T11:03:46.309-07:00",
  "log": {
    "level": "DEBUG",
    "logger": "plugins.screenshotting.events"
  },
  "process": { "pid": 428095 },
  "span": { "id": "04eb3a42cf4cda22" },
  "trace": { "id": "140f9fa09315b0dcc196dd91443798c5" } }

{ "message": "finished opening url",
  "kibana": {
    "screenshotting": {
      "action": "open-url-complete",
      "session_id": "fdb42c7b-505b-4676-9a5c-6bb1a8971167"
    }
  },
  "event": {
    "duration": 2448,
    "provider": "screenshotting"
  },
  "ecs": { "version": "8.0.0" },
  "@timestamp": "2022-04-18T11:03:48.757-07:00",
  "log": {
    "level": "DEBUG",
    "logger": "plugins.screenshotting.events"
  },
  "process": { "pid": 428095 },
  "trace": { "id": "140f9fa09315b0dcc196dd91443798c5" },
  "transaction": { "id": "ae31694f8944d22e" } }

{ "message": "getting number of visualization items",
  "kibana": {
    "screenshotting": {
      "action": "get-number-of-items-start",
      "session_id": "fdb42c7b-505b-4676-9a5c-6bb1a8971167"
    }
  },
  "event": { "provider": "screenshotting" },
  "ecs": { "version": "8.0.0" },
  "@timestamp": "2022-04-18T11:03:48.757-07:00",
  "log": {
    "level": "DEBUG",
    "logger": "plugins.screenshotting.events"
  },
  "process": { "pid": 428095 },
  "span": { "id": "68006204c8c9114b" },
  "trace": { "id": "140f9fa09315b0dcc196dd91443798c5" } }

{ "message": "received number of visualization items",
  "kibana": {
    "screenshotting": {
      "action": "get-number-of-items-complete",
      "items_count": 13,
      "session_id": "fdb42c7b-505b-4676-9a5c-6bb1a8971167"
    }
  },
  "event": {
    "duration": 1045,
    "provider": "screenshotting"
  },
  "ecs": { "version": "8.0.0" },
  "@timestamp": "2022-04-18T11:03:49.802-07:00",
  "log": {
    "level": "DEBUG",
    "logger": "plugins.screenshotting.events"
  },
  "process": { "pid": 428095 },
  "span": { "id": "04eb3a42cf4cda22" },
  "trace": { "id": "140f9fa09315b0dcc196dd91443798c5" } }

[elasticmachine]

Pinging @elastic/kibana-app-services (Team:AppServicesUx)

[jloleysens]

Thanks for addressing my feedback @tsullivan ! This is looking really great. I did not test this locally (thanks for adding the tests!)

[tsullivan]

@elasticmachine merge upstream

[kibana-ci]

💚 Build Succeeded

• Buildkite Build
• Commit: 9f05bdc
• Storybooks Preview
• Webpack Bundle Analyzer

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
screenshotting	7	8	+1

Unknown metric groups

API count

id	before	after	diff
screenshotting	27	28	+1

History

• 💚 Build #42266 succeeded ec1ea15
• 💚 Build #42234 succeeded c8a7b74
• 💚 Build #41953 succeeded bc461f3
• 💚 Build #39661 succeeded 195b108
• 💔 Build #39658 failed 295d2a94c3c8c390cc0215f69644cad2ed0d1d14
• 💔 Build #39653 failed a410ec48ca44f4226a409f684aee322864b6fb96

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