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.

Sign up for GitHub

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

[Fleet] Add preset_counts to agent_per_output_type telemetry #172838

Merged
merged 3 commits into from
Dec 7, 2023
Merged

[Fleet] Add preset_counts to agent_per_output_type telemetry #172838

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aa8b5ae
Add preset_counts to agent_per_output_type telemetry
kpollich Dec 7, 2023
52efb79
Update usage telemetry test
kpollich Dec 7, 2023
8a98ce0
Update preset logic per code review
kpollich Dec 7, 2023
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
34 changes: 31 additions & 3 deletions x-pack/plugins/fleet/server/collectors/agents_per_output.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,13 @@ jest.mock('../services', () => {
{ agents: 1, data_output_id: 'logstash1' },
{ agents: 1, monitoring_output_id: 'kafka1' },
{ agents: 1, data_output_id: 'elasticsearch2', monitoring_output_id: 'elasticsearch2' },
{ agents: 1, data_output_id: 'elasticsearch3', monitoring_output_id: 'elasticsearch3' },
{
agents: 1,
data_output_id: 'es-containerhost',
monitoring_output_id: 'es-containerhost',
},
{ agents: 1, data_output_id: 'remote-es', monitoring_output_id: 'remote-es' },
],
}),
},
Expand All @@ -35,11 +37,14 @@ jest.mock('../services', () => {
is_default: true,
is_default_monitoring: true,
type: 'elasticsearch',
preset: 'balanced',
},
{ id: 'logstash1', type: 'logstash' },
{ id: 'kafka1', type: 'kafka' },
{ id: 'elasticsearch2', type: 'elasticsearch' },
{ id: 'es-containerhost', type: 'elasticsearch' },
{ id: 'elasticsearch2', type: 'elasticsearch', preset: 'custom' },
{ id: 'elasticsearch3', type: 'elasticsearch', preset: 'balanced' },
{ id: 'es-containerhost', type: 'elasticsearch', preset: 'throughput' },
{ id: 'remote-es', type: 'remote_elasticsearch', preset: 'scale' },
],
}),
},
Expand All @@ -52,9 +57,32 @@ describe('agents_per_output', () => {
it('should return agent count by output type', async () => {
const res = await getAgentsPerOutput(soClientMock, {} as unknown as ElasticsearchClient);
expect(res).toEqual([
{ output_type: 'elasticsearch', count_as_data: 4, count_as_monitoring: 4 },
{
output_type: 'elasticsearch',
count_as_data: 5,
count_as_monitoring: 5,
preset_counts: {
custom: 1,
balanced: 2,
throughput: 1,
scale: 0,
latency: 0,
},
},
{ output_type: 'logstash', count_as_data: 1, count_as_monitoring: 0 },
{ output_type: 'kafka', count_as_data: 0, count_as_monitoring: 1 },
{
output_type: 'remote_elasticsearch',
count_as_data: 1,
count_as_monitoring: 1,
preset_counts: {
custom: 0,
balanced: 0,
throughput: 0,
scale: 1,
latency: 0,
},
},
]);
});
});
76 changes: 59 additions & 17 deletions x-pack/plugins/fleet/server/collectors/agents_per_output.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,26 @@
*/

import type { ElasticsearchClient, SavedObjectsClientContract } from '@kbn/core/server';

import _ from 'lodash';

import { outputTypeSupportPresets } from '../../common/services/output_helpers';
import type { AgentPolicy } from '../../common/types';

import { SO_SEARCH_LIMIT } from '../../common';
import { agentPolicyService, outputService } from '../services';

export interface AgentsPerOutputType {
output_type: string;
count_as_data: number;
count_as_monitoring: number;
preset_counts?: {
balanced: number;
custom: number;
latency: number;
scale: number;
throughput: number;
};
}

