1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/
import { resolve } from 'path';
import { UI_SETTINGS_CUSTOM_PDF_LOGO } from './common/constants';
import { mirrorPluginStatus } from '../../server/lib/mirror_plugin_status';
import { main as mainRoutes } from './server/routes/main';
import { jobs as jobRoutes } from './server/routes/jobs';
import { createQueueFactory } from './server/lib/create_queue';
import { config as appConfig } from './server/config/config';
import { checkLicenseFactory } from './server/lib/check_license';
import { validateConfig } from './server/lib/validate_config';
import { exportTypesRegistryFactory } from './server/lib/export_types_registry';
import { createBrowserDriverFactory, getDefaultBrowser, getDefaultChromiumSandboxDisabled } from './server/browsers';
import { logConfiguration } from './log_configuration';
import { callClusterFactory } from '../xpack_main';
import { getReportingUsageCollector } from './server/usage';
const kbToBase64Length = (kb) => {
return Math.floor((kb * 1024 * 8) / 6);
};
export const reporting = (kibana) => {
return new kibana.Plugin({
id: 'reporting',
configPrefix: 'xpack.reporting',
publicDir: resolve(__dirname, 'public'),
require: ['kibana', 'elasticsearch', 'xpack_main'],
uiExports: {
navbarExtensions: [
'plugins/reporting/controls/discover',
'plugins/reporting/controls/visualize',
'plugins/reporting/controls/dashboard',
],
hacks: [ 'plugins/reporting/hacks/job_completion_notifier'],
home: ['plugins/reporting/register_feature'],
managementSections: ['plugins/reporting/views/management'],
injectDefaultVars(server, options) {
return {
reportingPollConfig: options.poll
};
},
uiSettingDefaults: {
[UI_SETTINGS_CUSTOM_PDF_LOGO]: {
name: 'PDF footer image',
value: null,
description: `Custom image to use in the PDF's footer`,
type: 'image',
options: {
maxSize: {
length: kbToBase64Length(200),
description: '200 kB',
}
},
category: ['reporting'],
}
}
},
config: async function (Joi) {
return Joi.object({
enabled: Joi.boolean().default(true),
kibanaServer: Joi.object({
protocol: Joi.string().valid(['http', 'https']),
hostname: Joi.string(),
port: Joi.number().integer()
}).default(),
queue: Joi.object({
indexInterval: Joi.string().default('week'),
pollInterval: Joi.number().integer().default(3000),
pollIntervalErrorMultiplier: Joi.number().integer().default(10),
timeout: Joi.number().integer().default(30000),
}).default(),
capture: Joi.object({
record: Joi.boolean().default(false),
zoom: Joi.number().integer().default(2),
viewport: Joi.object({
width: Joi.number().integer().default(1950),
height: Joi.number().integer().default(1200)
}).default(),
timeout: Joi.number().integer().default(20000), //deprecated
loadDelay: Joi.number().integer().default(3000),
settleTime: Joi.number().integer().default(1000), //deprecated
concurrency: Joi.number().integer().default(appConfig.concurrency), //deprecated
browser: Joi.object({
type: Joi.any().valid('phantom', 'chromium').default(await getDefaultBrowser()),
autoDownload: Joi.boolean().when('$dev', {
is: true,
then: Joi.default(true),
otherwise: Joi.default(false),
}),
chromium: Joi.object({
disableSandbox: Joi.boolean().default(await getDefaultChromiumSandboxDisabled()),
proxy: Joi.object({
enabled: Joi.boolean().default(false),
server: Joi.string().uri({ scheme: ['http', 'https'] }).when('enabled', {
is: Joi.valid(false),
then: Joi.valid(null),
else: Joi.required()
}),
bypass: Joi.array().items(Joi.string().regex(/^[^\s]+$/)).when('enabled', {
is: Joi.valid(false),
then: Joi.valid(null),
else: Joi.default([])
})
}).default(),
maxScreenshotDimension: Joi.number().integer().default(1950)
}).default()
}).default()
}).default(),
csv: Joi.object({
maxSizeBytes: Joi.number().integer().default(1024 * 1024 * 10), // bytes in a kB * kB in a mB * 10
scroll: Joi.object({
duration: Joi.string().regex(/^[0-9]+(d|h|m|s|ms|micros|nanos)$/, { name: 'DurationString' }).default('30s'),
size: Joi.number().integer().default(500)
}).default(),
}).default(),
encryptionKey: Joi.string(),
roles: Joi.object({
allow: Joi.array().items(Joi.string()).default(['reporting_user']),
}).default(),
index: Joi.string().default('.reporting'),
poll: Joi.object({
jobCompletionNotifier: Joi.object({
interval: Joi.number().integer().default(10000),
intervalErrorMultiplier: Joi.number().integer().default(5)
}).default(),
jobsRefresh: Joi.object({
interval: Joi.number().integer().default(5000),
intervalErrorMultiplier: Joi.number().integer().default(5)
}).default(),
}).default(),
}).default();
},
init: async function (server) {
const exportTypesRegistry = await exportTypesRegistryFactory(server);
server.expose('exportTypesRegistry', exportTypesRegistry);
const config = server.config();
validateConfig(config, message => server.log(['reporting', 'warning'], message));
logConfiguration(config, message => server.log(['reporting', 'debug'], message));
const { xpack_main: xpackMainPlugin, monitoring: monitoringPlugin } = server.plugins;
mirrorPluginStatus(xpackMainPlugin, this);
const checkLicense = checkLicenseFactory(exportTypesRegistry);
xpackMainPlugin.status.once('green', () => {
// Register a function that is called whenever the xpack info changes,
// to re-compute the license check results for this plugin
xpackMainPlugin.info.feature(this.id).registerLicenseCheckResultsGenerator(checkLicense);
});
// Register a function to with Monitoring to manage the collection of usage stats
monitoringPlugin && monitoringPlugin.status.once('green', () => {
if (monitoringPlugin.collectorSet) {
const callCluster = callClusterFactory(server).getCallClusterInternal(); // uses callWithInternal as this is for internal collection
monitoringPlugin.collectorSet.register(getReportingUsageCollector(server, callCluster));
}
});
server.expose('browserDriverFactory', await createBrowserDriverFactory(server));
server.expose('queue', createQueueFactory(server));
// Reporting routes
mainRoutes(server);
jobRoutes(server);
},
deprecations: function ({ unused }) {
return [
unused("capture.concurrency"),
unused("capture.timeout"),
unused("capture.settleTime"),
unused("kibanaApp"),
];
},
});
};
|
