forked from elastic/kibana
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Synthtrace] Support Non-ECS Logs (elastic#191086)
closes [3759](elastic/observability-dev#3759) ## 📝 Summary This PR creates a new scenario with different non ECS fields as below : - log.level-> severity - message -> msg - service.name -> svc - host.name -> hostname - New field: thisisaverylongfieldnamethatevendoesnotcontainanyspaceswhyitcouldpotentiallybreakouruiinseveralplaces The above fields are applied with different variances as below : - In DSNS data stream with @timestamp - Outside of DSNS with @timestamp (e.g. cloud-logs-*, etc.) - Outside of DSNS without @timestamp (replaced by “date”) ## 🎥 Demo `node scripts/synthtrace simple_non_ecs_logs.ts` https://github.com/user-attachments/assets/d86cadeb-fd2a-4c42-8dfe-0375ecfd9622
- Loading branch information
1 parent
243b4fa
commit 913b8f3
Showing
6 changed files
with
225 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
17 changes: 17 additions & 0 deletions
17
packages/kbn-apm-synthtrace/src/lib/logs/custom_logsdb_indices.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| import type { MappingTypeMapping } from '@elastic/elasticsearch/lib/api/types'; | ||
|
|
||
| export const timestampDateMapping: MappingTypeMapping = { | ||
| properties: { | ||
| '@timestamp': { | ||
| type: 'date', | ||
| }, | ||
| }, | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
161 changes: 161 additions & 0 deletions
161
packages/kbn-apm-synthtrace/src/scenarios/simple_non_ecs_logs.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
| import { | ||
| LogDocument, | ||
| log, | ||
| generateShortId, | ||
| generateLongId, | ||
| LONG_FIELD_NAME, | ||
| } from '@kbn/apm-synthtrace-client'; | ||
| import moment from 'moment'; | ||
| import { Scenario } from '../cli/scenario'; | ||
| import { IndexTemplateName } from '../lib/logs/custom_logsdb_index_templates'; | ||
| import { withClient } from '../lib/utils/with_client'; | ||
| import { | ||
| getServiceName, | ||
| getCluster, | ||
| getCloudProvider, | ||
| getCloudRegion, | ||
| } from './helpers/logs_mock_data'; | ||
| import { parseLogsScenarioOpts } from './helpers/logs_scenario_opts_parser'; | ||
| import { timestampDateMapping } from '../lib/logs/custom_logsdb_indices'; | ||
|
|
||
| // Logs Data logic | ||
| const MESSAGE_LOG_LEVELS = [ | ||
| { message: 'A simple log with something random <random> in the middle', level: 'info' }, | ||
| { message: 'Yet another debug log', level: 'debug' }, | ||
| { message: 'Error with certificate: "ca_trusted_fingerprint"', level: 'error' }, | ||
| ]; | ||
|
|
||
| const scenario: Scenario<LogDocument> = async (runOptions) => { | ||
| const { isLogsDb } = parseLogsScenarioOpts(runOptions.scenarioOpts); | ||
|
|
||
| const constructLogsCommonData = () => { | ||
| const index = Math.floor(Math.random() * 3); | ||
| const serviceName = getServiceName(index); | ||
| const { message, level } = MESSAGE_LOG_LEVELS[index]; | ||
| const { clusterId, clusterName, namespace } = getCluster(index); | ||
| const cloudRegion = getCloudRegion(index); | ||
|
|
||
| const commonLongEntryFields: LogDocument = { | ||
| 'trace.id': generateShortId(), | ||
| 'agent.name': 'nodejs', | ||
| 'orchestrator.cluster.name': clusterName, | ||
| 'orchestrator.cluster.id': clusterId, | ||
| 'orchestrator.namespace': namespace, | ||
| 'container.name': `${serviceName}-${generateShortId()}`, | ||
| 'orchestrator.resource.id': generateShortId(), | ||
| 'cloud.provider': getCloudProvider(), | ||
| 'cloud.region': cloudRegion, | ||
| 'cloud.availability_zone': `${cloudRegion}a`, | ||
| 'cloud.project.id': generateShortId(), | ||
| 'cloud.instance.id': generateShortId(), | ||
| 'log.file.path': `/logs/${generateLongId()}/error.txt`, | ||
| severity: level, | ||
| svc: serviceName, | ||
| msg: message.replace('<random>', generateShortId()), | ||
| [LONG_FIELD_NAME]: 'test', | ||
| }; | ||
|
|
||
| return { | ||
| index, | ||
| serviceName, | ||
| cloudRegion, | ||
| commonLongEntryFields, | ||
| }; | ||
| }; | ||
|
|
||
| return { | ||
| bootstrap: async ({ logsEsClient }) => { | ||
| await logsEsClient.createIndex('cloud-logs-synth.1-default', timestampDateMapping); | ||
| await logsEsClient.createIndex('cloud-logs-synth.2-default'); | ||
| if (isLogsDb) await logsEsClient.createIndexTemplate(IndexTemplateName.LogsDb); | ||
| }, | ||
| generate: ({ range, clients: { logsEsClient } }) => { | ||
| const { logger } = runOptions; | ||
|
|
||
| const logsWithNonEcsFields = range | ||
| .interval('1m') | ||
| .rate(1) | ||
| .generator((timestamp) => { | ||
| return Array(3) | ||
| .fill(0) | ||
| .map(() => { | ||
| const { commonLongEntryFields } = constructLogsCommonData(); | ||
|
|
||
| return log | ||
| .create({ isLogsDb }) | ||
| .deleteField('host.name') | ||
| .defaults({ | ||
| ...commonLongEntryFields, | ||
| hostname: 'synth-host', | ||
| }) | ||
| .dataset('custom.synth') | ||
| .timestamp(timestamp); | ||
| }); | ||
| }); | ||
|
|
||
| const logsOutsideDsnsWithTimestamp = range | ||
| .interval('1m') | ||
| .rate(1) | ||
| .generator((timestamp) => { | ||
| return Array(3) | ||
| .fill(0) | ||
| .map(() => { | ||
| const { commonLongEntryFields } = constructLogsCommonData(); | ||
|
|
||
| return log | ||
| .create({ isLogsDb }) | ||
| .deleteField('host.name') | ||
| .deleteField('data_stream.type') | ||
| .defaults({ | ||
| ...commonLongEntryFields, | ||
| 'data_stream.type': 'cloud-logs', | ||
| hostname: 'synth-host1', | ||
| }) | ||
| .dataset('synth.1') | ||
| .timestamp(timestamp); | ||
| }); | ||
| }); | ||
|
|
||
| const logsOutsideDsnsWithoutTimestamp = range | ||
| .interval('1m') | ||
| .rate(1) | ||
| .generator((timestamp) => { | ||
| return Array(3) | ||
| .fill(0) | ||
| .map(() => { | ||
| const { commonLongEntryFields } = constructLogsCommonData(); | ||
|
|
||
| return log | ||
| .create({ isLogsDb }) | ||
| .deleteField('host.name') | ||
| .deleteField('data_stream.type') | ||
| .defaults({ | ||
| ...commonLongEntryFields, | ||
| hostname: 'synth-host2', | ||
| 'data_stream.type': 'cloud-logs', | ||
| date: moment(timestamp).toDate(), | ||
| }) | ||
| .dataset('synth.2'); | ||
| }); | ||
| }); | ||
|
|
||
| return withClient( | ||
| logsEsClient, | ||
| logger.perf('generating_logs', () => [ | ||
| logsWithNonEcsFields, | ||
| logsOutsideDsnsWithTimestamp, | ||
| logsOutsideDsnsWithoutTimestamp, | ||
| ]) | ||
| ); | ||
| }, | ||
| }; | ||
| }; | ||
|
|
||
| export default scenario; |