-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch '7.x' into backport/7.x/pr-115355
- Loading branch information
Showing
49 changed files
with
1,394 additions
and
355 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| # @elastic/apm-generator | ||
|
|
||
| `@elastic/apm-generator` is an experimental tool to generate synthetic APM data. It is intended to be used for development and testing of the Elastic APM app in Kibana. | ||
|
|
||
| At a high-level, the module works by modeling APM events/metricsets with [a fluent API](https://en.wikipedia.org/wiki/Fluent_interface). The models can then be serialized and converted to Elasticsearch documents. In the future we might support APM Server as an output as well. | ||
|
|
||
| ## Usage | ||
|
|
||
| This section assumes that you've installed Kibana's dependencies by running `yarn kbn bootstrap` in the repository's root folder. | ||
|
|
||
| This library can currently be used in two ways: | ||
|
|
||
| - Imported as a Node.js module, for instance to be used in Kibana's functional test suite. | ||
| - With a command line interface, to index data based on some example scenarios. | ||
|
|
||
| ### Using the Node.js module | ||
|
|
||
| #### Concepts | ||
|
|
||
| - `Service`: a logical grouping for a monitored service. A `Service` object contains fields like `service.name`, `service.environment` and `agent.name`. | ||
| - `Instance`: a single instance of a monitored service. E.g., the workload for a monitored service might be spread across multiple containers. An `Instance` object contains fields like `service.node.name` and `container.id`. | ||
| - `Timerange`: an object that will return an array of timestamps based on an interval and a rate. These timestamps can be used to generate events/metricsets. | ||
| - `Transaction`, `Span`, `APMError` and `Metricset`: events/metricsets that occur on an instance. For more background, see the [explanation of the APM data model](https://www.elastic.co/guide/en/apm/get-started/7.15/apm-data-model.html) | ||
|
|
||
|
|
||
| #### Example | ||
|
|
||
| ```ts | ||
| import { service, timerange, toElasticsearchOutput } from '@elastic/apm-generator'; | ||
|
|
||
| const instance = service('synth-go', 'production', 'go') | ||
| .instance('instance-a'); | ||
|
|
||
| const from = new Date('2021-01-01T12:00:00.000Z').getTime(); | ||
| const to = new Date('2021-01-01T12:00:00.000Z').getTime() - 1; | ||
|
|
||
| const traceEvents = timerange(from, to) | ||
| .interval('1m') | ||
| .rate(10) | ||
| .flatMap(timestamp => instance.transaction('GET /api/product/list') | ||
| .timestamp(timestamp) | ||
| .duration(1000) | ||
| .success() | ||
| .children( | ||
| instance.span('GET apm-*/_search', 'db', 'elasticsearch') | ||
| .timestamp(timestamp + 50) | ||
| .duration(900) | ||
| .destination('elasticsearch') | ||
| .success() | ||
| ).serialize() | ||
| ); | ||
|
|
||
| const metricsets = timerange(from, to) | ||
| .interval('30s') | ||
| .rate(1) | ||
| .flatMap(timestamp => instance.appMetrics({ | ||
| 'system.memory.actual.free': 800, | ||
| 'system.memory.total': 1000, | ||
| 'system.cpu.total.norm.pct': 0.6, | ||
| 'system.process.cpu.total.norm.pct': 0.7, | ||
| }).timestamp(timestamp) | ||
| .serialize() | ||
| ); | ||
|
|
||
| const esEvents = toElasticsearchOutput(traceEvents.concat(metricsets)); | ||
| ``` | ||
|
|
||
| #### Generating metricsets | ||
|
|
||
| `@elastic/apm-generator` can also automatically generate transaction metrics, span destination metrics and transaction breakdown metrics based on the generated trace events. If we expand on the previous example: | ||
|
|
||
| ```ts | ||
| import { getTransactionMetrics, getSpanDestinationMetrics, getBreakdownMetrics } from '@elastic/apm-generator'; | ||
|
|
||
| const esEvents = toElasticsearchOutput([ | ||
| ...traceEvents, | ||
| ...getTransactionMetrics(traceEvents), | ||
| ...getSpanDestinationMetrics(traceEvents), | ||
| ...getBreakdownMetrics(traceEvents) | ||
| ]); | ||
| ``` | ||
|
|
||
| ### CLI | ||
|
|
||
| Via the CLI, you can upload examples. The supported examples are listed in `src/lib/es.ts`. A `--target` option that specifies the Elasticsearch URL should be defined when running the `example` command. Here's an example: | ||
|
|
||
| `$ node packages/elastic-apm-generator/src/scripts/es.js example simple-trace --target=http://admin:changeme@localhost:9200` | ||
|
|
||
| The following options are supported: | ||
| - `to`: the end of the time range, in ISO format. By default, the current time will be used. | ||
| - `from`: the start of the time range, in ISO format. By default, `to` minus 15 minutes will be used. | ||
| - `apm-server-version`: the version used in the index names bootstrapped by APM Server, e.g. `7.16.0`. __If these indices do not exist, the script will exit with an error. It will not bootstrap the indices itself.__ | ||
|
|
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
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
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
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
47 changes: 47 additions & 0 deletions
47
x-pack/plugins/apm/public/components/app/Settings/schema/migrated/card_footer_content.tsx
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,47 @@ | ||
| /* | ||
| * 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; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import { EuiButton, EuiSpacer, EuiText } from '@elastic/eui'; | ||
| import { i18n } from '@kbn/i18n'; | ||
| import { FormattedMessage } from '@kbn/i18n/react'; | ||
| import React from 'react'; | ||
| import { APMLink } from '../../../../shared/Links/apm/APMLink'; | ||
| import { useFleetCloudAgentPolicyHref } from '../../../../shared/Links/kibana'; | ||
|
|
||
| export function CardFooterContent() { | ||
| const fleetCloudAgentPolicyHref = useFleetCloudAgentPolicyHref(); | ||
|
|
||
| return ( | ||
| <div> | ||
| <EuiButton href={fleetCloudAgentPolicyHref}> | ||
| {i18n.translate( | ||
| 'xpack.apm.settings.schema.success.viewIntegrationInFleet.buttonText', | ||
| { defaultMessage: 'View the APM integration in Fleet' } | ||
| )} | ||
| </EuiButton> | ||
| <EuiSpacer size="xs" /> | ||
| <EuiText size="s"> | ||
| <p> | ||
| <FormattedMessage | ||
| id="xpack.apm.settings.schema.success.returnText" | ||
| defaultMessage="or simply return to the {serviceInventoryLink}." | ||
| values={{ | ||
| serviceInventoryLink: ( | ||
| <APMLink path="/services"> | ||
| {i18n.translate( | ||
| 'xpack.apm.settings.schema.success.returnText.serviceInventoryLink', | ||
| { defaultMessage: 'Service inventory' } | ||
| )} | ||
| </APMLink> | ||
| ), | ||
| }} | ||
| /> | ||
| </p> | ||
| </EuiText> | ||
| </div> | ||
| ); | ||
| } |
30 changes: 30 additions & 0 deletions
30
.../plugins/apm/public/components/app/Settings/schema/migrated/successful_migration_card.tsx
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,30 @@ | ||
| /* | ||
| * 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; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import { EuiCard, EuiIcon } from '@elastic/eui'; | ||
| import { i18n } from '@kbn/i18n'; | ||
| import React from 'react'; | ||
| import { CardFooterContent } from './card_footer_content'; | ||
|
|
||
| export function SuccessfulMigrationCard() { | ||
| return ( | ||
| <EuiCard | ||
| icon={<EuiIcon size="xxl" type="checkInCircleFilled" color="success" />} | ||
| title={i18n.translate('xpack.apm.settings.schema.success.title', { | ||
| defaultMessage: 'Elastic Agent successfully setup!', | ||
| })} | ||
| description={i18n.translate( | ||
| 'xpack.apm.settings.schema.success.description', | ||
| { | ||
| defaultMessage: | ||
| 'Your APM integration is now setup and ready to receive data from your currently instrumented agents. Feel free to review the policies applied to your integtration.', | ||
| } | ||
| )} | ||
| footer={<CardFooterContent />} | ||
| /> | ||
| ); | ||
| } |
51 changes: 51 additions & 0 deletions
51
x-pack/plugins/apm/public/components/app/Settings/schema/migrated/upgrade_available_card.tsx
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,51 @@ | ||
| /* | ||
| * 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; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import { EuiCard, EuiIcon, EuiLink } from '@elastic/eui'; | ||
| import { i18n } from '@kbn/i18n'; | ||
| import { FormattedMessage } from '@kbn/i18n/react'; | ||
| import React from 'react'; | ||
| import { useUpgradeApmPackagePolicyHref } from '../../../../shared/Links/kibana'; | ||
| import { CardFooterContent } from './card_footer_content'; | ||
|
|
||
| export function UpgradeAvailableCard({ | ||
| apmPackagePolicyId, | ||
| }: { | ||
| apmPackagePolicyId: string | undefined; | ||
| }) { | ||
| const upgradeApmPackagePolicyHref = | ||
| useUpgradeApmPackagePolicyHref(apmPackagePolicyId); | ||
|
|
||
| return ( | ||
| <EuiCard | ||
| icon={<EuiIcon size="xxl" type="alert" color="warning" />} | ||
| title={i18n.translate( | ||
| 'xpack.apm.settings.schema.upgradeAvailable.title', | ||
| { | ||
| defaultMessage: 'APM integration upgrade available!', | ||
| } | ||
| )} | ||
| description={ | ||
| <FormattedMessage | ||
| id="xpack.apm.settings.upgradeAvailable.description" | ||
| defaultMessage="Even though your APM integration is setup, a new version of the APM integration is available for upgrade with your package policy. {upgradePackagePolicyLink} to get the most out of your setup." | ||
| values={{ | ||
| upgradePackagePolicyLink: ( | ||
| <EuiLink href={upgradeApmPackagePolicyHref}> | ||
| {i18n.translate( | ||
| 'xpack.apm.settings.schema.upgradeAvailable.upgradePackagePolicyLink', | ||
| { defaultMessage: 'Upgrade your APM integration' } | ||
| )} | ||
| </EuiLink> | ||
| ), | ||
| }} | ||
| /> | ||
| } | ||
| footer={<CardFooterContent />} | ||
| /> | ||
| ); | ||
| } |
Oops, something went wrong.