mirror of
https://github.com/elastic/kibana.git
synced 2025-04-18 23:21:39 -04:00
1137 lines
No EOL
41 KiB
JSON
1137 lines
No EOL
41 KiB
JSON
{
|
|
"id": "@kbn/ci-stats-reporter",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsReporter",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "CiStatsReporter",
|
|
"description": [
|
|
"Object that helps report data to the ci-stats service"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsReporter.fromEnv",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "fromEnv",
|
|
"description": [
|
|
"\nCreate a CiStatsReporter by inspecting the ENV for the necessary config"
|
|
],
|
|
"signature": [
|
|
"(log: ",
|
|
{
|
|
"pluginId": "@kbn/some-dev-log",
|
|
"scope": "common",
|
|
"docId": "kibKbnSomeDevLogPluginApi",
|
|
"section": "def-common.SomeDevLog",
|
|
"text": "SomeDevLog"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "@kbn/ci-stats-reporter",
|
|
"scope": "common",
|
|
"docId": "kibKbnCiStatsReporterPluginApi",
|
|
"section": "def-common.CiStatsReporter",
|
|
"text": "CiStatsReporter"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsReporter.fromEnv.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "log",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/some-dev-log",
|
|
"scope": "common",
|
|
"docId": "kibKbnSomeDevLogPluginApi",
|
|
"section": "def-common.SomeDevLog",
|
|
"text": "SomeDevLog"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsReporter.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsReporter.Unnamed.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ci-stats-core",
|
|
"scope": "common",
|
|
"docId": "kibKbnCiStatsCorePluginApi",
|
|
"section": "def-common.Config",
|
|
"text": "Config"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsReporter.Unnamed.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "log",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/some-dev-log",
|
|
"scope": "common",
|
|
"docId": "kibKbnSomeDevLogPluginApi",
|
|
"section": "def-common.SomeDevLog",
|
|
"text": "SomeDevLog"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsReporter.isEnabled",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isEnabled",
|
|
"description": [
|
|
"\nDetermine if CI_STATS is explicitly disabled by the environment. To determine\nif the CiStatsReporter has enough information in the environment to send metrics\nfor builds use #hasBuildConfig()."
|
|
],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsReporter.hasBuildConfig",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "hasBuildConfig",
|
|
"description": [
|
|
"\nDetermines if the CiStatsReporter is disabled by the environment, or properly\nconfigured and able to send stats"
|
|
],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsReporter.timings",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "timings",
|
|
"description": [
|
|
"\nReport timings data to the ci-stats service. If running in CI then the reporter\nwill include the buildId in the report with the access token, otherwise the timings\ndata will be recorded as anonymous timing data."
|
|
],
|
|
"signature": [
|
|
"(options: ",
|
|
{
|
|
"pluginId": "@kbn/ci-stats-reporter",
|
|
"scope": "common",
|
|
"docId": "kibKbnCiStatsReporterPluginApi",
|
|
"section": "def-common.TimingsOptions",
|
|
"text": "TimingsOptions"
|
|
},
|
|
") => Promise<boolean | undefined>"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsReporter.timings.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ci-stats-reporter",
|
|
"scope": "common",
|
|
"docId": "kibKbnCiStatsReporterPluginApi",
|
|
"section": "def-common.TimingsOptions",
|
|
"text": "TimingsOptions"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsReporter.metrics",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "metrics",
|
|
"description": [
|
|
"\nReport metrics data to the ci-stats service. If running outside of CI this method\ndoes nothing as metrics can only be reported when associated with a specific CI build."
|
|
],
|
|
"signature": [
|
|
"(metrics: ",
|
|
{
|
|
"pluginId": "@kbn/ci-stats-reporter",
|
|
"scope": "common",
|
|
"docId": "kibKbnCiStatsReporterPluginApi",
|
|
"section": "def-common.CiStatsMetric",
|
|
"text": "CiStatsMetric"
|
|
},
|
|
"[], options?: ",
|
|
{
|
|
"pluginId": "@kbn/ci-stats-reporter",
|
|
"scope": "common",
|
|
"docId": "kibKbnCiStatsReporterPluginApi",
|
|
"section": "def-common.MetricsOptions",
|
|
"text": "MetricsOptions"
|
|
},
|
|
" | undefined) => Promise<boolean | undefined>"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsReporter.metrics.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "metrics",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ci-stats-reporter",
|
|
"scope": "common",
|
|
"docId": "kibKbnCiStatsReporterPluginApi",
|
|
"section": "def-common.CiStatsMetric",
|
|
"text": "CiStatsMetric"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsReporter.metrics.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ci-stats-reporter",
|
|
"scope": "common",
|
|
"docId": "kibKbnCiStatsReporterPluginApi",
|
|
"section": "def-common.MetricsOptions",
|
|
"text": "MetricsOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsReporter.reportTests",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportTests",
|
|
"description": [
|
|
"\nSend test reports to ci-stats"
|
|
],
|
|
"signature": [
|
|
"({ group, testRuns }: ",
|
|
{
|
|
"pluginId": "@kbn/ci-stats-reporter",
|
|
"scope": "common",
|
|
"docId": "kibKbnCiStatsReporterPluginApi",
|
|
"section": "def-common.CiStatsReportTestsOptions",
|
|
"text": "CiStatsReportTestsOptions"
|
|
},
|
|
") => Promise<void>"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsReporter.reportTests.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ group, testRuns }",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ci-stats-reporter",
|
|
"scope": "common",
|
|
"docId": "kibKbnCiStatsReporterPluginApi",
|
|
"section": "def-common.CiStatsReportTestsOptions",
|
|
"text": "CiStatsReportTestsOptions"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsReporter.reportPerformanceMetrics",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "reportPerformanceMetrics",
|
|
"description": [],
|
|
"signature": [
|
|
"(metrics: ",
|
|
"PerformanceMetrics",
|
|
") => Promise<boolean | undefined>"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsReporter.reportPerformanceMetrics.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "metrics",
|
|
"description": [],
|
|
"signature": [
|
|
"PerformanceMetrics"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.getTimeReporter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getTimeReporter",
|
|
"description": [],
|
|
"signature": [
|
|
"(log: ",
|
|
{
|
|
"pluginId": "@kbn/tooling-log",
|
|
"scope": "common",
|
|
"docId": "kibKbnToolingLogPluginApi",
|
|
"section": "def-common.ToolingLog",
|
|
"text": "ToolingLog"
|
|
},
|
|
", group: string) => (startTime: number, id: string, meta: Record<string, any>) => Promise<void>"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/report_time.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.getTimeReporter.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "log",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/tooling-log",
|
|
"scope": "common",
|
|
"docId": "kibKbnToolingLogPluginApi",
|
|
"section": "def-common.ToolingLog",
|
|
"text": "ToolingLog"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/report_time.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.getTimeReporter.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "group",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/report_time.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsMetric",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CiStatsMetric",
|
|
"description": [
|
|
"A ci-stats metric record"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsMetric.group",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "group",
|
|
"description": [
|
|
"Top-level categorization for the metric, e.g. \"page load bundle size\""
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsMetric.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"Specific sub-set of the \"group\", e.g. \"dashboard\""
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsMetric.value",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [
|
|
"integer value recorded as the value of this metric"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsMetric.limit",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "limit",
|
|
"description": [
|
|
"optional limit which will generate an error on PRs when the metric exceeds the limit"
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsMetric.limitConfigPath",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "limitConfigPath",
|
|
"description": [
|
|
"\npath, relative to the repo, where the config file containing limits\nis kept. Linked from PR comments instructing contributors how to fix\ntheir PRs."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsMetric.meta",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "meta",
|
|
"description": [
|
|
"Arbitrary key-value pairs which can be used for additional filtering/reporting"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ci-stats-core",
|
|
"scope": "common",
|
|
"docId": "kibKbnCiStatsCorePluginApi",
|
|
"section": "def-common.CiStatsMetadata",
|
|
"text": "CiStatsMetadata"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsReportTestsOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CiStatsReportTestsOptions",
|
|
"description": [
|
|
"Options for reporting tests to ci-stats"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsReportTestsOptions.group",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "group",
|
|
"description": [
|
|
"\nInformation about the group of tests that were run"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ci-stats-reporter",
|
|
"scope": "common",
|
|
"docId": "kibKbnCiStatsReporterPluginApi",
|
|
"section": "def-common.CiStatsTestGroupInfo",
|
|
"text": "CiStatsTestGroupInfo"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsReportTestsOptions.testRuns",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "testRuns",
|
|
"description": [
|
|
"\nInformation about each test that ran, including failure information"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ci-stats-reporter",
|
|
"scope": "common",
|
|
"docId": "kibKbnCiStatsReporterPluginApi",
|
|
"section": "def-common.CiStatsTestRun",
|
|
"text": "CiStatsTestRun"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestGroupInfo",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CiStatsTestGroupInfo",
|
|
"description": [],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestGroupInfo.startTime",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "startTime",
|
|
"description": [
|
|
"\nISO-8601 formatted datetime representing when the group of tests started running"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestGroupInfo.durationMs",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "durationMs",
|
|
"description": [
|
|
"\nThe number of miliseconds that the tests ran for"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestGroupInfo.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"\nThe type of tests run in this group, any value is valid but test groups are groupped by type in the UI so use something consistent"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestGroupInfo.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [
|
|
"\nThe name of this specific group (within the \"type\")"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestGroupInfo.result",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "result",
|
|
"description": [
|
|
"\nOverall result of this test group"
|
|
],
|
|
"signature": [
|
|
"\"skip\" | \"fail\" | \"pass\""
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestGroupInfo.meta",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "meta",
|
|
"description": [
|
|
"\nArbitrary metadata associated with this group. We currently look for a ciGroup metadata property for highlighting that when appropriate"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ci-stats-core",
|
|
"scope": "common",
|
|
"docId": "kibKbnCiStatsCorePluginApi",
|
|
"section": "def-common.CiStatsMetadata",
|
|
"text": "CiStatsMetadata"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestRun",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CiStatsTestRun",
|
|
"description": [],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestRun.startTime",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "startTime",
|
|
"description": [
|
|
"\nISO-8601 formatted datetime representing when the tests started running"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestRun.durationMs",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "durationMs",
|
|
"description": [
|
|
"\nDuration of the tests in milliseconds"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestRun.seq",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "seq",
|
|
"description": [
|
|
"\nA sequence number, this is used to order the tests in a specific test run"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestRun.type",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"\nThe type of this \"test run\", usually this is just \"test\" but when reporting issues in hooks it can be set to the type of hook"
|
|
],
|
|
"signature": [
|
|
"\"after all hook\" | \"after each hook\" | \"before all hook\" | \"before each hook\" | \"test\""
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestRun.result",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "result",
|
|
"description": [
|
|
"\n\"fail\", \"pass\" or \"skip\", the result of the tests"
|
|
],
|
|
"signature": [
|
|
"\"skip\" | \"fail\" | \"pass\""
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestRun.suites",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "suites",
|
|
"description": [
|
|
"\nThe list of suite names containing this test, the first being the outermost suite"
|
|
],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestRun.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [
|
|
"\nThe name of this specific test run"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestRun.file",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "file",
|
|
"description": [
|
|
"\nRelative path from the root of the repo contianing this test"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestRun.error",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "error",
|
|
"description": [
|
|
"\nError message if the test failed"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestRun.stdout",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "stdout",
|
|
"description": [
|
|
"\nDebug output/stdout produced by the test"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestRun.screenshots",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "screenshots",
|
|
"description": [
|
|
"\nScreenshots captured during the test run"
|
|
],
|
|
"signature": [
|
|
"{ name: string; base64Png: string; }[] | undefined"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTiming",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CiStatsTiming",
|
|
"description": [
|
|
"A ci-stats timing event"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTiming.group",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "group",
|
|
"description": [
|
|
"Top-level categorization for the timing, e.g. \"scripts/foo\", process type, etc."
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTiming.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"Specific timing (witin the \"group\" being tracked) e.g. \"total\""
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTiming.ms",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "ms",
|
|
"description": [
|
|
"time in milliseconds which should be recorded"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTiming.meta",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "meta",
|
|
"description": [
|
|
"hash of key-value pairs which will be stored with the timing for additional filtering and reporting"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ci-stats-core",
|
|
"scope": "common",
|
|
"docId": "kibKbnCiStatsCorePluginApi",
|
|
"section": "def-common.CiStatsMetadata",
|
|
"text": "CiStatsMetadata"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.MetricsOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "MetricsOptions",
|
|
"description": [
|
|
"Options for reporting metrics to ci-stats"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.MetricsOptions.defaultMeta",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "defaultMeta",
|
|
"description": [
|
|
"Default metadata to add to each metric"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ci-stats-core",
|
|
"scope": "common",
|
|
"docId": "kibKbnCiStatsCorePluginApi",
|
|
"section": "def-common.CiStatsMetadata",
|
|
"text": "CiStatsMetadata"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.TimingsOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "TimingsOptions",
|
|
"description": [
|
|
"Options for reporting timings to ci-stats"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.TimingsOptions.timings",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "timings",
|
|
"description": [
|
|
"list of timings to record"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/ci-stats-reporter",
|
|
"scope": "common",
|
|
"docId": "kibKbnCiStatsReporterPluginApi",
|
|
"section": "def-common.CiStatsTiming",
|
|
"text": "CiStatsTiming"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.TimingsOptions.upstreamBranch",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "upstreamBranch",
|
|
"description": [
|
|
"master, 7.x, etc, automatically detected from package.json if not specified"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.TimingsOptions.kibanaUuid",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "kibanaUuid",
|
|
"description": [
|
|
"value of data/uuid, automatically loaded if not specified"
|
|
],
|
|
"signature": [
|
|
"string | null | undefined"
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestResult",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "CiStatsTestResult",
|
|
"description": [],
|
|
"signature": [
|
|
"\"skip\" | \"fail\" | \"pass\""
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/ci-stats-reporter",
|
|
"id": "def-common.CiStatsTestType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "CiStatsTestType",
|
|
"description": [],
|
|
"signature": [
|
|
"\"after all hook\" | \"after each hook\" | \"before all hook\" | \"before each hook\" | \"test\""
|
|
],
|
|
"path": "src/platform/packages/private/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |