Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Monitoring] Kibana settings api #21100

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions x-pack/plugins/xpack_main/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import {
CONFIG_TELEMETRY,
CONFIG_TELEMETRY_DESC,
} from './common/constants';
import { settingsRoute } from './server/routes/api/v1/settings';

export { callClusterFactory } from './server/lib/call_cluster_factory';

Expand Down Expand Up @@ -110,6 +111,7 @@ export const xpackMain = (kibana) => {
// register routes
xpackInfoRoute(server);
telemetryRoute(server);
settingsRoute(server, this.kbnServer);
}
});
};
50 changes: 50 additions & 0 deletions x-pack/plugins/xpack_main/server/routes/api/v1/settings.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/*
* 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 { wrap as wrapError } from 'boom';
import { KIBANA_SETTINGS_TYPE } from '../../../../../monitoring/common/constants';
import { getKibanaInfoForStats } from '../../../../../monitoring/server/kibana_monitoring/lib';

const getClusterUuid = async callCluster => {
const { cluster_uuid: uuid } = await callCluster('info', { filterPath: 'cluster_uuid', });
return uuid;
};

export function settingsRoute(server, kbnServer) {
server.route({
path: '/api/settings',
method: 'GET',
async handler(req, reply) {
const { server } = req;
const { callWithRequest } = server.plugins.elasticsearch.getCluster('data');
const callCluster = (...args) => callWithRequest(req, ...args); // All queries from HTTP API must use authentication headers from the request

try {
const { collectorSet } = server.usage;
const settingsCollector = collectorSet.getCollectorByType(KIBANA_SETTINGS_TYPE);

const settings = await settingsCollector.fetch(callCluster);
const uuid = await getClusterUuid(callCluster);

const kibana = getKibanaInfoForStats(server, kbnServer);
reply({
cluster_uuid: uuid,
settings: {
...settings,
kibana,
}
});
} catch(err) {
req.log(['error'], err); // FIXME doesn't seem to log anything useful if ES times out
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this FIXME for addressing in this PR itself or a follow up PR?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question. It's a comment copied over from the other api endpoint. Let's say it will be addressed in a follow up PR

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suspect the follow PR would need to address this problem everywhere

if (err.isBoom) {
reply(err);
} else {
reply(wrapError(err, err.statusCode, err.message));
}
}
}
});
}
1 change: 1 addition & 0 deletions x-pack/test/api_integration/apis/xpack_main/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@
export default function ({ loadTestFile }) {
describe('xpack_main', () => {
loadTestFile(require.resolve('./telemetry'));
loadTestFile(require.resolve('./settings'));
});
}
11 changes: 11 additions & 0 deletions x-pack/test/api_integration/apis/xpack_main/settings/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/*
* 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.
*/

export default function ({ loadTestFile }) {
describe('Settings', () => {
loadTestFile(require.resolve('./settings'));
});
}
42 changes: 42 additions & 0 deletions x-pack/test/api_integration/apis/xpack_main/settings/settings.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/*
* 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 expect from 'expect.js';

export default function ({ getService }) {
const supertest = getService('supertest');
const esArchiver = getService('esArchiver');

describe('/api/settings', () => {
describe('with trial license clusters', () => {
const archive = 'monitoring/multicluster';

before('load clusters archive', () => {
return esArchiver.load(archive);
});

after('unload clusters archive', () => {
return esArchiver.unload(archive);
});

it('should load multiple clusters', async () => {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

description should be different :)

const { body } = await supertest
.get('/api/settings')
.set('kbn-xsrf', 'xxx')
.expect(200);
expect(body.cluster_uuid.length > 1).to.eql(true);
expect(body.settings.kibana.uuid.length > 0).to.eql(true);
expect(body.settings.kibana.name.length > 0).to.eql(true);
expect(body.settings.kibana.index.length > 0).to.eql(true);
expect(body.settings.kibana.host.length > 0).to.eql(true);
expect(body.settings.kibana.transport_address.length > 0).to.eql(true);
expect(body.settings.kibana.version.length > 0).to.eql(true);
expect(body.settings.kibana.status.length > 0).to.eql(true);
});
});
});
}