github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

[7.x] Exclude usage stats when exclude_usage flag is specified (#35691) (#35700)

Browse source 
* Exclude usage stats when `exclude_usage` flag is specified

* Entirely excluding the usage key altogether

* Adding API integration test

* Fixing param name in comment + adding more info to comment

* Fix API test copy-pasta

* Fixing test assertion syntax
This commit is contained in:
Shaunak Kashyap 2019-04-27 01:06:02 -07:00 • committed by GitHub
parent f1e388ef2c
commit f81263da8e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

19
src/legacy/server/status/routes/api/register_stats.js
View file

@ -25,11 +25,12 @@ import { KIBANA_STATS_TYPE } from '../../constants';
/*
* API for Kibana meta info and accumulated operations stats
* Including ?extended in the query string fetches Elasticsearch cluster_uuid and server.usage.collectorSet data
* - Requests to set isExtended = true
* GET /api/stats?extended=true
* GET /api/stats?extended
* - No value or 'false' is isExtended = false
* - Any other value causes a statusCode 400 response (Bad Request)
* - Requests to set isExtended = true
* GET /api/stats?extended=true
* GET /api/stats?extended
* - No value or 'false' is isExtended = false
* - Any other value causes a statusCode 400 response (Bad Request)
* Including ?exclude_usage in the query string excludes the usage stats from the response. Same value semantics as ?extended
*/
export function registerStatsApi(kbnServer, server, config) {
const wrapAuth = wrapAuthConfig(config.get('status.allowAnonymous'));
@ -53,7 +54,8 @@ export function registerStatsApi(kbnServer, server, config) {
validate: {
query: Joi.object({
extended: Joi.string().valid('', 'true', 'false'),
legacy: Joi.string().valid('', 'true', 'false')
legacy: Joi.string().valid('', 'true', 'false'),
exclude_usage: Joi.string().valid('', 'true', 'false'),
})
},
tags: ['api'],
@ -61,14 +63,17 @@ export function registerStatsApi(kbnServer, server, config) {
async handler(req) {
const isExtended = req.query.extended !== undefined && req.query.extended !== 'false';
const isLegacy = req.query.legacy !== undefined && req.query.legacy !== 'false';
const shouldGetUsage = req.query.exclude_usage === undefined || req.query.exclude_usage === 'false';
let extended;
if (isExtended) {
const { callWithRequest } = req.server.plugins.elasticsearch.getCluster('admin');
const callCluster = (...args) => callWithRequest(req, ...args);
const usagePromise = shouldGetUsage ? getUsage(callCluster) : Promise.resolve();
try {
const [ usage, clusterUuid ] = await Promise.all([
getUsage(callCluster),
usagePromise,
getClusterUuid(callCluster),
]);

12
test/api_integration/apis/stats/stats.js
View file

@ -118,6 +118,18 @@ export default function ({ getService }) {
});
});
});
describe('exclude usage', () => {
it('should exclude usage from the API response', () => {
return supertest
.get('/api/stats?extended&exclude_usage')
.expect('Content-Type', /json/)
.expect(200)
.then(({ body }) => {
expect(body).to.not.have.property('usage');
});
});
});
});
});
}