export async function getAgentsPerOutput(
Expand All @@ -28,38 +39,69 @@ export async function getAgentsPerOutput(
outputs.find((output) => output.is_default_monitoring)?.id || '';

const outputsById = _.keyBy(outputs, 'id');
const getOutputTypeById = (outputId: string): string => outputsById[outputId]?.type ?? '';
const getDataOutputForAgentPolicy = (agentPolicy: AgentPolicy) =>
outputsById[agentPolicy.data_output_id || defaultOutputId];
const getMonitoringOutputForAgentPolicy = (agentPolicy: AgentPolicy) =>
outputsById[agentPolicy.monitoring_output_id || defaultMonitoringOutputId];

const { items } = await agentPolicyService.list(soClient, {
const { items: agentPolicies } = await agentPolicyService.list(soClient, {
esClient,
withAgentCount: true,
page: 1,
perPage: SO_SEARCH_LIMIT,
});

const outputTypes: { [key: string]: AgentsPerOutputType } = {};
items
.filter((item) => (item.agents ?? 0) > 0)
.forEach((item) => {
const dataOutputType = getOutputTypeById(item.data_output_id || defaultOutputId);
if (!outputTypes[dataOutputType]) {
outputTypes[dataOutputType] = {
output_type: dataOutputType,

agentPolicies
.filter((agentPolicy) => (agentPolicy.agents ?? 0) > 0)
.forEach((agentPolicy) => {
const dataOutput = getDataOutputForAgentPolicy(agentPolicy);
const monitoringOutput = getMonitoringOutputForAgentPolicy(agentPolicy);

if (!outputTypes[dataOutput.type]) {
outputTypes[dataOutput.type] = {
output_type: dataOutput.type,
count_as_data: 0,
count_as_monitoring: 0,
};
}
outputTypes[dataOutputType].count_as_data += item.agents ?? 0;
const monitoringOutputType = getOutputTypeById(
item.monitoring_output_id || defaultMonitoringOutputId
);
if (!outputTypes[monitoringOutputType]) {
outputTypes[monitoringOutputType] = {
output_type: monitoringOutputType,

outputTypes[dataOutput.type].count_as_data += agentPolicy.agents ?? 0;

if (!outputTypes[monitoringOutput.type]) {
outputTypes[monitoringOutput.type] = {
output_type: monitoringOutput.type,
count_as_data: 0,
count_as_monitoring: 0,
};
}
outputTypes[monitoringOutputType].count_as_monitoring += item.agents ?? 0;
outputTypes[monitoringOutput.type].count_as_monitoring += agentPolicy.agents ?? 0;
});

outputs.forEach((output) => {
if (!outputTypeSupportPresets(output.type)) {
return;
}

const outputTelemetryRecord = outputTypes[output.type];

if (!outputTelemetryRecord.preset_counts) {
outputTelemetryRecord.preset_counts = {
balanced: 0,
custom: 0,
latency: 0,
scale: 0,
throughput: 0,
};
}

['balanced', 'custom', 'latency', 'scale', 'throughput'].forEach((preset) => {
kpollich marked this conversation as resolved.
Show resolved Hide resolved
if (output.preset === preset) {
outputTelemetryRecord.preset_counts![preset] += 1;
}
});
});

return Object.values(outputTypes);
}
73 changes: 66 additions & 7 deletions x-pack/plugins/fleet/server/integration_tests/fleet_usage_telemetry.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,20 @@ describe('fleet usage telemetry', () => {
active: true,
policy_id: 'policy2',
},
{
create: {
_id: 'agent4',
},
},
{
agent: {
version: '8.6.0',
},
last_checkin_status: 'online',
last_checkin: new Date(Date.now() - 1000 * 60 * 6).toISOString(),
active: true,
policy_id: 'policy3',
},
],
refresh: 'wait_for',
});
Expand Down Expand Up @@ -361,6 +375,21 @@ describe('fleet usage telemetry', () => {
},
{ id: 'output3' }
);
await soClient.create(
'ingest-outputs',
{
name: 'output4',
type: 'elasticsearch',
hosts: ['http://localhost:9200'],
is_default: false,
is_default_monitoring: false,
config_yaml: '',
ca_trusted_fingerprint: '',
proxy_id: null,
preset: 'balanced',
},
{ id: 'output4' }
);

await soClient.create(
'ingest-agent-policies',
Expand All @@ -380,6 +409,24 @@ describe('fleet usage telemetry', () => {
},
{ id: 'policy2' }
);
await soClient.create(
'ingest-agent-policies',
{
namespace: 'default',
monitoring_enabled: ['logs', 'metrics'],
name: 'Yet another policy',
description: 'Policy 3',
inactivity_timeout: 1209600,
status: 'active',
is_managed: false,
revision: 2,
updated_by: 'system',
schema_version: '1.0.0',
data_output_id: 'output4',
monitoring_output_id: 'output4',
},
{ id: 'policy3' }
);
});

afterAll(async () => {
Expand All @@ -397,13 +444,13 @@ describe('fleet usage telemetry', () => {
expect.objectContaining({
agents_enabled: true,
agents: {
total_enrolled: 3,
total_enrolled: 4,
healthy: 0,
unhealthy: 0,
inactive: 0,
unenrolled: 1,
offline: 3,
total_all_statuses: 4,
offline: 4,
total_all_statuses: 5,
updating: 0,
},
fleet_server: {
Expand All @@ -419,10 +466,10 @@ describe('fleet usage telemetry', () => {
agents_per_version: [
{
version: '8.6.0',
count: 2,
count: 3,
healthy: 0,
inactive: 0,
offline: 2,
offline: 3,
unenrolled: 0,
unhealthy: 0,
updating: 0,
Expand All @@ -439,7 +486,7 @@ describe('fleet usage telemetry', () => {
},
],
agent_checkin_status: { error: 1, degraded: 1 },
agents_per_policy: [2, 1],
agents_per_policy: [2, 1, 1],
agents_per_os: [
{
name: 'Ubuntu',
Expand All @@ -463,6 +510,18 @@ describe('fleet usage telemetry', () => {
count_as_monitoring: 1,
output_type: 'logstash',
},
{
count_as_data: 1,
count_as_monitoring: 1,
output_type: 'elasticsearch',
preset_counts: {
balanced: 2,
custom: 0,
latency: 0,
scale: 0,
throughput: 0,
},
},
],
fleet_server_config: {
policies: [
Expand All @@ -477,7 +536,7 @@ describe('fleet usage telemetry', () => {
],
},
agent_policies: {
count: 2,
count: 3,
output_types: expect.arrayContaining(['elasticsearch', 'logstash', 'third_type']),
},
agent_logs_panics_last_hour: [
Expand Down
43 changes: 43 additions & 0 deletions x-pack/plugins/fleet/server/services/telemetry/fleet_usages_schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,49 @@ export const fleetAgentsSchema: RootSchema<any> = {
description: 'Output type used by agent',
},
},
presets_counts: {
_meta: {
description: 'Count of agents per preset',
},
properties: {
balanced: {
type: 'long',
_meta: {
description: 'Number of agents enrolled whose output uses the balanced preset',
},
},
custom: {
type: 'long',
_meta: {
description: 'Number of agents enrolled whose outputs uses the custom preset',
},
},
throughput: {
type: 'long',
_meta: {
description: 'Number of agents enrolled whose output uses the throughput preset',
},
},
scale: {
type: 'long',
_meta: {
description: 'Number of agents enrolled whose output uses the scale preset',
},
},
latency: {
type: 'long',
_meta: {
description: 'Number of agents enrolled whose output uses the latency preset',
},
},
},
},
output_preset: {
type: 'keyword',
_meta: {
description: 'Output preset used by agent, if applicable',
},
},
count_as_data: {
type: 'long',
_meta: {
Expand Down