|
| 1 | +[[ci-metrics]] |
| 2 | +== CI Metrics |
| 3 | + |
| 4 | +In addition to running our tests, CI collects metrics about the Kibana build. These metrics are sent to an external service to track changes over time, and to provide PR authors insights into the impact of their changes. |
| 5 | + |
| 6 | + |
| 7 | +[[ci-metric-types]] |
| 8 | +=== Metric types |
| 9 | + |
| 10 | + |
| 11 | +[[ci-metric-types-bundle-size-metrics]] |
| 12 | +==== Bundle size |
| 13 | + |
| 14 | +These metrics help contributors know how they are impacting the size of the bundles Kibana creates, and help make sure that Kibana loads as fast as possible. |
| 15 | + |
| 16 | +[[ci-metric-page-load-bundle-size]] `page load bundle size` :: |
| 17 | +The size of the entry file produced for each bundle/plugin. This file is always loaded on every page load, so it should be as small as possible. To reduce this metric you can put any code that isn't necessary on every page load behind an https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import#Dynamic_Imports[`async import()`]. |
| 18 | ++ |
| 19 | +Code that is shared statically with other plugins will contribute to the `page load bundle size` of that plugin. This includes exports from the `public/index.ts` file and any file referenced by the `extraPublicDirs` manifest property. |
| 20 | + |
| 21 | +[[ci-metric-async-chunks-size]] `async chunks size` :: |
| 22 | +An "async chunk" is created for the files imported by each https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import#Dynamic_Imports[`async import()`] statement. This metric tracks the sum size of these chunks, in bytes, broken down by plugin/bundle id. You can think of this as the amount of code users will have to download if they access all the components/applications within a bundle. |
| 23 | + |
| 24 | +[[ci-metric-misc-asset-size]] `miscellaneous assets size` :: |
| 25 | +A "miscellaneous asset" is anything that isn't an async chunk or entry chunk, often images. This metric tracks the sum size of these assets, in bytes, broken down by plugin/bundle id. |
| 26 | + |
| 27 | +[[ci-metric-bundle-module-count]] `@kbn/optimizer bundle module count` :: |
| 28 | +The number of separate modules included in each bundle/plugin. This is the best indicator we have for how long a specific bundle will take to be built by the `@kbn/optimizer`, so we report it to help people know when they've imported a module which might include a surprising number of sub-modules. |
| 29 | + |
| 30 | + |
| 31 | +[[ci-metric-types-distributable-size]] |
| 32 | +==== Distributable size |
| 33 | + |
| 34 | +The size of the Kibana distributable is an essential metric as it not only contributes to the time it takes to download, but it also impacts time it takes to extract the archive once downloaded. |
| 35 | + |
| 36 | +There are several metrics that we don't report on PRs because gzip-compression produces different file sizes even when provided the same input, so this metric would regularly show changes even though PR authors hadn't made any relevant changes. |
| 37 | + |
| 38 | +All metrics are collected from the `tar.gz` archive produced for the linux platform. |
| 39 | + |
| 40 | +[[ci-metric-distributable-file-count]] `distributable file count` :: |
| 41 | +The number of files included in the default distributable. |
| 42 | + |
| 43 | +[[ci-metric-oss-distributable-file-count]] `oss distributable file count` :: |
| 44 | +The number of files included in the OSS distributable. |
| 45 | + |
| 46 | +[[ci-metric-distributable-size]] `distributable size` :: |
| 47 | +The size, in bytes, of the default distributable. _(not reported on PRs)_ |
| 48 | + |
| 49 | +[[ci-metric-oss-distributable-size]] `oss distributable size` :: |
| 50 | +The size, in bytes, of the OSS distributable. _(not reported on PRs)_ |
| 51 | + |
| 52 | + |
| 53 | +[[ci-metric-types-saved-object-field-counts]] |
| 54 | +==== Saved Object field counts |
| 55 | + |
| 56 | +Elasticsearch limits the number of fields in an index to 1000 by default, and we want to avoid raising that limit. |
| 57 | + |
| 58 | +[[ci-metric-saved-object-field-count]] `Saved Objects .kibana field count` :: |
| 59 | +The number of saved object fields broken down by saved object type. |
| 60 | + |
| 61 | + |
| 62 | +[[ci-metric-adding-new-metrics]] |
| 63 | +=== Adding new metrics |
| 64 | + |
| 65 | +You can report new metrics by using the `CiStatsReporter` class provided by the `@kbn/dev-utils` package. This class is automatically configured on CI and its methods noop when running outside of CI. For more details checkout the {kib-repo}blob/{branch}/packages/kbn-dev-utils/src/ci_stats_reporter[`CiStatsReporter` readme]. |
0 commit comments