maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[APM] Move APM tutorial from apm_oss to x-pack/apm (#100780)

Browse source 
* Register tutorial on APM plugin

* using files from apm

* removing tutorial from apm_oss

* removing export

* fixing i18n

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
Cauê Marcondes 2021-05-28 15:43:30 -04:00 committed by GitHub
parent d50a3db2b1
commit 0bcd78b0e9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
20 changed files with 1219 additions and 1251 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/plugins/apm_oss/public/index.ts
View file

@ -14,5 +14,3 @@ export function plugin() {
return new ApmOssPlugin();
}
export { ApmOssPluginSetup, ApmOssPluginStart } from './types';
export { APM_STATIC_INDEX_PATTERN_ID } from '../common/index_pattern_constants';

18
src/plugins/apm_oss/server/index.ts
View file

@ -7,7 +7,6 @@
*/
import { schema, TypeOf } from '@kbn/config-schema';
import apmIndexPattern from './tutorial/index_pattern.json';
import { PluginInitializerContext } from '../../../core/server';
import { APMOSSPlugin } from './plugin';
@ -32,20 +31,3 @@ export function plugin(initializerContext: PluginInitializerContext) {
export type APMOSSConfig = TypeOf<typeof config.schema>;
export { APMOSSPluginSetup } from './plugin';
export { apmIndexPattern };
export { APM_STATIC_INDEX_PATTERN_ID } from '../common/index_pattern_constants';
export {
createNodeAgentInstructions,
createDjangoAgentInstructions,
createFlaskAgentInstructions,
createRailsAgentInstructions,
createRackAgentInstructions,
createJsAgentInstructions,
createGoAgentInstructions,
createJavaAgentInstructions,
createDotNetAgentInstructions,
createPhpAgentInstructions,
} from './tutorial/instructions/apm_agent_instructions';

27
src/plugins/apm_oss/server/plugin.ts
View file

@ -6,38 +6,18 @@
* Side Public License, v 1.
*/
import { Plugin, CoreSetup, PluginInitializerContext } from 'src/core/server';
import { Observable } from 'rxjs';
import { Plugin, PluginInitializerContext } from 'src/core/server';
import { APMOSSConfig } from './';
import { HomeServerPluginSetup, TutorialProvider } from '../../home/server';
import { tutorialProvider } from './tutorial';
export class APMOSSPlugin implements Plugin<APMOSSPluginSetup> {
constructor(private readonly initContext: PluginInitializerContext) {
this.initContext = initContext;
}
public setup(core: CoreSetup, plugins: { home: HomeServerPluginSetup }) {
public setup() {
const config$ = this.initContext.config.create<APMOSSConfig>();
const config = this.initContext.config.get<APMOSSConfig>();
const apmTutorialProvider = tutorialProvider({
indexPatternTitle: config.indexPattern,
indices: {
errorIndices: config.errorIndices,
metricsIndices: config.metricsIndices,
onboardingIndices: config.onboardingIndices,
sourcemapIndices: config.sourcemapIndices,
transactionIndices: config.transactionIndices,
},
});
plugins.home.tutorials.registerTutorial(apmTutorialProvider);
return {
config,
config$,
getRegisteredTutorialProvider: () => apmTutorialProvider,
};
return { config, config$ };
}
start() {}
@ -47,5 +27,4 @@ export class APMOSSPlugin implements Plugin<APMOSSPluginSetup> {
export interface APMOSSPluginSetup {
config: APMOSSConfig;
config$: Observable<APMOSSConfig>;
getRegisteredTutorialProvider(): TutorialProvider;
}

84
src/plugins/apm_oss/server/tutorial/index.ts
View file

@ -1,84 +0,0 @@
/*
* 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 { i18n } from '@kbn/i18n';
import { onPremInstructions } from './envs/on_prem';
import apmIndexPattern from './index_pattern.json';
import { ArtifactsSchema, TutorialsCategory } from '../../../../../src/plugins/home/server';
import { APM_STATIC_INDEX_PATTERN_ID } from '../../common/index_pattern_constants';
const apmIntro = i18n.translate('apmOss.tutorial.introduction', {
defaultMessage: 'Collect in-depth performance metrics and errors from inside your applications.',
});
const moduleName = 'apm';
export const tutorialProvider = ({
indexPatternTitle,
indices,
}: {
indexPatternTitle: string;
indices: {
errorIndices: string;
transactionIndices: string;
metricsIndices: string;
sourcemapIndices: string;
onboardingIndices: string;
};
}) => () => {
const savedObjects = [
{
...apmIndexPattern,
id: APM_STATIC_INDEX_PATTERN_ID,
attributes: {
...apmIndexPattern.attributes,
title: indexPatternTitle,
},
},
];
const artifacts: ArtifactsSchema = {
dashboards: [
{
id: '8d3ed660-7828-11e7-8c47-65b845b5cfb3',
linkLabel: i18n.translate('apmOss.tutorial.specProvider.artifacts.dashboards.linkLabel', {
defaultMessage: 'APM dashboard',
}),
isOverview: true,
},
],
};
return {
id: 'apm',
name: i18n.translate('apmOss.tutorial.specProvider.name', {
defaultMessage: 'APM',
}),
moduleName,
category: TutorialsCategory.OTHER,
shortDescription: apmIntro,
longDescription: i18n.translate('apmOss.tutorial.specProvider.longDescription', {
defaultMessage:
'Application Performance Monitoring (APM) collects in-depth \
performance metrics and errors from inside your application. \
It allows you to monitor the performance of thousands of applications in real time. \
[Learn more]({learnMoreLink}).',
values: {
learnMoreLink:
'{config.docs.base_url}guide/en/apm/get-started/{config.docs.version}/index.html',
},
}),
euiIconType: 'apmApp',
artifacts,
onPrem: onPremInstructions(indices),
previewImagePath: '/plugins/apmOss/assets/apm.png',
savedObjects,
savedObjectsInstallMsg: i18n.translate('apmOss.tutorial.specProvider.savedObjectsInstallMsg', {
defaultMessage: 'An APM index pattern is required for some features in the APM UI.',
}),
};
};

754
src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts
View file

@ -1,754 +0,0 @@
/*
* 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 { i18n } from '@kbn/i18n';
export const createNodeAgentInstructions = (apmServerUrl = '', secretToken = '') => [
{
title: i18n.translate('apmOss.tutorial.nodeClient.install.title', {
defaultMessage: 'Install the APM agent',
}),
textPre: i18n.translate('apmOss.tutorial.nodeClient.install.textPre', {
defaultMessage: 'Install the APM agent for Node.js as a dependency to your application.',
}),
commands: ['npm install elastic-apm-node --save'],
},
{
title: i18n.translate('apmOss.tutorial.nodeClient.configure.title', {
defaultMessage: 'Configure the agent',
}),
textPre: i18n.translate('apmOss.tutorial.nodeClient.configure.textPre', {
defaultMessage:
'Agents are libraries that run inside of your application process. \
APM services are created programmatically based on the `serviceName`. \
This agent supports a variety of frameworks but can also be used with your custom stack.',
}),
commands: `// ${i18n.translate(
'apmOss.tutorial.nodeClient.configure.commands.addThisToTheFileTopComment',
{
defaultMessage: 'Add this to the VERY top of the first file loaded in your app',
}
)}
var apm = require('elastic-apm-node').start({curlyOpen}
// ${i18n.translate(
'apmOss.tutorial.nodeClient.configure.commands.setRequiredServiceNameComment',
{
defaultMessage: 'Override the service name from package.json',
}
)}
// ${i18n.translate('apmOss.tutorial.nodeClient.configure.commands.allowedCharactersComment', {
defaultMessage: 'Allowed characters: a-z, A-Z, 0-9, -, _, and space',
})}
serviceName: '',
// ${i18n.translate(
'apmOss.tutorial.nodeClient.configure.commands.useIfApmRequiresTokenComment',
{
defaultMessage: 'Use if APM Server requires a secret token',
}
)}
secretToken: '${secretToken}',
// ${i18n.translate(
'apmOss.tutorial.nodeClient.configure.commands.setCustomApmServerUrlComment',
{
defaultMessage: 'Set the custom APM Server URL (default: {defaultApmServerUrl})',
values: { defaultApmServerUrl: 'http://localhost:8200' },
}
)}
serverUrl: '${apmServerUrl}',
// ${i18n.translate(
'apmOss.tutorial.nodeClient.configure.commands.setCustomServiceEnvironmentComment',
{
defaultMessage: 'Set the service environment',
}
)}
environment: 'production'
{curlyClose})`.split('\n'),
textPost: i18n.translate('apmOss.tutorial.nodeClient.configure.textPost', {
defaultMessage:
'See [the documentation]({documentationLink}) for advanced usage, including how to use with \
[Babel/ES Modules]({babelEsModulesLink}).',
values: {
documentationLink: '{config.docs.base_url}guide/en/apm/agent/nodejs/current/index.html',
babelEsModulesLink:
'{config.docs.base_url}guide/en/apm/agent/nodejs/current/advanced-setup.html#es-modules',
},
}),
},
];
export const createDjangoAgentInstructions = (apmServerUrl = '', secretToken = '') => [
{
title: i18n.translate('apmOss.tutorial.djangoClient.install.title', {
defaultMessage: 'Install the APM agent',
}),
textPre: i18n.translate('apmOss.tutorial.djangoClient.install.textPre', {
defaultMessage: 'Install the APM agent for Python as a dependency.',
}),
commands: ['$ pip install elastic-apm'],
},
{
title: i18n.translate('apmOss.tutorial.djangoClient.configure.title', {
defaultMessage: 'Configure the agent',
}),
textPre: i18n.translate('apmOss.tutorial.djangoClient.configure.textPre', {
defaultMessage:
'Agents are libraries that run inside of your application process. \
APM services are created programmatically based on the `SERVICE_NAME`.',
}),
commands: `# ${i18n.translate(
'apmOss.tutorial.djangoClient.configure.commands.addAgentComment',
{
defaultMessage: 'Add the agent to the installed apps',
}
)}
INSTALLED_APPS = (
'elasticapm.contrib.django',
# ...
)
ELASTIC_APM = {curlyOpen}
# ${i18n.translate(
'apmOss.tutorial.djangoClient.configure.commands.setRequiredServiceNameComment',
{
defaultMessage: 'Set the required service name. Allowed characters:',
}
)}
# ${i18n.translate('apmOss.tutorial.djangoClient.configure.commands.allowedCharactersComment', {
defaultMessage: 'a-z, A-Z, 0-9, -, _, and space',
})}
'SERVICE_NAME': '',
# ${i18n.translate(
'apmOss.tutorial.djangoClient.configure.commands.useIfApmServerRequiresTokenComment',
{
defaultMessage: 'Use if APM Server requires a secret token',
}
)}
'SECRET_TOKEN': '${secretToken}',
# ${i18n.translate(
'apmOss.tutorial.djangoClient.configure.commands.setCustomApmServerUrlComment',
{
defaultMessage: 'Set the custom APM Server URL (default: {defaultApmServerUrl})',
values: { defaultApmServerUrl: 'http://localhost:8200' },
}
)}
'SERVER_URL': '${apmServerUrl}',
# ${i18n.translate(
'apmOss.tutorial.djangoClient.configure.commands.setServiceEnvironmentComment',
{
defaultMessage: 'Set the service environment',
}
)}
'ENVIRONMENT': 'production',
{curlyClose}
# ${i18n.translate('apmOss.tutorial.djangoClient.configure.commands.addTracingMiddlewareComment', {
defaultMessage: 'To send performance metrics, add our tracing middleware:',
})}
MIDDLEWARE = (
'elasticapm.contrib.django.middleware.TracingMiddleware',
#...
)`.split('\n'),
textPost: i18n.translate('apmOss.tutorial.djangoClient.configure.textPost', {
defaultMessage: 'See the [documentation]({documentationLink}) for advanced usage.',
values: {
documentationLink:
'{config.docs.base_url}guide/en/apm/agent/python/current/django-support.html',
},
}),
},
];
export const createFlaskAgentInstructions = (apmServerUrl = '', secretToken = '') => [
{
title: i18n.translate('apmOss.tutorial.flaskClient.install.title', {
defaultMessage: 'Install the APM agent',
}),
textPre: i18n.translate('apmOss.tutorial.flaskClient.install.textPre', {
defaultMessage: 'Install the APM agent for Python as a dependency.',
}),
commands: ['$ pip install elastic-apm[flask]'],
},
{
title: i18n.translate('apmOss.tutorial.flaskClient.configure.title', {
defaultMessage: 'Configure the agent',
}),
textPre: i18n.translate('apmOss.tutorial.flaskClient.configure.textPre', {
defaultMessage:
'Agents are libraries that run inside of your application process. \
APM services are created programmatically based on the `SERVICE_NAME`.',
}),
commands: `# ${i18n.translate(
'apmOss.tutorial.flaskClient.configure.commands.initializeUsingEnvironmentVariablesComment',
{
defaultMessage: 'initialize using environment variables',
}
)}
from elasticapm.contrib.flask import ElasticAPM
app = Flask(__name__)
apm = ElasticAPM(app)
# ${i18n.translate('apmOss.tutorial.flaskClient.configure.commands.configureElasticApmComment', {
defaultMessage: "or configure to use ELASTIC_APM in your application's settings",
})}
from elasticapm.contrib.flask import ElasticAPM
app.config['ELASTIC_APM'] = {curlyOpen}
# ${i18n.translate(
'apmOss.tutorial.flaskClient.configure.commands.setRequiredServiceNameComment',
{
defaultMessage: 'Set the required service name. Allowed characters:',
}
)}
# ${i18n.translate('apmOss.tutorial.flaskClient.configure.commands.allowedCharactersComment', {
defaultMessage: 'a-z, A-Z, 0-9, -, _, and space',
})}
'SERVICE_NAME': '',
# ${i18n.translate(
'apmOss.tutorial.flaskClient.configure.commands.useIfApmServerRequiresTokenComment',
{
defaultMessage: 'Use if APM Server requires a secret token',
}
)}
'SECRET_TOKEN': '${secretToken}',
# ${i18n.translate(
'apmOss.tutorial.flaskClient.configure.commands.setCustomApmServerUrlComment',
{
defaultMessage: 'Set the custom APM Server URL (default: {defaultApmServerUrl})',
values: { defaultApmServerUrl: 'http://localhost:8200' },
}
)}
'SERVER_URL': '${apmServerUrl}',
# ${i18n.translate(
'apmOss.tutorial.flaskClient.configure.commands.setServiceEnvironmentComment',
{
defaultMessage: 'Set the service environment',
}
)}
'ENVIRONMENT': 'production',
{curlyClose}
apm = ElasticAPM(app)`.split('\n'),
textPost: i18n.translate('apmOss.tutorial.flaskClient.configure.textPost', {
defaultMessage: 'See the [documentation]({documentationLink}) for advanced usage.',
values: {
documentationLink:
'{config.docs.base_url}guide/en/apm/agent/python/current/flask-support.html',
},
}),
},
];
export const createRailsAgentInstructions = (apmServerUrl = '', secretToken = '') => [
{
title: i18n.translate('apmOss.tutorial.railsClient.install.title', {
defaultMessage: 'Install the APM agent',
}),
textPre: i18n.translate('apmOss.tutorial.railsClient.install.textPre', {
defaultMessage: 'Add the agent to your Gemfile.',
}),
commands: [`gem 'elastic-apm'`],
},
{
title: i18n.translate('apmOss.tutorial.railsClient.configure.title', {
defaultMessage: 'Configure the agent',
}),
textPre: i18n.translate('apmOss.tutorial.railsClient.configure.textPre', {
defaultMessage:
'APM is automatically started when your app boots. Configure the agent, by creating the config file {configFile}',
values: { configFile: '`config/elastic_apm.yml`' },
}),
commands: `# config/elastic_apm.yml:
# Set the service name - allowed characters: a-z, A-Z, 0-9, -, _ and space
# Defaults to the name of your Rails app
service_name: 'my-service'
# Use if APM Server requires a secret token
secret_token: '${secretToken}'
# Set the custom APM Server URL (default: http://localhost:8200)
server_url: '${apmServerUrl || 'http://localhost:8200'}'
# Set the service environment
environment: 'production'`.split('\n'),
textPost: i18n.translate('apmOss.tutorial.railsClient.configure.textPost', {
defaultMessage:
'See the [documentation]({documentationLink}) for configuration options and advanced usage.\n\n',
values: {
documentationLink: '{config.docs.base_url}guide/en/apm/agent/ruby/current/index.html',
},
}),
},
];
export const createRackAgentInstructions = (apmServerUrl = '', secretToken = '') => [
{
title: i18n.translate('apmOss.tutorial.rackClient.install.title', {
defaultMessage: 'Install the APM agent',
}),
textPre: i18n.translate('apmOss.tutorial.rackClient.install.textPre', {
defaultMessage: 'Add the agent to your Gemfile.',
}),
commands: [`gem 'elastic-apm'`],
},
{
title: i18n.translate('apmOss.tutorial.rackClient.configure.title', {
defaultMessage: 'Configure the agent',
}),
textPre: i18n.translate('apmOss.tutorial.rackClient.configure.textPre', {
defaultMessage:
'For Rack or a compatible framework (e.g. Sinatra), include the middleware in your app and start the agent.',
}),
commands: `# config.ru
require 'sinatra/base'
class MySinatraApp < Sinatra::Base
use ElasticAPM::Middleware
# ...
end
ElasticAPM.start(
app: MySinatraApp, # ${i18n.translate(
'apmOss.tutorial.rackClient.configure.commands.requiredComment',
{
defaultMessage: 'required',
}
)}
config_file: '' # ${i18n.translate(
'apmOss.tutorial.rackClient.configure.commands.optionalComment',
{
defaultMessage: 'optional, defaults to config/elastic_apm.yml',
}
)}
)
run MySinatraApp
at_exit {curlyOpen} ElasticAPM.stop {curlyClose}`.split('\n'),
},
{
title: i18n.translate('apmOss.tutorial.rackClient.createConfig.title', {
defaultMessage: 'Create config file',
}),
textPre: i18n.translate('apmOss.tutorial.rackClient.createConfig.textPre', {
defaultMessage: 'Create a config file {configFile}:',
values: { configFile: '`config/elastic_apm.yml`' },
}),
commands: `# config/elastic_apm.yml:
# ${i18n.translate('apmOss.tutorial.rackClient.createConfig.commands.setServiceNameComment', {
defaultMessage: 'Set the service name - allowed characters: a-z, A-Z, 0-9, -, _ and space',
})}
# ${i18n.translate(
'apmOss.tutorial.rackClient.createConfig.commands.defaultsToTheNameOfRackAppClassComment',
{
defaultMessage: "Defaults to the name of your Rack app's class.",
}
)}
service_name: 'my-service'
# ${i18n.translate(
'apmOss.tutorial.rackClient.createConfig.commands.useIfApmServerRequiresTokenComment',
{
defaultMessage: 'Use if APM Server requires a token',
}
)}
secret_token: '${secretToken}'
# ${i18n.translate('apmOss.tutorial.rackClient.createConfig.commands.setCustomApmServerComment', {
defaultMessage: 'Set custom APM Server URL (default: {defaultServerUrl})',
values: { defaultServerUrl: 'http://localhost:8200' },
})}
server_url: '${apmServerUrl || 'http://localhost:8200'}',
# ${i18n.translate('apmOss.tutorial.rackClient.createConfig.commands.setServiceEnvironment', {
defaultMessage: 'Set the service environment',
})}
environment: 'production'`.split('\n'),
textPost: i18n.translate('apmOss.tutorial.rackClient.createConfig.textPost', {
defaultMessage:
'See the [documentation]({documentationLink}) for configuration options and advanced usage.\n\n',
values: {
documentationLink: '{config.docs.base_url}guide/en/apm/agent/ruby/current/index.html',
},
}),
},
];
export const createJsAgentInstructions = (apmServerUrl = '') => [
{
title: i18n.translate('apmOss.tutorial.jsClient.enableRealUserMonitoring.title', {
defaultMessage: 'Enable Real User Monitoring support in APM Server',
}),
textPre: i18n.translate('apmOss.tutorial.jsClient.enableRealUserMonitoring.textPre', {
defaultMessage:
'APM Server disables RUM support by default. See the [documentation]({documentationLink}) \
for details on how to enable RUM support.',
values: {
documentationLink:
'{config.docs.base_url}guide/en/apm/server/{config.docs.version}/configuration-rum.html',
},
}),
},
{
title: i18n.translate('apmOss.tutorial.jsClient.installDependency.title', {
defaultMessage: 'Set up the Agent as a dependency',
}),
textPre: i18n.translate('apmOss.tutorial.jsClient.installDependency.textPre', {
defaultMessage:
'You can install the Agent as a dependency to your application with \
`npm install @elastic/apm-rum --save`.\n\n\
The Agent can then be initialized and configured in your application like this:',
}),
commands: `import {curlyOpen} init as initApm {curlyClose} from '@elastic/apm-rum'
var apm = initApm({curlyOpen}
// ${i18n.translate(
'apmOss.tutorial.jsClient.installDependency.commands.setRequiredServiceNameComment',
{
defaultMessage:
'Set required service name (allowed characters: a-z, A-Z, 0-9, -, _, and space)',
}
)}
serviceName: 'your-app-name',
// ${i18n.translate(
'apmOss.tutorial.jsClient.installDependency.commands.setCustomApmServerUrlComment',
{
defaultMessage: 'Set custom APM Server URL (default: {defaultApmServerUrl})',
values: { defaultApmServerUrl: 'http://localhost:8200' },
}
)}
serverUrl: '${apmServerUrl}',
// ${i18n.translate(
'apmOss.tutorial.jsClient.installDependency.commands.setServiceVersionComment',
{
defaultMessage: 'Set the service version (required for source map feature)',
}
)}
serviceVersion: '',
// ${i18n.translate(
'apmOss.tutorial.jsClient.installDependency.commands.setServiceEnvironmentComment',
{
defaultMessage: 'Set the service environment',
}
)}
environment: 'production'
{curlyClose})`.split('\n'),
textPost: i18n.translate('apmOss.tutorial.jsClient.installDependency.textPost', {
defaultMessage:
'Framework integrations, like React or Angular, have custom dependencies. \
See the [integration documentation]({docLink}) for more information.',
values: {
docLink:
'{config.docs.base_url}guide/en/apm/agent/rum-js/current/framework-integrations.html',
},
}),
},
{
title: i18n.translate('apmOss.tutorial.jsClient.scriptTags.title', {
defaultMessage: 'Set up the Agent with Script Tags',
}),
textPre: i18n.translate('apmOss.tutorial.jsClient.scriptTags.textPre', {
defaultMessage:
"Alternatively, you can use Script tags to set up and configure the Agent. \
Add a `<script>` tag to the HTML page and use the `elasticApm` global object to load and initialize the agent. \
Don't forget to download the latest version of the RUM Agent from [GitHub]({GitHubLink}) or [UNPKG]({UnpkgLink}), \
and host the file on your Server/CDN before deploying to production.",
values: {
GitHubLink: 'https://github.com/elastic/apm-agent-rum-js/releases/latest',
UnpkgLink: 'https://unpkg.com/@elastic/apm-rum/dist/bundles/elastic-apm-rum.umd.min.js',
},
}),
commands: `\
<script src="https://your-cdn-host.com/path/to/elastic-apm-rum.umd.min.js" crossorigin></script>
<script>
elasticApm.init({curlyOpen}
serviceName: 'your-app-name',
serverUrl: 'http://localhost:8200',
{curlyClose})
</script>
`.split('\n'),
},
];
export const createGoAgentInstructions = (apmServerUrl = '', secretToken = '') => [
{
title: i18n.translate('apmOss.tutorial.goClient.install.title', {
defaultMessage: 'Install the APM agent',
}),
textPre: i18n.translate('apmOss.tutorial.goClient.install.textPre', {
defaultMessage: 'Install the APM agent packages for Go.',
}),
commands: ['go get go.elastic.co/apm'],
},
{
title: i18n.translate('apmOss.tutorial.goClient.configure.title', {
defaultMessage: 'Configure the agent',
}),
textPre: i18n.translate('apmOss.tutorial.goClient.configure.textPre', {
defaultMessage:
'Agents are libraries that run inside of your application process. \
APM services are created programmatically based on the executable \
file name, or the `ELASTIC_APM_SERVICE_NAME` environment variable.',
}),
commands: `# ${i18n.translate(
'apmOss.tutorial.goClient.configure.commands.initializeUsingEnvironmentVariablesComment',
{
defaultMessage: 'Initialize using environment variables:',
}
)}
# ${i18n.translate('apmOss.tutorial.goClient.configure.commands.setServiceNameComment', {
defaultMessage: 'Set the service name. Allowed characters: # a-z, A-Z, 0-9, -, _, and space.',
})}
# ${i18n.translate('apmOss.tutorial.goClient.configure.commands.usedExecutableNameComment', {
defaultMessage:
'If ELASTIC_APM_SERVICE_NAME is not specified, the executable name will be used.',
})}
export ELASTIC_APM_SERVICE_NAME=
# ${i18n.translate('apmOss.tutorial.goClient.configure.commands.setCustomApmServerUrlComment', {
defaultMessage: 'Set custom APM Server URL (default: {defaultApmServerUrl})',
values: { defaultApmServerUrl: 'http://localhost:8200' },
})}
export ELASTIC_APM_SERVER_URL=${apmServerUrl}
# ${i18n.translate('apmOss.tutorial.goClient.configure.commands.useIfApmRequiresTokenComment', {
defaultMessage: 'Use if APM Server requires a secret token',
})}
export ELASTIC_APM_SECRET_TOKEN=${secretToken}
# ${i18n.translate('apmOss.tutorial.goClient.configure.commands.setServiceEnvironment', {
defaultMessage: 'Set the service environment',
})}
export ELASTIC_APM_ENVIRONMENT=
`.split('\n'),
textPost: i18n.translate('apmOss.tutorial.goClient.configure.textPost', {
defaultMessage: 'See the [documentation]({documentationLink}) for advanced configuration.',
values: {
documentationLink: '{config.docs.base_url}guide/en/apm/agent/go/current/configuration.html',
},
}),
},
{
title: i18n.translate('apmOss.tutorial.goClient.instrument.title', {
defaultMessage: 'Instrument your application',
}),
textPre: i18n.translate('apmOss.tutorial.goClient.instrument.textPre', {
defaultMessage:
'Instrument your Go application by using one of the provided instrumentation modules or \
by using the tracer API directly.',
}),
commands: `\
import (
"net/http"
"go.elastic.co/apm/module/apmhttp"
)
func main() {curlyOpen}
mux := http.NewServeMux()
...
http.ListenAndServe(":8080", apmhttp.Wrap(mux))
{curlyClose}
`.split('\n'),
textPost: i18n.translate('apmOss.tutorial.goClient.instrument.textPost', {
defaultMessage:
'See the [documentation]({documentationLink}) for a detailed \
guide to instrumenting Go source code.',
values: {
documentationLink:
'{config.docs.base_url}guide/en/apm/agent/go/current/instrumenting-source.html',
},
}),
},
];
export const createJavaAgentInstructions = (apmServerUrl = '', secretToken = '') => [
{
title: i18n.translate('apmOss.tutorial.javaClient.download.title', {
defaultMessage: 'Download the APM agent',
}),
textPre: i18n.translate('apmOss.tutorial.javaClient.download.textPre', {
defaultMessage:
'Download the agent jar from [Maven Central]({mavenCentralLink}). \
Do **not** add the agent as a dependency to your application.',
values: {
mavenCentralLink: 'http://search.maven.org/#search%7Cga%7C1%7Ca%3Aelastic-apm-agent',
},
}),
},
{
title: i18n.translate('apmOss.tutorial.javaClient.startApplication.title', {
defaultMessage: 'Start your application with the javaagent flag',
}),
textPre: i18n.translate('apmOss.tutorial.javaClient.startApplication.textPre', {
defaultMessage:
'Add the `-javaagent` flag and configure the agent with system properties.\n\n \
* Set the required service name (allowed characters: a-z, A-Z, 0-9, -, _, and space)\n \
* Set the custom APM Server URL (default: {customApmServerUrl})\n \
* Set the APM Server secret token\n \
* Set the service environment\n \
* Set the base package of your application',
values: { customApmServerUrl: 'http://localhost:8200' },
}),
commands: `java -javaagent:/path/to/elastic-apm-agent-<version>.jar \\
-Delastic.apm.service_name=my-application \\
-Delastic.apm.server_urls=${apmServerUrl || 'http://localhost:8200'} \\
-Delastic.apm.secret_token=${secretToken} \\
-Delastic.apm.environment=production \\
-Delastic.apm.application_packages=org.example \\
-jar my-application.jar`.split('\n'),
textPost: i18n.translate('apmOss.tutorial.javaClient.startApplication.textPost', {
defaultMessage:
'See the [documentation]({documentationLink}) for configuration options and advanced \
usage.',
values: {
documentationLink: '{config.docs.base_url}guide/en/apm/agent/java/current/index.html',
},
}),
},
];
export const createDotNetAgentInstructions = (apmServerUrl = '', secretToken = '') => [
{
title: i18n.translate('apmOss.tutorial.dotNetClient.download.title', {
defaultMessage: 'Download the APM agent',
}),
textPre: i18n.translate('apmOss.tutorial.dotNetClient.download.textPre', {
defaultMessage:
'Add the the agent package(s) from [NuGet]({allNuGetPackagesLink}) to your .NET application. There are multiple \
NuGet packages available for different use cases. \n\nFor an ASP.NET Core application with Entity Framework \
Core download the [Elastic.Apm.NetCoreAll]({netCoreAllApmPackageLink}) package. This package will automatically add every \
agent component to your application. \n\n In case you would like to minimize the dependencies, you can use the \
[Elastic.Apm.AspNetCore]({aspNetCorePackageLink}) package for just \
ASP.NET Core monitoring or the [Elastic.Apm.EfCore]({efCorePackageLink}) package for just Entity Framework Core monitoring. \n\n \
In case you only want to use the public Agent API for manual instrumentation use the [Elastic.Apm]({elasticApmPackageLink}) package.',
values: {
allNuGetPackagesLink: 'https://www.nuget.org/packages?q=Elastic.apm',
netCoreAllApmPackageLink: 'https://www.nuget.org/packages/Elastic.Apm.NetCoreAll',
aspNetCorePackageLink: 'https://www.nuget.org/packages/Elastic.Apm.AspNetCore',
efCorePackageLink: 'https://www.nuget.org/packages/Elastic.Apm.EntityFrameworkCore',
elasticApmPackageLink: 'https://www.nuget.org/packages/Elastic.Apm',
},
}),
},
{
title: i18n.translate('apmOss.tutorial.dotNetClient.configureApplication.title', {
defaultMessage: 'Add the agent to the application',
}),
textPre: i18n.translate('apmOss.tutorial.dotNetClient.configureApplication.textPre', {
defaultMessage:
'In case of ASP.NET Core with the `Elastic.Apm.NetCoreAll` package, call the `UseAllElasticApm` \
method in the `Configure` method within the `Startup.cs` file.',
}),
commands: `public class Startup
{curlyOpen}
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{curlyOpen}
app.UseAllElasticApm(Configuration);
//…rest of the method
{curlyClose}
//…rest of the class
{curlyClose}`.split('\n'),
textPost: i18n.translate('apmOss.tutorial.dotNetClient.configureApplication.textPost', {
defaultMessage:
'Passing an `IConfiguration` instance is optional and by doing so, the agent will read config settings through this \
`IConfiguration` instance (e.g. from the `appsettings.json` file).',
}),
},
{
title: i18n.translate('apmOss.tutorial.dotNetClient.configureAgent.title', {
defaultMessage: 'Sample appsettings.json file:',
}),
commands: `{curlyOpen}
"ElasticApm": {curlyOpen}
"SecretToken": "${secretToken}",
"ServerUrls": "${
apmServerUrl || 'http://localhost:8200'
}", //Set custom APM Server URL (default: http://localhost:8200)
"ServiceName": "MyApp", //allowed characters: a-z, A-Z, 0-9, -, _, and space. Default is the entry assembly of the application
"Environment": "production", // Set the service environment
{curlyClose}
{curlyClose}`.split('\n'),
textPost: i18n.translate('apmOss.tutorial.dotNetClient.configureAgent.textPost', {
defaultMessage:
'In case you don’t pass an `IConfiguration` instance to the agent (e.g. in case of non ASP.NET Core applications) \
you can also configure the agent through environment variables. \n \
See [the documentation]({documentationLink}) for advanced usage.',
values: {
documentationLink:
'{config.docs.base_url}guide/en/apm/agent/dotnet/current/configuration.html',
},
}),
},
];
export const createPhpAgentInstructions = (apmServerUrl = '', secretToken = '') => [
{
title: i18n.translate('apmOss.tutorial.phpClient.download.title', {
defaultMessage: 'Download the APM agent',
}),
textPre: i18n.translate('apmOss.tutorial.phpClient.download.textPre', {
defaultMessage:
'Download the package corresponding to your platform from [GitHub releases]({githubReleasesLink}).',
values: {
githubReleasesLink: 'https://github.com/elastic/apm-agent-php/releases',
},
}),
},
{
title: i18n.translate('apmOss.tutorial.phpClient.installPackage.title', {
defaultMessage: 'Install the downloaded package',
}),
textPre: i18n.translate('apmOss.tutorial.phpClient.installPackage.textPre', {
defaultMessage: 'For example on Alpine Linux using APK package:',
}),
commands: ['apk add --allow-untrusted <package-file>.apk'],
textPost: i18n.translate('apmOss.tutorial.phpClient.installPackage.textPost', {
defaultMessage:
'See the [documentation]({documentationLink}) for installation commands on other supported platforms and advanced installation.',
values: {
documentationLink: '{config.docs.base_url}guide/en/apm/agent/php/current/setup.html',
},
}),
},
{
title: i18n.translate('apmOss.tutorial.phpClient.configureAgent.title', {
defaultMessage: 'Configure the agent',
}),
textPre: i18n.translate('apmOss.tutorial.phpClient.configureAgent.textPre', {
defaultMessage:
'APM is automatically started when your app boots. Configure the agent either via `php.ini` file:',
}),
commands: `elastic_apm.server_url=http://localhost:8200
elastic_apm.service_name="My service"
`.split('\n'),
textPost: i18n.translate('apmOss.tutorial.phpClient.configure.textPost', {
defaultMessage:
'See the [documentation]({documentationLink}) for configuration options and advanced usage.\n\n',
values: {
documentationLink:
'{config.docs.base_url}guide/en/apm/agent/php/current/configuration.html',
},
}),
},
];

5
src/plugins/apm_oss/common/index_pattern_constants.ts → x-pack/plugins/apm/common/index_pattern_constants.ts
View file

@ -1,9 +1,8 @@
/*
* 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.
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
export const APM_STATIC_INDEX_PATTERN_ID = 'apm_static_index_pattern_id';

0
src/plugins/apm_oss/public/assets/apm.png → x-pack/plugins/apm/public/assets/apm.png
View file

Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 311 KiB

After

Width:  |  Height:  |  Size: 311 KiB

2
x-pack/plugins/apm/public/components/app/RumDashboard/VisitorBreakdownMap/useLayerList.ts
View file

@ -22,7 +22,7 @@ import {
SYMBOLIZE_AS_TYPES,
} from '../../../../../../maps/common/constants';
import { APM_STATIC_INDEX_PATTERN_ID } from '../../../../../../../../src/plugins/apm_oss/public';
import { APM_STATIC_INDEX_PATTERN_ID } from '../../../../../common/index_pattern_constants';
import { useUrlParams } from '../../../../context/url_params_context/use_url_params';
import {
SERVICE_NAME,

2
x-pack/plugins/apm/public/components/app/RumDashboard/VisitorBreakdownMap/useMapFilters.ts
View file

@ -17,7 +17,7 @@ import {
USER_AGENT_OS,
} from '../../../../../common/elasticsearch_fieldnames';
import { APM_STATIC_INDEX_PATTERN_ID } from '../../../../../../../../src/plugins/apm_oss/public';
import { APM_STATIC_INDEX_PATTERN_ID } from '../../../../../common/index_pattern_constants';
const getWildcardFilter = (field: string, value: string): Filter => {
return {

2
x-pack/plugins/apm/public/components/shared/Links/DiscoverLinks/DiscoverLink.tsx
View file

@ -12,7 +12,7 @@ import React from 'react';
import { useLocation } from 'react-router-dom';
import rison, { RisonValue } from 'rison-node';
import url from 'url';
import { APM_STATIC_INDEX_PATTERN_ID } from '../../../../../../../../src/plugins/apm_oss/public';
import { APM_STATIC_INDEX_PATTERN_ID } from '../../../../../common/index_pattern_constants';
import { useApmPluginContext } from '../../../../context/apm_plugin/use_apm_plugin_context';
import { getTimepickerRisonData } from '../rison_helpers';

6
x-pack/plugins/apm/server/lib/index_pattern/create_static_index_pattern.ts
View file

@ -6,10 +6,8 @@
*/
import { SavedObjectsErrorHelpers } from '../../../../../../src/core/server';
import {
apmIndexPattern,
APM_STATIC_INDEX_PATTERN_ID,
} from '../../../../../../src/plugins/apm_oss/server';
import { APM_STATIC_INDEX_PATTERN_ID } from '../../../common/index_pattern_constants';
import apmIndexPattern from '../../tutorial/index_pattern.json';
import { hasHistoricalAgentData } from '../services/get_services/has_historical_agent_data';
import { Setup } from '../helpers/setup_request';
import { APMRouteHandlerResources } from '../../routes/typings';

39
x-pack/plugins/apm/server/plugin.ts
View file

@ -5,7 +5,6 @@
* 2.0.
*/
import { i18n } from '@kbn/i18n';
import { combineLatest } from 'rxjs';
import { map, take } from 'rxjs/operators';
import {
@ -32,7 +31,6 @@ import { createApmAgentConfigurationIndex } from './lib/settings/agent_configura
import { getApmIndices } from './lib/settings/apm_indices/get_apm_indices';
import { createApmCustomLinkIndex } from './lib/settings/custom_link/create_custom_link_index';
import { apmIndices, apmTelemetry } from './saved_objects';
import { createElasticCloudInstructions } from './tutorial/elastic_cloud';
import { uiSettings } from './ui_settings';
import type {
ApmPluginRequestHandlerContext,
@ -51,6 +49,7 @@ import {
SERVICE_NAME,
TRANSACTION_TYPE,
} from '../common/elasticsearch_fieldnames';
import { tutorialProvider } from './tutorial';
export class APMPlugin
implements
@ -103,28 +102,20 @@ export class APMPlugin
});
}
const ossTutorialProvider = plugins.apmOss.getRegisteredTutorialProvider();
plugins.home?.tutorials.unregisterTutorial(ossTutorialProvider);
plugins.home?.tutorials.registerTutorial(() => {
const ossPart = ossTutorialProvider({});
if (this.currentConfig!['xpack.apm.ui.enabled'] && ossPart.artifacts) {
// @ts-expect-error ossPart.artifacts.application is readonly
ossPart.artifacts.application = {
path: '/app/apm',
label: i18n.translate(
'xpack.apm.tutorial.specProvider.artifacts.application.label',
{
defaultMessage: 'Launch APM',
}
),
};
}
return {
...ossPart,
elasticCloud: createElasticCloudInstructions(plugins.cloud),
};
});
plugins.home?.tutorials.registerTutorial(
tutorialProvider({
isEnabled: this.currentConfig['xpack.apm.ui.enabled'],
indexPatternTitle: this.currentConfig['apm_oss.indexPattern'],
cloud: plugins.cloud,
indices: {
errorIndices: this.currentConfig['apm_oss.errorIndices'],
metricsIndices: this.currentConfig['apm_oss.metricsIndices'],
onboardingIndices: this.currentConfig['apm_oss.onboardingIndices'],
sourcemapIndices: this.currentConfig['apm_oss.sourcemapIndices'],
transactionIndices: this.currentConfig['apm_oss.transactionIndices'],
},
})
);
plugins.features.registerKibanaFeature(APM_FEATURE);

6
x-pack/plugins/apm/server/tutorial/elastic_cloud.ts → x-pack/plugins/apm/server/tutorial/envs/elastic_cloud.ts
View file

@ -6,7 +6,7 @@
*/
import { i18n } from '@kbn/i18n';
import { INSTRUCTION_VARIANT } from '../../../../../src/plugins/home/server';
import { INSTRUCTION_VARIANT } from '../../../../../../src/plugins/home/server';
import {
createNodeAgentInstructions,
@ -19,8 +19,8 @@ import {
createJavaAgentInstructions,
createDotNetAgentInstructions,
createPhpAgentInstructions,
} from '../../../../../src/plugins/apm_oss/server';
import { CloudSetup } from '../../../cloud/server';
} from '../instructions/apm_agent_instructions';
import { CloudSetup } from '../../../../cloud/server';
export function createElasticCloudInstructions(cloudSetup?: CloudSetup) {
const apmServerUrl = cloudSetup?.apm.url;

151
src/plugins/apm_oss/server/tutorial/envs/on_prem.ts → x-pack/plugins/apm/server/tutorial/envs/on_prem.ts
View file

@ -1,13 +1,12 @@
/*
* 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.
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
import { i18n } from '@kbn/i18n';
import { INSTRUCTION_VARIANT } from '../../../../home/server';
import { INSTRUCTION_VARIANT } from '../../../../../../src/plugins/home/server';
import {
createWindowsServerInstructions,
createEditConfig,
@ -50,31 +49,46 @@ export function onPremInstructions({
return {
instructionSets: [
{
title: i18n.translate('apmOss.tutorial.apmServer.title', {
title: i18n.translate('xpack.apm.tutorial.apmServer.title', {
defaultMessage: 'APM Server',
}),
callOut: {
title: i18n.translate('apmOss.tutorial.apmServer.callOut.title', {
title: i18n.translate('xpack.apm.tutorial.apmServer.callOut.title', {
defaultMessage: 'Important: Updating to 7.0 or higher',
}),
message: i18n.translate('apmOss.tutorial.apmServer.callOut.message', {
defaultMessage: `Please make sure your APM Server is updated to 7.0 or higher. \
message: i18n.translate(
'xpack.apm.tutorial.apmServer.callOut.message',
{
defaultMessage: `Please make sure your APM Server is updated to 7.0 or higher. \
You can also migrate your 6.x data with the migration assistant found in Kibana's management section.`,
}),
}
),
iconType: 'alert',
},
instructionVariants: [
{
id: INSTRUCTION_VARIANT.OSX,
instructions: [createDownloadServerOsx(), EDIT_CONFIG, START_SERVER_UNIX],
instructions: [
createDownloadServerOsx(),
EDIT_CONFIG,
START_SERVER_UNIX,
],
},
{
id: INSTRUCTION_VARIANT.DEB,
instructions: [createDownloadServerDeb(), EDIT_CONFIG, START_SERVER_UNIX_SYSV],
instructions: [
createDownloadServerDeb(),
EDIT_CONFIG,
START_SERVER_UNIX_SYSV,
],
},
{
id: INSTRUCTION_VARIANT.RPM,
instructions: [createDownloadServerRpm(), EDIT_CONFIG, START_SERVER_UNIX_SYSV],
instructions: [
createDownloadServerRpm(),
EDIT_CONFIG,
START_SERVER_UNIX_SYSV,
],
},
{
id: INSTRUCTION_VARIANT.WINDOWS,
@ -82,23 +96,38 @@ export function onPremInstructions({
},
],
statusCheck: {
title: i18n.translate('apmOss.tutorial.apmServer.statusCheck.title', {
defaultMessage: 'APM Server status',
}),
text: i18n.translate('apmOss.tutorial.apmServer.statusCheck.text', {
defaultMessage:
'Make sure APM Server is running before you start implementing the APM agents.',
}),
btnLabel: i18n.translate('apmOss.tutorial.apmServer.statusCheck.btnLabel', {
defaultMessage: 'Check APM Server status',
}),
success: i18n.translate('apmOss.tutorial.apmServer.statusCheck.successMessage', {
defaultMessage: 'You have correctly setup APM Server',
}),
error: i18n.translate('apmOss.tutorial.apmServer.statusCheck.errorMessage', {
defaultMessage:
'No APM Server detected. Please make sure it is running and you have updated to 7.0 or higher.',
}),
title: i18n.translate(
'xpack.apm.tutorial.apmServer.statusCheck.title',
{
defaultMessage: 'APM Server status',
}
),
text: i18n.translate(
'xpack.apm.tutorial.apmServer.statusCheck.text',
{
defaultMessage:
'Make sure APM Server is running before you start implementing the APM agents.',
}
),
btnLabel: i18n.translate(
'xpack.apm.tutorial.apmServer.statusCheck.btnLabel',
{
defaultMessage: 'Check APM Server status',
}
),
success: i18n.translate(
'xpack.apm.tutorial.apmServer.statusCheck.successMessage',
{
defaultMessage: 'You have correctly setup APM Server',
}
),
error: i18n.translate(
'xpack.apm.tutorial.apmServer.statusCheck.errorMessage',
{
defaultMessage:
'No APM Server detected. Please make sure it is running and you have updated to 7.0 or higher.',
}
),
esHitsCheck: {
index: onboardingIndices,
query: {
@ -113,7 +142,7 @@ export function onPremInstructions({
},
},
{
title: i18n.translate('apmOss.tutorial.apmAgents.title', {
title: i18n.translate('xpack.apm.tutorial.apmAgents.title', {
defaultMessage: 'APM Agents',
}),
instructionVariants: [
@ -159,30 +188,56 @@ export function onPremInstructions({
},
],
statusCheck: {
title: i18n.translate('apmOss.tutorial.apmAgents.statusCheck.title', {
defaultMessage: 'Agent status',
}),
text: i18n.translate('apmOss.tutorial.apmAgents.statusCheck.text', {
defaultMessage:
'Make sure your application is running and the agents are sending data.',
}),
btnLabel: i18n.translate('apmOss.tutorial.apmAgents.statusCheck.btnLabel', {
defaultMessage: 'Check agent status',
}),
success: i18n.translate('apmOss.tutorial.apmAgents.statusCheck.successMessage', {
defaultMessage: 'Data successfully received from one or more agents',
}),
error: i18n.translate('apmOss.tutorial.apmAgents.statusCheck.errorMessage', {
defaultMessage: 'No data has been received from agents yet',
}),
title: i18n.translate(
'xpack.apm.tutorial.apmAgents.statusCheck.title',
{
defaultMessage: 'Agent status',
}
),
text: i18n.translate(
'xpack.apm.tutorial.apmAgents.statusCheck.text',
{
defaultMessage:
'Make sure your application is running and the agents are sending data.',
}
),
btnLabel: i18n.translate(
'xpack.apm.tutorial.apmAgents.statusCheck.btnLabel',
{
defaultMessage: 'Check agent status',
}
),
success: i18n.translate(
'xpack.apm.tutorial.apmAgents.statusCheck.successMessage',
{
defaultMessage:
'Data successfully received from one or more agents',
}
),
error: i18n.translate(
'xpack.apm.tutorial.apmAgents.statusCheck.errorMessage',
{
defaultMessage: 'No data has been received from agents yet',
}
),
esHitsCheck: {
index: [errorIndices, transactionIndices, metricsIndices, sourcemapIndices],
index: [
errorIndices,
transactionIndices,
metricsIndices,
sourcemapIndices,
],
query: {
bool: {
filter: [
{
terms: {
'processor.event': ['error', 'transaction', 'metric', 'sourcemap'],
'processor.event': [
'error',
'transaction',
'metric',
'sourcemap',
],
},
},
{ range: { 'observer.version_major': { gte: 7 } } },

117
x-pack/plugins/apm/server/tutorial/index.ts Normal file
View file

@ -0,0 +1,117 @@
/*
* 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 { i18n } from '@kbn/i18n';
import { onPremInstructions } from './envs/on_prem';
import { createElasticCloudInstructions } from './envs/elastic_cloud';
import apmIndexPattern from './index_pattern.json';
import { CloudSetup } from '../../../cloud/server';
import {
ArtifactsSchema,
TutorialsCategory,
} from '../../../../../src/plugins/home/server';
import { APM_STATIC_INDEX_PATTERN_ID } from '../../common/index_pattern_constants';
const apmIntro = i18n.translate('xpack.apm.tutorial.introduction', {
defaultMessage:
'Collect in-depth performance metrics and errors from inside your applications.',
});
const moduleName = 'apm';
export const tutorialProvider = ({
isEnabled,
indexPatternTitle,
indices,
cloud,
}: {
isEnabled: boolean;
indexPatternTitle: string;
cloud?: CloudSetup;
indices: {
errorIndices: string;
transactionIndices: string;
metricsIndices: string;
sourcemapIndices: string;
onboardingIndices: string;
};
}) => () => {
const savedObjects = [
{
...apmIndexPattern,
id: APM_STATIC_INDEX_PATTERN_ID,
attributes: {
...apmIndexPattern.attributes,
title: indexPatternTitle,
},
},
];
const artifacts: ArtifactsSchema = {
dashboards: [
{
id: '8d3ed660-7828-11e7-8c47-65b845b5cfb3',
linkLabel: i18n.translate(
'xpack.apm.tutorial.specProvider.artifacts.dashboards.linkLabel',
{
defaultMessage: 'APM dashboard',
}
),
isOverview: true,
},
],
};
if (isEnabled) {
// @ts-expect-error artifacts.application is readonly
artifacts.application = {
path: '/app/apm',
label: i18n.translate(
'xpack.apm.tutorial.specProvider.artifacts.application.label',
{
defaultMessage: 'Launch APM',
}
),
};
}
return {
id: 'apm',
name: i18n.translate('xpack.apm.tutorial.specProvider.name', {
defaultMessage: 'APM',
}),
moduleName,
category: TutorialsCategory.OTHER,
shortDescription: apmIntro,
longDescription: i18n.translate(
'xpack.apm.tutorial.specProvider.longDescription',
{
defaultMessage:
'Application Performance Monitoring (APM) collects in-depth \
performance metrics and errors from inside your application. \
It allows you to monitor the performance of thousands of applications in real time. \
[Learn more]({learnMoreLink}).',
values: {
learnMoreLink:
'{config.docs.base_url}guide/en/apm/get-started/{config.docs.version}/index.html',
},
}
),
euiIconType: 'apmApp',
artifacts,
onPrem: onPremInstructions(indices),
elasticCloud: createElasticCloudInstructions(cloud),
previewImagePath: '/plugins/apm/assets/apm.png',
savedObjects,
savedObjectsInstallMsg: i18n.translate(
'xpack.apm.tutorial.specProvider.savedObjectsInstallMsg',
{
defaultMessage:
'An APM index pattern is required for some features in the APM UI.',
}
),
};
};

0
src/plugins/apm_oss/server/tutorial/index_pattern.json → x-pack/plugins/apm/server/tutorial/index_pattern.json
View file

931
x-pack/plugins/apm/server/tutorial/instructions/apm_agent_instructions.ts Normal file
View file

@ -0,0 +1,931 @@
/*
* 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 { i18n } from '@kbn/i18n';
export const createNodeAgentInstructions = (
apmServerUrl = '',
secretToken = ''
) => [
{
title: i18n.translate('xpack.apm.tutorial.nodeClient.install.title', {
defaultMessage: 'Install the APM agent',
}),
textPre: i18n.translate('xpack.apm.tutorial.nodeClient.install.textPre', {
defaultMessage:
'Install the APM agent for Node.js as a dependency to your application.',
}),
commands: ['npm install elastic-apm-node --save'],
},
{
title: i18n.translate('xpack.apm.tutorial.nodeClient.configure.title', {
defaultMessage: 'Configure the agent',
}),
textPre: i18n.translate('xpack.apm.tutorial.nodeClient.configure.textPre', {
defaultMessage:
'Agents are libraries that run inside of your application process. \
APM services are created programmatically based on the `serviceName`. \
This agent supports a variety of frameworks but can also be used with your custom stack.',
}),
commands: `// ${i18n.translate(
'xpack.apm.tutorial.nodeClient.configure.commands.addThisToTheFileTopComment',
{
defaultMessage:
'Add this to the VERY top of the first file loaded in your app',
}
)}
var apm = require('elastic-apm-node').start({curlyOpen}
// ${i18n.translate(
'xpack.apm.tutorial.nodeClient.configure.commands.setRequiredServiceNameComment',
{
defaultMessage: 'Override the service name from package.json',
}
)}
// ${i18n.translate(
'xpack.apm.tutorial.nodeClient.configure.commands.allowedCharactersComment',
{
defaultMessage: 'Allowed characters: a-z, A-Z, 0-9, -, _, and space',
}
)}
serviceName: '',
// ${i18n.translate(
'xpack.apm.tutorial.nodeClient.configure.commands.useIfApmRequiresTokenComment',
{
defaultMessage: 'Use if APM Server requires a secret token',
}
)}
secretToken: '${secretToken}',
// ${i18n.translate(
'xpack.apm.tutorial.nodeClient.configure.commands.setCustomApmServerUrlComment',
{
defaultMessage:
'Set the custom APM Server URL (default: {defaultApmServerUrl})',
values: { defaultApmServerUrl: 'http://localhost:8200' },
}
)}
serverUrl: '${apmServerUrl}',
// ${i18n.translate(
'xpack.apm.tutorial.nodeClient.configure.commands.setCustomServiceEnvironmentComment',
{
defaultMessage: 'Set the service environment',
}
)}
environment: 'production'
{curlyClose})`.split('\n'),
textPost: i18n.translate(
'xpack.apm.tutorial.nodeClient.configure.textPost',
{
defaultMessage:
'See [the documentation]({documentationLink}) for advanced usage, including how to use with \
[Babel/ES Modules]({babelEsModulesLink}).',
values: {
documentationLink:
'{config.docs.base_url}guide/en/apm/agent/nodejs/current/index.html',
babelEsModulesLink:
'{config.docs.base_url}guide/en/apm/agent/nodejs/current/advanced-setup.html#es-modules',
},
}
),
},
];
export const createDjangoAgentInstructions = (
apmServerUrl = '',
secretToken = ''
) => [
{
title: i18n.translate('xpack.apm.tutorial.djangoClient.install.title', {
defaultMessage: 'Install the APM agent',
}),
textPre: i18n.translate('xpack.apm.tutorial.djangoClient.install.textPre', {
defaultMessage: 'Install the APM agent for Python as a dependency.',
}),
commands: ['$ pip install elastic-apm'],
},
{
title: i18n.translate('xpack.apm.tutorial.djangoClient.configure.title', {
defaultMessage: 'Configure the agent',
}),
textPre: i18n.translate(
'xpack.apm.tutorial.djangoClient.configure.textPre',
{
defaultMessage:
'Agents are libraries that run inside of your application process. \
APM services are created programmatically based on the `SERVICE_NAME`.',
}
),
commands: `# ${i18n.translate(
'xpack.apm.tutorial.djangoClient.configure.commands.addAgentComment',
{
defaultMessage: 'Add the agent to the installed apps',
}
)}
INSTALLED_APPS = (
'elasticapm.contrib.django',
# ...
)
ELASTIC_APM = {curlyOpen}
# ${i18n.translate(
'xpack.apm.tutorial.djangoClient.configure.commands.setRequiredServiceNameComment',
{
defaultMessage: 'Set the required service name. Allowed characters:',
}
)}
# ${i18n.translate(
'xpack.apm.tutorial.djangoClient.configure.commands.allowedCharactersComment',
{
defaultMessage: 'a-z, A-Z, 0-9, -, _, and space',
}
)}
'SERVICE_NAME': '',
# ${i18n.translate(
'xpack.apm.tutorial.djangoClient.configure.commands.useIfApmServerRequiresTokenComment',
{
defaultMessage: 'Use if APM Server requires a secret token',
}
)}
'SECRET_TOKEN': '${secretToken}',
# ${i18n.translate(
'xpack.apm.tutorial.djangoClient.configure.commands.setCustomApmServerUrlComment',
{
defaultMessage:
'Set the custom APM Server URL (default: {defaultApmServerUrl})',
values: { defaultApmServerUrl: 'http://localhost:8200' },
}
)}
'SERVER_URL': '${apmServerUrl}',
# ${i18n.translate(
'xpack.apm.tutorial.djangoClient.configure.commands.setServiceEnvironmentComment',
{
defaultMessage: 'Set the service environment',
}
)}
'ENVIRONMENT': 'production',
{curlyClose}
# ${i18n.translate(
'xpack.apm.tutorial.djangoClient.configure.commands.addTracingMiddlewareComment',
{
defaultMessage:
'To send performance metrics, add our tracing middleware:',
}
)}
MIDDLEWARE = (
'elasticapm.contrib.django.middleware.TracingMiddleware',
#...
)`.split('\n'),
textPost: i18n.translate(
'xpack.apm.tutorial.djangoClient.configure.textPost',
{
defaultMessage:
'See the [documentation]({documentationLink}) for advanced usage.',
values: {
documentationLink:
'{config.docs.base_url}guide/en/apm/agent/python/current/django-support.html',
},
}
),
},
];
export const createFlaskAgentInstructions = (
apmServerUrl = '',
secretToken = ''
) => [
{
title: i18n.translate('xpack.apm.tutorial.flaskClient.install.title', {
defaultMessage: 'Install the APM agent',
}),
textPre: i18n.translate('xpack.apm.tutorial.flaskClient.install.textPre', {
defaultMessage: 'Install the APM agent for Python as a dependency.',
}),
commands: ['$ pip install elastic-apm[flask]'],
},
{
title: i18n.translate('xpack.apm.tutorial.flaskClient.configure.title', {
defaultMessage: 'Configure the agent',
}),
textPre: i18n.translate(
'xpack.apm.tutorial.flaskClient.configure.textPre',
{
defaultMessage:
'Agents are libraries that run inside of your application process. \
APM services are created programmatically based on the `SERVICE_NAME`.',
}
),
commands: `# ${i18n.translate(
'xpack.apm.tutorial.flaskClient.configure.commands.initializeUsingEnvironmentVariablesComment',
{
defaultMessage: 'initialize using environment variables',
}
)}
from elasticapm.contrib.flask import ElasticAPM
app = Flask(__name__)
apm = ElasticAPM(app)
# ${i18n.translate(
'xpack.apm.tutorial.flaskClient.configure.commands.configureElasticApmComment',
{
defaultMessage:
"or configure to use ELASTIC_APM in your application's settings",
}
)}
from elasticapm.contrib.flask import ElasticAPM
app.config['ELASTIC_APM'] = {curlyOpen}
# ${i18n.translate(
'xpack.apm.tutorial.flaskClient.configure.commands.setRequiredServiceNameComment',
{
defaultMessage: 'Set the required service name. Allowed characters:',
}
)}
# ${i18n.translate(
'xpack.apm.tutorial.flaskClient.configure.commands.allowedCharactersComment',
{
defaultMessage: 'a-z, A-Z, 0-9, -, _, and space',
}
)}
'SERVICE_NAME': '',
# ${i18n.translate(
'xpack.apm.tutorial.flaskClient.configure.commands.useIfApmServerRequiresTokenComment',
{
defaultMessage: 'Use if APM Server requires a secret token',
}
)}
'SECRET_TOKEN': '${secretToken}',
# ${i18n.translate(
'xpack.apm.tutorial.flaskClient.configure.commands.setCustomApmServerUrlComment',
{
defaultMessage:
'Set the custom APM Server URL (default: {defaultApmServerUrl})',
values: { defaultApmServerUrl: 'http://localhost:8200' },
}
)}
'SERVER_URL': '${apmServerUrl}',
# ${i18n.translate(
'xpack.apm.tutorial.flaskClient.configure.commands.setServiceEnvironmentComment',
{
defaultMessage: 'Set the service environment',
}
)}
'ENVIRONMENT': 'production',
{curlyClose}
apm = ElasticAPM(app)`.split('\n'),
textPost: i18n.translate(
'xpack.apm.tutorial.flaskClient.configure.textPost',
{
defaultMessage:
'See the [documentation]({documentationLink}) for advanced usage.',
values: {
documentationLink:
'{config.docs.base_url}guide/en/apm/agent/python/current/flask-support.html',
},
}
),
},
];
export const createRailsAgentInstructions = (
apmServerUrl = '',
secretToken = ''
) => [
{
title: i18n.translate('xpack.apm.tutorial.railsClient.install.title', {
defaultMessage: 'Install the APM agent',
}),
textPre: i18n.translate('xpack.apm.tutorial.railsClient.install.textPre', {
defaultMessage: 'Add the agent to your Gemfile.',
}),
commands: [`gem 'elastic-apm'`],
},
{
title: i18n.translate('xpack.apm.tutorial.railsClient.configure.title', {
defaultMessage: 'Configure the agent',
}),
textPre: i18n.translate(
'xpack.apm.tutorial.railsClient.configure.textPre',
{
defaultMessage:
'APM is automatically started when your app boots. Configure the agent, by creating the config file {configFile}',
values: { configFile: '`config/elastic_apm.yml`' },
}
),
commands: `# config/elastic_apm.yml:
# Set the service name - allowed characters: a-z, A-Z, 0-9, -, _ and space
# Defaults to the name of your Rails app
service_name: 'my-service'
# Use if APM Server requires a secret token
secret_token: '${secretToken}'
# Set the custom APM Server URL (default: http://localhost:8200)
server_url: '${apmServerUrl || 'http://localhost:8200'}'
# Set the service environment
environment: 'production'`.split('\n'),
textPost: i18n.translate(
'xpack.apm.tutorial.railsClient.configure.textPost',
{
defaultMessage:
'See the [documentation]({documentationLink}) for configuration options and advanced usage.\n\n',
values: {
documentationLink:
'{config.docs.base_url}guide/en/apm/agent/ruby/current/index.html',
},
}
),
},
];
export const createRackAgentInstructions = (
apmServerUrl = '',
secretToken = ''
) => [
{
title: i18n.translate('xpack.apm.tutorial.rackClient.install.title', {
defaultMessage: 'Install the APM agent',
}),
textPre: i18n.translate('xpack.apm.tutorial.rackClient.install.textPre', {
defaultMessage: 'Add the agent to your Gemfile.',
}),
commands: [`gem 'elastic-apm'`],
},
{
title: i18n.translate('xpack.apm.tutorial.rackClient.configure.title', {
defaultMessage: 'Configure the agent',
}),
textPre: i18n.translate('xpack.apm.tutorial.rackClient.configure.textPre', {
defaultMessage:
'For Rack or a compatible framework (e.g. Sinatra), include the middleware in your app and start the agent.',
}),
commands: `# config.ru
require 'sinatra/base'
class MySinatraApp < Sinatra::Base
use ElasticAPM::Middleware
# ...
end
ElasticAPM.start(
app: MySinatraApp, # ${i18n.translate(
'xpack.apm.tutorial.rackClient.configure.commands.requiredComment',
{
defaultMessage: 'required',
}
)}
config_file: '' # ${i18n.translate(
'xpack.apm.tutorial.rackClient.configure.commands.optionalComment',
{
defaultMessage: 'optional, defaults to config/elastic_apm.yml',
}
)}
)
run MySinatraApp
at_exit {curlyOpen} ElasticAPM.stop {curlyClose}`.split('\n'),
},
{
title: i18n.translate('xpack.apm.tutorial.rackClient.createConfig.title', {
defaultMessage: 'Create config file',
}),
textPre: i18n.translate(
'xpack.apm.tutorial.rackClient.createConfig.textPre',
{
defaultMessage: 'Create a config file {configFile}:',
values: { configFile: '`config/elastic_apm.yml`' },
}
),
commands: `# config/elastic_apm.yml:
# ${i18n.translate(
'xpack.apm.tutorial.rackClient.createConfig.commands.setServiceNameComment',
{
defaultMessage:
'Set the service name - allowed characters: a-z, A-Z, 0-9, -, _ and space',
}
)}
# ${i18n.translate(
'xpack.apm.tutorial.rackClient.createConfig.commands.defaultsToTheNameOfRackAppClassComment',
{
defaultMessage: "Defaults to the name of your Rack app's class.",
}
)}
service_name: 'my-service'
# ${i18n.translate(
'xpack.apm.tutorial.rackClient.createConfig.commands.useIfApmServerRequiresTokenComment',
{
defaultMessage: 'Use if APM Server requires a token',
}
)}
secret_token: '${secretToken}'
# ${i18n.translate(
'xpack.apm.tutorial.rackClient.createConfig.commands.setCustomApmServerComment',
{
defaultMessage:
'Set custom APM Server URL (default: {defaultServerUrl})',
values: { defaultServerUrl: 'http://localhost:8200' },
}
)}
server_url: '${apmServerUrl || 'http://localhost:8200'}',
# ${i18n.translate(
'xpack.apm.tutorial.rackClient.createConfig.commands.setServiceEnvironment',
{
defaultMessage: 'Set the service environment',
}
)}
environment: 'production'`.split('\n'),
textPost: i18n.translate(
'xpack.apm.tutorial.rackClient.createConfig.textPost',
{
defaultMessage:
'See the [documentation]({documentationLink}) for configuration options and advanced usage.\n\n',
values: {
documentationLink:
'{config.docs.base_url}guide/en/apm/agent/ruby/current/index.html',
},
}
),
},
];
export const createJsAgentInstructions = (apmServerUrl = '') => [
{
title: i18n.translate(
'xpack.apm.tutorial.jsClient.enableRealUserMonitoring.title',
{
defaultMessage: 'Enable Real User Monitoring support in APM Server',
}
),
textPre: i18n.translate(
'xpack.apm.tutorial.jsClient.enableRealUserMonitoring.textPre',
{
defaultMessage:
'APM Server disables RUM support by default. See the [documentation]({documentationLink}) \
for details on how to enable RUM support.',
values: {
documentationLink:
'{config.docs.base_url}guide/en/apm/server/{config.docs.version}/configuration-rum.html',
},
}
),
},
{
title: i18n.translate(
'xpack.apm.tutorial.jsClient.installDependency.title',
{
defaultMessage: 'Set up the Agent as a dependency',
}
),
textPre: i18n.translate(
'xpack.apm.tutorial.jsClient.installDependency.textPre',
{
defaultMessage:
'You can install the Agent as a dependency to your application with \
`npm install @elastic/apm-rum --save`.\n\n\
The Agent can then be initialized and configured in your application like this:',
}
),
commands: `import {curlyOpen} init as initApm {curlyClose} from '@elastic/apm-rum'
var apm = initApm({curlyOpen}
// ${i18n.translate(
'xpack.apm.tutorial.jsClient.installDependency.commands.setRequiredServiceNameComment',
{
defaultMessage:
'Set required service name (allowed characters: a-z, A-Z, 0-9, -, _, and space)',
}
)}
serviceName: 'your-app-name',
// ${i18n.translate(
'xpack.apm.tutorial.jsClient.installDependency.commands.setCustomApmServerUrlComment',
{
defaultMessage:
'Set custom APM Server URL (default: {defaultApmServerUrl})',
values: { defaultApmServerUrl: 'http://localhost:8200' },
}
)}
serverUrl: '${apmServerUrl}',
// ${i18n.translate(
'xpack.apm.tutorial.jsClient.installDependency.commands.setServiceVersionComment',
{
defaultMessage:
'Set the service version (required for source map feature)',
}
)}
serviceVersion: '',
// ${i18n.translate(
'xpack.apm.tutorial.jsClient.installDependency.commands.setServiceEnvironmentComment',
{
defaultMessage: 'Set the service environment',
}
)}
environment: 'production'
{curlyClose})`.split('\n'),
textPost: i18n.translate(
'xpack.apm.tutorial.jsClient.installDependency.textPost',
{
defaultMessage:
'Framework integrations, like React or Angular, have custom dependencies. \
See the [integration documentation]({docLink}) for more information.',
values: {
docLink:
'{config.docs.base_url}guide/en/apm/agent/rum-js/current/framework-integrations.html',
},
}
),
},
{
title: i18n.translate('xpack.apm.tutorial.jsClient.scriptTags.title', {
defaultMessage: 'Set up the Agent with Script Tags',
}),
textPre: i18n.translate('xpack.apm.tutorial.jsClient.scriptTags.textPre', {
defaultMessage:
"Alternatively, you can use Script tags to set up and configure the Agent. \
Add a `<script>` tag to the HTML page and use the `elasticApm` global object to load and initialize the agent. \
Don't forget to download the latest version of the RUM Agent from [GitHub]({GitHubLink}) or [UNPKG]({UnpkgLink}), \
and host the file on your Server/CDN before deploying to production.",
values: {
GitHubLink:
'https://github.com/elastic/apm-agent-rum-js/releases/latest',
UnpkgLink:
'https://unpkg.com/@elastic/apm-rum/dist/bundles/elastic-apm-rum.umd.min.js',
},
}),
commands: `\
<script src="https://your-cdn-host.com/path/to/elastic-apm-rum.umd.min.js" crossorigin></script>
<script>
elasticApm.init({curlyOpen}
serviceName: 'your-app-name',
serverUrl: 'http://localhost:8200',
{curlyClose})
</script>
`.split('\n'),
},
];
export const createGoAgentInstructions = (
apmServerUrl = '',
secretToken = ''
) => [
{
title: i18n.translate('xpack.apm.tutorial.goClient.install.title', {
defaultMessage: 'Install the APM agent',
}),
textPre: i18n.translate('xpack.apm.tutorial.goClient.install.textPre', {
defaultMessage: 'Install the APM agent packages for Go.',
}),
commands: ['go get go.elastic.co/apm'],
},
{
title: i18n.translate('xpack.apm.tutorial.goClient.configure.title', {
defaultMessage: 'Configure the agent',
}),
textPre: i18n.translate('xpack.apm.tutorial.goClient.configure.textPre', {
defaultMessage:
'Agents are libraries that run inside of your application process. \
APM services are created programmatically based on the executable \
file name, or the `ELASTIC_APM_SERVICE_NAME` environment variable.',
}),
commands: `# ${i18n.translate(
'xpack.apm.tutorial.goClient.configure.commands.initializeUsingEnvironmentVariablesComment',
{
defaultMessage: 'Initialize using environment variables:',
}
)}
# ${i18n.translate(
'xpack.apm.tutorial.goClient.configure.commands.setServiceNameComment',
{
defaultMessage:
'Set the service name. Allowed characters: # a-z, A-Z, 0-9, -, _, and space.',
}
)}
# ${i18n.translate(
'xpack.apm.tutorial.goClient.configure.commands.usedExecutableNameComment',
{
defaultMessage:
'If ELASTIC_APM_SERVICE_NAME is not specified, the executable name will be used.',
}
)}
export ELASTIC_APM_SERVICE_NAME=
# ${i18n.translate(
'xpack.apm.tutorial.goClient.configure.commands.setCustomApmServerUrlComment',
{
defaultMessage:
'Set custom APM Server URL (default: {defaultApmServerUrl})',
values: { defaultApmServerUrl: 'http://localhost:8200' },
}
)}
export ELASTIC_APM_SERVER_URL=${apmServerUrl}
# ${i18n.translate(
'xpack.apm.tutorial.goClient.configure.commands.useIfApmRequiresTokenComment',
{
defaultMessage: 'Use if APM Server requires a secret token',
}
)}
export ELASTIC_APM_SECRET_TOKEN=${secretToken}
# ${i18n.translate(
'xpack.apm.tutorial.goClient.configure.commands.setServiceEnvironment',
{
defaultMessage: 'Set the service environment',
}
)}
export ELASTIC_APM_ENVIRONMENT=
`.split('\n'),
textPost: i18n.translate('xpack.apm.tutorial.goClient.configure.textPost', {
defaultMessage:
'See the [documentation]({documentationLink}) for advanced configuration.',
values: {
documentationLink:
'{config.docs.base_url}guide/en/apm/agent/go/current/configuration.html',
},
}),
},
{
title: i18n.translate('xpack.apm.tutorial.goClient.instrument.title', {
defaultMessage: 'Instrument your application',
}),
textPre: i18n.translate('xpack.apm.tutorial.goClient.instrument.textPre', {
defaultMessage:
'Instrument your Go application by using one of the provided instrumentation modules or \
by using the tracer API directly.',
}),
commands: `\
import (
"net/http"
"go.elastic.co/apm/module/apmhttp"
)
func main() {curlyOpen}
mux := http.NewServeMux()
...
http.ListenAndServe(":8080", apmhttp.Wrap(mux))
{curlyClose}
`.split('\n'),
textPost: i18n.translate(
'xpack.apm.tutorial.goClient.instrument.textPost',
{
defaultMessage:
'See the [documentation]({documentationLink}) for a detailed \
guide to instrumenting Go source code.',
values: {
documentationLink:
'{config.docs.base_url}guide/en/apm/agent/go/current/instrumenting-source.html',
},
}
),
},
];
export const createJavaAgentInstructions = (
apmServerUrl = '',
secretToken = ''
) => [
{
title: i18n.translate('xpack.apm.tutorial.javaClient.download.title', {
defaultMessage: 'Download the APM agent',
}),
textPre: i18n.translate('xpack.apm.tutorial.javaClient.download.textPre', {
defaultMessage:
'Download the agent jar from [Maven Central]({mavenCentralLink}). \
Do **not** add the agent as a dependency to your application.',
values: {
mavenCentralLink:
'http://search.maven.org/#search%7Cga%7C1%7Ca%3Aelastic-apm-agent',
},
}),
},
{
title: i18n.translate(
'xpack.apm.tutorial.javaClient.startApplication.title',
{
defaultMessage: 'Start your application with the javaagent flag',
}
),
textPre: i18n.translate(
'xpack.apm.tutorial.javaClient.startApplication.textPre',
{
defaultMessage:
'Add the `-javaagent` flag and configure the agent with system properties.\n\n \
* Set the required service name (allowed characters: a-z, A-Z, 0-9, -, _, and space)\n \
* Set the custom APM Server URL (default: {customApmServerUrl})\n \
* Set the APM Server secret token\n \
* Set the service environment\n \
* Set the base package of your application',
values: { customApmServerUrl: 'http://localhost:8200' },
}
),
commands: `java -javaagent:/path/to/elastic-apm-agent-<version>.jar \\
-Delastic.apm.service_name=my-application \\
-Delastic.apm.server_urls=${apmServerUrl || 'http://localhost:8200'} \\
-Delastic.apm.secret_token=${secretToken} \\
-Delastic.apm.environment=production \\
-Delastic.apm.application_packages=org.example \\
-jar my-application.jar`.split('\n'),
textPost: i18n.translate(
'xpack.apm.tutorial.javaClient.startApplication.textPost',
{
defaultMessage:
'See the [documentation]({documentationLink}) for configuration options and advanced \
usage.',
values: {
documentationLink:
'{config.docs.base_url}guide/en/apm/agent/java/current/index.html',
},
}
),
},
];
export const createDotNetAgentInstructions = (
apmServerUrl = '',
secretToken = ''
) => [
{
title: i18n.translate('xpack.apm.tutorial.dotNetClient.download.title', {
defaultMessage: 'Download the APM agent',
}),
textPre: i18n.translate(
'xpack.apm.tutorial.dotNetClient.download.textPre',
{
defaultMessage:
'Add the the agent package(s) from [NuGet]({allNuGetPackagesLink}) to your .NET application. There are multiple \
NuGet packages available for different use cases. \n\nFor an ASP.NET Core application with Entity Framework \
Core download the [Elastic.Apm.NetCoreAll]({netCoreAllApmPackageLink}) package. This package will automatically add every \
agent component to your application. \n\n In case you would like to minimize the dependencies, you can use the \
[Elastic.Apm.AspNetCore]({aspNetCorePackageLink}) package for just \
ASP.NET Core monitoring or the [Elastic.Apm.EfCore]({efCorePackageLink}) package for just Entity Framework Core monitoring. \n\n \
In case you only want to use the public Agent API for manual instrumentation use the [Elastic.Apm]({elasticApmPackageLink}) package.',
values: {
allNuGetPackagesLink: 'https://www.nuget.org/packages?q=Elastic.apm',
netCoreAllApmPackageLink:
'https://www.nuget.org/packages/Elastic.Apm.NetCoreAll',
aspNetCorePackageLink:
'https://www.nuget.org/packages/Elastic.Apm.AspNetCore',
efCorePackageLink:
'https://www.nuget.org/packages/Elastic.Apm.EntityFrameworkCore',
elasticApmPackageLink: 'https://www.nuget.org/packages/Elastic.Apm',
},
}
),
},
{
title: i18n.translate(
'xpack.apm.tutorial.dotNetClient.configureApplication.title',
{
defaultMessage: 'Add the agent to the application',
}
),
textPre: i18n.translate(
'xpack.apm.tutorial.dotNetClient.configureApplication.textPre',
{
defaultMessage:
'In case of ASP.NET Core with the `Elastic.Apm.NetCoreAll` package, call the `UseAllElasticApm` \
method in the `Configure` method within the `Startup.cs` file.',
}
),
commands: `public class Startup
{curlyOpen}
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{curlyOpen}
app.UseAllElasticApm(Configuration);
//…rest of the method
{curlyClose}
//…rest of the class
{curlyClose}`.split('\n'),
textPost: i18n.translate(
'xpack.apm.tutorial.dotNetClient.configureApplication.textPost',
{
defaultMessage:
'Passing an `IConfiguration` instance is optional and by doing so, the agent will read config settings through this \
`IConfiguration` instance (e.g. from the `appsettings.json` file).',
}
),
},
{
title: i18n.translate(
'xpack.apm.tutorial.dotNetClient.configureAgent.title',
{
defaultMessage: 'Sample appsettings.json file:',
}
),
commands: `{curlyOpen}
"ElasticApm": {curlyOpen}
"SecretToken": "${secretToken}",
"ServerUrls": "${
apmServerUrl || 'http://localhost:8200'
}", //Set custom APM Server URL (default: http://localhost:8200)
"ServiceName": "MyApp", //allowed characters: a-z, A-Z, 0-9, -, _, and space. Default is the entry assembly of the application
"Environment": "production", // Set the service environment
{curlyClose}
{curlyClose}`.split('\n'),
textPost: i18n.translate(
'xpack.apm.tutorial.dotNetClient.configureAgent.textPost',
{
defaultMessage:
'In case you don’t pass an `IConfiguration` instance to the agent (e.g. in case of non ASP.NET Core applications) \
you can also configure the agent through environment variables. \n \
See [the documentation]({documentationLink}) for advanced usage.',
values: {
documentationLink:
'{config.docs.base_url}guide/en/apm/agent/dotnet/current/configuration.html',
},
}
),
},
];
export const createPhpAgentInstructions = (
apmServerUrl = '',
secretToken = ''
) => [
{
title: i18n.translate('xpack.apm.tutorial.phpClient.download.title', {
defaultMessage: 'Download the APM agent',
}),
textPre: i18n.translate('xpack.apm.tutorial.phpClient.download.textPre', {
defaultMessage:
'Download the package corresponding to your platform from [GitHub releases]({githubReleasesLink}).',
values: {
githubReleasesLink: 'https://github.com/elastic/apm-agent-php/releases',
},
}),
},
{
title: i18n.translate('xpack.apm.tutorial.phpClient.installPackage.title', {
defaultMessage: 'Install the downloaded package',
}),
textPre: i18n.translate(
'xpack.apm.tutorial.phpClient.installPackage.textPre',
{
defaultMessage: 'For example on Alpine Linux using APK package:',
}
),
commands: ['apk add --allow-untrusted <package-file>.apk'],
textPost: i18n.translate(
'xpack.apm.tutorial.phpClient.installPackage.textPost',
{
defaultMessage:
'See the [documentation]({documentationLink}) for installation commands on other supported platforms and advanced installation.',
values: {
documentationLink:
'{config.docs.base_url}guide/en/apm/agent/php/current/setup.html',
},
}
),
},
{
title: i18n.translate('xpack.apm.tutorial.phpClient.configureAgent.title', {
defaultMessage: 'Configure the agent',
}),
textPre: i18n.translate(
'xpack.apm.tutorial.phpClient.configureAgent.textPre',
{
defaultMessage:
'APM is automatically started when your app boots. Configure the agent either via `php.ini` file:',
}
),
commands: `elastic_apm.server_url=http://localhost:8200
elastic_apm.service_name="My service"
`.split('\n'),
textPost: i18n.translate(
'xpack.apm.tutorial.phpClient.configure.textPost',
{
defaultMessage:
'See the [documentation]({documentationLink}) for configuration options and advanced usage.\n\n',
values: {
documentationLink:
'{config.docs.base_url}guide/en/apm/agent/php/current/configuration.html',
},
}
),
},
];

70
src/plugins/apm_oss/server/tutorial/instructions/apm_server_instructions.ts → x-pack/plugins/apm/server/tutorial/instructions/apm_server_instructions.ts
View file

@ -1,18 +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.
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
import { i18n } from '@kbn/i18n';
export const createEditConfig = () => ({
title: i18n.translate('apmOss.tutorial.editConfig.title', {
title: i18n.translate('xpack.apm.tutorial.editConfig.title', {
defaultMessage: 'Edit the configuration',
}),
textPre: i18n.translate('apmOss.tutorial.editConfig.textPre', {
textPre: i18n.translate('xpack.apm.tutorial.editConfig.textPre', {
defaultMessage:
"If you're using an X-Pack secured version of Elastic Stack, you must specify \
credentials in the `apm-server.yml` config file.",
@ -26,10 +25,10 @@ credentials in the `apm-server.yml` config file.",
});
const createStartServer = () => ({
title: i18n.translate('apmOss.tutorial.startServer.title', {
title: i18n.translate('xpack.apm.tutorial.startServer.title', {
defaultMessage: 'Start APM Server',
}),
textPre: i18n.translate('apmOss.tutorial.startServer.textPre', {
textPre: i18n.translate('xpack.apm.tutorial.startServer.textPre', {
defaultMessage:
'The server processes and stores application performance metrics in Elasticsearch.',
}),
@ -56,7 +55,7 @@ export function createStartServerUnix() {
}
const createDownloadServerTitle = () =>
i18n.translate('apmOss.tutorial.downloadServer.title', {
i18n.translate('xpack.apm.tutorial.downloadServer.title', {
defaultMessage: 'Download and unpack APM Server',
});
@ -75,8 +74,9 @@ export const createDownloadServerDeb = () => ({
'curl -L -O https://artifacts.elastic.co/downloads/apm-server/apm-server-{config.kibana.version}-amd64.deb',
'sudo dpkg -i apm-server-{config.kibana.version}-amd64.deb',
],
textPost: i18n.translate('apmOss.tutorial.downloadServerTitle', {
defaultMessage: 'Looking for the 32-bit packages? See the [Download page]({downloadPageLink}).',
textPost: i18n.translate('xpack.apm.tutorial.downloadServerTitle', {
defaultMessage:
'Looking for the 32-bit packages? See the [Download page]({downloadPageLink}).',
values: {
downloadPageLink: '{config.docs.base_url}downloads/apm/apm-server',
},
@ -89,8 +89,9 @@ export const createDownloadServerRpm = () => ({
'curl -L -O https://artifacts.elastic.co/downloads/apm-server/apm-server-{config.kibana.version}-x86_64.rpm',
'sudo rpm -vi apm-server-{config.kibana.version}-x86_64.rpm',
],
textPost: i18n.translate('apmOss.tutorial.downloadServerRpm', {
defaultMessage: 'Looking for the 32-bit packages? See the [Download page]({downloadPageLink}).',
textPost: i18n.translate('xpack.apm.tutorial.downloadServerRpm', {
defaultMessage:
'Looking for the 32-bit packages? See the [Download page]({downloadPageLink}).',
values: {
downloadPageLink: '{config.docs.base_url}downloads/apm/apm-server',
},
@ -103,32 +104,41 @@ export function createWindowsServerInstructions() {
return [
{
title: createDownloadServerTitle(),
textPre: i18n.translate('apmOss.tutorial.windowsServerInstructions.textPre', {
defaultMessage:
'1. Download the APM Server Windows zip file from the \
textPre: i18n.translate(
'xpack.apm.tutorial.windowsServerInstructions.textPre',
{
defaultMessage:
'1. Download the APM Server Windows zip file from the \
[Download page]({downloadPageLink}).\n2. Extract the contents of \
the zip file into {zipFileExtractFolder}.\n3. Rename the {apmServerDirectory} \
directory to `APM-Server`.\n4. Open a PowerShell prompt as an Administrator \
(right-click the PowerShell icon and select \
**Run As Administrator**). If you are running Windows XP, you might need to download and install \
PowerShell.\n5. From the PowerShell prompt, run the following commands to install APM Server as a Windows service:',
values: {
downloadPageLink: 'https://www.elastic.co/downloads/apm/apm-server',
zipFileExtractFolder: '`C:\\Program Files`',
apmServerDirectory: '`apm-server-{config.kibana.version}-windows`',
},
}),
commands: [`cd 'C:\\Program Files\\APM-Server'`, `.\\install-service-apm-server.ps1`],
textPost: i18n.translate('apmOss.tutorial.windowsServerInstructions.textPost', {
defaultMessage:
'Note: If script execution is disabled on your system, \
values: {
downloadPageLink: 'https://www.elastic.co/downloads/apm/apm-server',
zipFileExtractFolder: '`C:\\Program Files`',
apmServerDirectory: '`apm-server-{config.kibana.version}-windows`',
},
}
),
commands: [
`cd 'C:\\Program Files\\APM-Server'`,
`.\\install-service-apm-server.ps1`,
],
textPost: i18n.translate(
'xpack.apm.tutorial.windowsServerInstructions.textPost',
{
defaultMessage:
'Note: If script execution is disabled on your system, \
you need to set the execution policy for the current session \
to allow the script to run. For example: {command}.',
values: {
command:
'`PowerShell.exe -ExecutionPolicy UnRestricted -File .\\install-service-apm-server.ps1`',
},
}),
values: {
command:
'`PowerShell.exe -ExecutionPolicy UnRestricted -File .\\install-service-apm-server.ps1`',
},
}
),
},
createEditConfig(),
{

127
x-pack/plugins/translations/translations/ja-JP.json
View file

@ -125,133 +125,6 @@
"advancedSettings.searchBar.unableToParseQueryErrorMessage": "クエリをパースできません",
"advancedSettings.searchBarAriaLabel": "高度な設定を検索",
"advancedSettings.voiceAnnouncement.ariaLabel": "詳細設定結果情報",
"apmOss.tutorial.apmAgents.statusCheck.btnLabel": "エージェントステータスを確認",
"apmOss.tutorial.apmAgents.statusCheck.errorMessage": "エージェントからまだデータを受け取っていません",
"apmOss.tutorial.apmAgents.statusCheck.successMessage": "1 つまたは複数のエージェントからデータを受け取りました",
"apmOss.tutorial.apmAgents.statusCheck.text": "アプリケーションが実行されていてエージェントがデータを送信していることを確認してください。",
"apmOss.tutorial.apmAgents.statusCheck.title": "エージェントステータス",
"apmOss.tutorial.apmAgents.title": "APM エージェント",
"apmOss.tutorial.apmServer.callOut.message": "ご使用の APM Server を 7.0 以上に更新してあることを確認してください。 Kibana の管理セクションにある移行アシスタントで 6.x データを移行することもできます。",
"apmOss.tutorial.apmServer.callOut.title": "重要：7.0 以上に更新中",
"apmOss.tutorial.apmServer.statusCheck.btnLabel": "APM Server ステータスを確認",
"apmOss.tutorial.apmServer.statusCheck.errorMessage": "APM Server が検出されました。7.0 以上に更新され、動作中であることを確認してください。",
"apmOss.tutorial.apmServer.statusCheck.successMessage": "APM Server が正しくセットアップされました",
"apmOss.tutorial.apmServer.statusCheck.text": "APM エージェントの導入を開始する前に、APM Server が動作していることを確認してください。",
"apmOss.tutorial.apmServer.statusCheck.title": "APM Server ステータス",
"apmOss.tutorial.apmServer.title": "APM Server",
"apmOss.tutorial.djangoClient.configure.commands.addAgentComment": "インストールされたアプリにエージェントを追加します",
"apmOss.tutorial.djangoClient.configure.commands.addTracingMiddlewareComment": "パフォーマンスメトリックを送信するには、追跡ミドルウェアを追加します。",
"apmOss.tutorial.djangoClient.configure.commands.allowedCharactersComment": "a-z、A-Z、0-9、-、_、スペース",
"apmOss.tutorial.djangoClient.configure.commands.setCustomApmServerUrlComment": "カスタム APM Server URL (デフォルト：{defaultApmServerUrl}) を設定します",
"apmOss.tutorial.djangoClient.configure.commands.setRequiredServiceNameComment": "任意のサービス名を設定します。使用できる文字：",
"apmOss.tutorial.djangoClient.configure.commands.setServiceEnvironmentComment": "サービス環境を設定します",
"apmOss.tutorial.djangoClient.configure.commands.useIfApmServerRequiresTokenComment": "APM Server でシークレットトークンが必要な場合に使います",
"apmOss.tutorial.djangoClient.configure.textPost": "高度な用途に関しては [ドキュメンテーション] ({documentationLink}) をご覧ください。",
"apmOss.tutorial.djangoClient.configure.textPre": "エージェントとは、アプリケーションプロセス内で実行されるライブラリです。APM サービスは「SERVICE_NAME」に基づいてプログラムで作成されます。",
"apmOss.tutorial.djangoClient.configure.title": "エージェントの構成",
"apmOss.tutorial.djangoClient.install.textPre": "Python 用の APM エージェントを依存関係としてインストールします。",
"apmOss.tutorial.djangoClient.install.title": "APM エージェントのインストール",
"apmOss.tutorial.dotNetClient.configureAgent.textPost": "エージェントに「IConfiguration」インスタンスが渡されていない場合、 (例：非 ASP.NET Core アプリケーションの場合) 、エージェントを環境変数で構成することもできます。\n 高度な用途に関しては [ドキュメンテーション] ({documentationLink}) をご覧ください。",
"apmOss.tutorial.dotNetClient.configureAgent.title": "appsettings.json ファイルの例：",
"apmOss.tutorial.dotNetClient.configureApplication.textPost": "「IConfiguration」インスタンスを渡すのは任意であり、これにより、エージェントはこの「IConfiguration」インスタンス (例：「appsettings.json」ファイル) から構成を読み込みます。",
"apmOss.tutorial.dotNetClient.configureApplication.textPre": "「Elastic.Apm.NetCoreAll」パッケージの ASP.NET Core の場合、「Startup.cs」ファイル内の「Configure」メソドの「UseElasticApm」メソドを呼び出します。",
"apmOss.tutorial.dotNetClient.configureApplication.title": "エージェントをアプリケーションに追加",
"apmOss.tutorial.dotNetClient.download.textPre": "[NuGet] ({allNuGetPackagesLink}) から .NET アプリケーションにエージェントパッケージを追加してください。用途の異なる複数の NuGet パッケージがあります。\n\nEntity Framework Core の ASP.NET Core アプリケーションの場合は、[Elastic.Apm.NetCoreAll] ({netCoreAllApmPackageLink}) パッケージをダウンロードしてください。このパッケージは、自動的にすべてのエージェントコンポーネントをアプリケーションに追加します。\n\n 依存性を最低限に抑えたい場合、ASP.NET Coreの監視のみに[Elastic.Apm.AspNetCore] ({aspNetCorePackageLink}) パッケージ、またはEntity Framework Coreの監視のみに[Elastic.Apm.EfCore] ({efCorePackageLink}) パッケージを使用することができます。\n\n 手動インストルメンテーションのみにパブリック Agent API を使用する場合は、[Elastic.Apm] ({elasticApmPackageLink}) パッケージを使用してください。",
"apmOss.tutorial.dotNetClient.download.title": "APM エージェントのダウンロード",
"apmOss.tutorial.downloadServer.title": "APM Server をダウンロードして展開します",
"apmOss.tutorial.downloadServerRpm": "32 ビットパッケージをお探しですか？[ダウンロードページ] ({downloadPageLink}) をご覧ください。",
"apmOss.tutorial.downloadServerTitle": "32 ビットパッケージをお探しですか？[ダウンロードページ] ({downloadPageLink}) をご覧ください。",
"apmOss.tutorial.editConfig.textPre": "Elastic Stack の X-Pack セキュアバージョンをご使用の場合、「apm-server.yml」構成ファイルで認証情報を指定する必要があります。",
"apmOss.tutorial.editConfig.title": "構成を編集する",
"apmOss.tutorial.flaskClient.configure.commands.allowedCharactersComment": "a-z、A-Z、0-9、-、_、スペース",
"apmOss.tutorial.flaskClient.configure.commands.configureElasticApmComment": "またはアプリケーションの設定で ELASTIC_APM を使用するよう構成します。",
"apmOss.tutorial.flaskClient.configure.commands.initializeUsingEnvironmentVariablesComment": "環境変数を使用して初期化します",
"apmOss.tutorial.flaskClient.configure.commands.setCustomApmServerUrlComment": "カスタム APM Server URL (デフォルト：{defaultApmServerUrl}) を設定します",
"apmOss.tutorial.flaskClient.configure.commands.setRequiredServiceNameComment": "任意のサービス名を設定します。使用できる文字：",
"apmOss.tutorial.flaskClient.configure.commands.setServiceEnvironmentComment": "サービス環境を設定します",
"apmOss.tutorial.flaskClient.configure.commands.useIfApmServerRequiresTokenComment": "APM Server でシークレットトークンが必要な場合に使います",
"apmOss.tutorial.flaskClient.configure.textPost": "高度な用途に関しては [ドキュメンテーション] ({documentationLink}) をご覧ください。",
"apmOss.tutorial.flaskClient.configure.textPre": "エージェントとは、アプリケーションプロセス内で実行されるライブラリです。APM サービスは「SERVICE_NAME」に基づいてプログラムで作成されます。",
"apmOss.tutorial.flaskClient.configure.title": "エージェントの構成",
"apmOss.tutorial.flaskClient.install.textPre": "Python 用の APM エージェントを依存関係としてインストールします。",
"apmOss.tutorial.flaskClient.install.title": "APM エージェントのインストール",
"apmOss.tutorial.goClient.configure.commands.initializeUsingEnvironmentVariablesComment": "環境変数を使用して初期化します：",
"apmOss.tutorial.goClient.configure.commands.setCustomApmServerUrlComment": "カスタム APM Server URL (デフォルト：{defaultApmServerUrl}) を設定します",
"apmOss.tutorial.goClient.configure.commands.setServiceEnvironment": "サービス環境を設定します",
"apmOss.tutorial.goClient.configure.commands.setServiceNameComment": "サービス名を設定します。使用できる文字は # a-z、A-Z、0-9、-、_、スペースです。",
"apmOss.tutorial.goClient.configure.commands.usedExecutableNameComment": "ELASTIC_APM_SERVICE_NAME が指定されていない場合、実行ファイルの名前が使用されます。",
"apmOss.tutorial.goClient.configure.commands.useIfApmRequiresTokenComment": "APM Server でシークレットトークンが必要な場合に使います",
"apmOss.tutorial.goClient.configure.textPost": "高度な構成に関しては [ドキュメンテーション] ({documentationLink}) をご覧ください。",
"apmOss.tutorial.goClient.configure.textPre": "エージェントとは、アプリケーションプロセス内で実行されるライブラリです。APM サービスは実行ファイル名または「ELASTIC_APM_SERVICE_NAME」環境変数に基づいてプログラムで作成されます。",
"apmOss.tutorial.goClient.configure.title": "エージェントの構成",
"apmOss.tutorial.goClient.install.textPre": "Go の APM エージェントパッケージをインストールします。",
"apmOss.tutorial.goClient.install.title": "APM エージェントのインストール",
"apmOss.tutorial.goClient.instrument.textPost": "Go のソースコードのインストルメンテーションの詳細ガイドは、[ドキュメンテーション] ({documentationLink}) をご覧ください。",
"apmOss.tutorial.goClient.instrument.textPre": "提供されたインストルメンテーションモジュールの 1 つ、またはトレーサー API を直接使用して、Go アプリケーションにインストルメンテーションを設定します。",
"apmOss.tutorial.goClient.instrument.title": "アプリケーションのインストルメンテーション",
"apmOss.tutorial.introduction": "アプリケーション内から詳細なパフォーマンスメトリックやエラーを収集します。",
"apmOss.tutorial.javaClient.download.textPre": "[Maven Central] ({mavenCentralLink}) からエージェントをダウンロードします。アプリケーションにエージェントを依存関係として「追加しない」でください。",
"apmOss.tutorial.javaClient.download.title": "APM エージェントのダウンロード",
"apmOss.tutorial.javaClient.startApplication.textPost": "構成オプションと高度な用途に関しては、[ドキュメンテーション] ({documentationLink}) をご覧ください。",
"apmOss.tutorial.javaClient.startApplication.textPre": "「-javaagent」フラグを追加し、システムプロパティを使用してエージェントを構成します。\n\n * 任意のサービス名を設定します (使用可能な文字は a-z、A-Z、0-9、-、_、スペースです) \n * カスタム APM Server URL (デフォルト：{customApmServerUrl}) を設定します\n * APM Server シークレットトークンを設定します\n * サービス環境を設定します\n * アプリケーションのベースパッケージを設定します",
"apmOss.tutorial.javaClient.startApplication.title": "javaagent フラグでアプリケーションを起動",
"apmOss.tutorial.jsClient.enableRealUserMonitoring.textPre": "デフォルトでは、APM Server を実行すると RUM サポートは無効になります。RUM サポートを有効にする手順については、[ドキュメンテーション] ({documentationLink}) をご覧ください。",
"apmOss.tutorial.jsClient.enableRealUserMonitoring.title": "APM Server のリアルユーザー監視サポートを有効にする",
"apmOss.tutorial.jsClient.installDependency.commands.setCustomApmServerUrlComment": "カスタム APM Server URL (デフォルト：{defaultApmServerUrl}) を設定します",
"apmOss.tutorial.jsClient.installDependency.commands.setRequiredServiceNameComment": "任意のサービス名を設定します (使用可能な文字は a-z、A-Z、0-9、-、_、スペースです) ",
"apmOss.tutorial.jsClient.installDependency.commands.setServiceEnvironmentComment": "サービス環境を設定します",
"apmOss.tutorial.jsClient.installDependency.commands.setServiceVersionComment": "サービスバージョンを設定します (ソースマップ機能に必要) ",
"apmOss.tutorial.jsClient.installDependency.textPost": "React や Angular などのフレームワーク統合には、カスタム依存関係があります。詳細は [統合ドキュメント] ({docLink}) をご覧ください。",
"apmOss.tutorial.jsClient.installDependency.textPre": "「npm install @elastic/apm-rum --save」でエージェントをアプリケーションへの依存関係としてインストールできます。\n\nその後で以下のようにアプリケーションでエージェントを初期化して構成できます。",
"apmOss.tutorial.jsClient.installDependency.title": "エージェントを依存関係としてセットアップ",
"apmOss.tutorial.jsClient.scriptTags.textPre": "または、スクリプトタグを使用してエージェントのセットアップと構成ができます。` を追加<script>` tag to the HTML page and use the `elasticApm` global object to load and initialize the agent. Don't forget to download the latest version of the RUM Agent from [GitHub]({GitHubLink}) or [UNPKG]({UnpkgLink}), and host the file on your Server/CDN before deploying to production.",
"apmOss.tutorial.jsClient.scriptTags.title": "スクリプトタグを付けてエージェントをセットアップ",
"apmOss.tutorial.nodeClient.configure.commands.addThisToTheFileTopComment": "アプリに読み込んだファイルのトップにこれを追加します",
"apmOss.tutorial.nodeClient.configure.commands.allowedCharactersComment": "使用できる文字は a-z、A-Z、0-9、-、_、スペースです",
"apmOss.tutorial.nodeClient.configure.commands.setCustomApmServerUrlComment": "カスタム APM Server URL (デフォルト：{defaultApmServerUrl}) を設定します",
"apmOss.tutorial.nodeClient.configure.commands.setCustomServiceEnvironmentComment": "サービス環境を設定します",
"apmOss.tutorial.nodeClient.configure.commands.setRequiredServiceNameComment": "package.json からサービス名を上書きします",
"apmOss.tutorial.nodeClient.configure.commands.useIfApmRequiresTokenComment": "APM Server でシークレットトークンが必要な場合に使います",
"apmOss.tutorial.nodeClient.configure.textPost": "[Babel/ES モジュール] ({babelEsModulesLink}) との使用を含む高度な用途に関しては、 [ドキュメンテーション] ({documentationLink}) をご覧ください。",
"apmOss.tutorial.nodeClient.configure.textPre": "エージェントとは、アプリケーションプロセス内で実行されるライブラリです。APMサービスは「serviceName」に基づいてプログラムで作成されます。このエージェントはさまざまなフレームワークをサポートしていますが、カスタムスタックで使用することもできます。",
"apmOss.tutorial.nodeClient.configure.title": "エージェントの構成",
"apmOss.tutorial.nodeClient.install.textPre": "Node.js 用の APM エージェントをアプリケーションに依存関係としてインストール。",
"apmOss.tutorial.nodeClient.install.title": "APM エージェントのインストール",
"apmOss.tutorial.phpClient.configure.textPost": "構成オプションと高度な用途に関しては、[ドキュメンテーション] ({documentationLink}) をご覧ください。\n\n",
"apmOss.tutorial.phpClient.configureAgent.textPre": "APM はアプリの起動時に自動的に起動します。「php.ini」ファイルを使用してエージェントを構成：",
"apmOss.tutorial.phpClient.configureAgent.title": "エージェントの構成",
"apmOss.tutorial.phpClient.download.textPre": "[GitHub releases]({githubReleasesLink})からプラットフォームに対応するパッケージをダウンロードします。",
"apmOss.tutorial.phpClient.download.title": "APM エージェントのダウンロード",
"apmOss.tutorial.phpClient.installPackage.textPost": "他のサポートされているプラットフォームでのインストールコマンドおよび高度なインストールについては、[documentation]({documentationLink})を参照してください。",
"apmOss.tutorial.phpClient.installPackage.textPre": "Alpine LinuxでAPKパッケージを使用する例：",
"apmOss.tutorial.phpClient.installPackage.title": "ダウンロードしたパッケージをインストールする",
"apmOss.tutorial.rackClient.configure.commands.optionalComment": "オプション、デフォルトで config/elastic_apm.yml になります",
"apmOss.tutorial.rackClient.configure.commands.requiredComment": "必須",
"apmOss.tutorial.rackClient.configure.textPre": "Rack または対応フレームワーク (Sinatra など) の場合は、アプリのミドルウェアを含めてエージェントを起動してください。",
"apmOss.tutorial.rackClient.configure.title": "エージェントの構成",
"apmOss.tutorial.rackClient.createConfig.commands.defaultsToTheNameOfRackAppClassComment": "デフォルトで Rack アプリのクラスになります。",
"apmOss.tutorial.rackClient.createConfig.commands.setCustomApmServerComment": "カスタム APM Server URL を設定します (デフォルト： {defaultServerUrl}) ",
"apmOss.tutorial.rackClient.createConfig.commands.setServiceEnvironment": "サービス環境を設定します",
"apmOss.tutorial.rackClient.createConfig.commands.setServiceNameComment": "サービス名を設定します。使用できる文字は、a-z、A-Z、0-9、-、_、スペースです。",
"apmOss.tutorial.rackClient.createConfig.commands.useIfApmServerRequiresTokenComment": "APM Server でトークンが必要な場合に使います",
"apmOss.tutorial.rackClient.createConfig.textPost": "構成オプションと高度な用途に関しては、[ドキュメンテーション] ({documentationLink}) をご覧ください。\n\n",
"apmOss.tutorial.rackClient.createConfig.textPre": "構成ファイル {configFile} を作成します：",
"apmOss.tutorial.rackClient.createConfig.title": "構成ファイルの作成",
"apmOss.tutorial.rackClient.install.textPre": "Gemfile にエージェントを追加します。",
"apmOss.tutorial.rackClient.install.title": "APM エージェントのインストール",
"apmOss.tutorial.railsClient.configure.textPost": "構成オプションと高度な用途に関しては、[ドキュメンテーション] ({documentationLink}) をご覧ください。\n\n",
"apmOss.tutorial.railsClient.configure.textPre": "APM はアプリの起動時に自動的に起動します。構成ファイル {configFile} を作成してエージェントを構成します",
"apmOss.tutorial.railsClient.configure.title": "エージェントの構成",
"apmOss.tutorial.railsClient.install.textPre": "Gemfile にエージェントを追加します。",
"apmOss.tutorial.railsClient.install.title": "APM エージェントのインストール",
"apmOss.tutorial.specProvider.artifacts.dashboards.linkLabel": "APM ダッシュボード",
"apmOss.tutorial.specProvider.longDescription": "アプリケーションパフォーマンスモニタリング (APM) は、アプリケーション内から詳細なパフォーマンスメトリックやエラーを収集します。何千ものアプリケーションのパフォーマンスをリアルタイムで監視できます。[詳細] ({learnMoreLink}) 。",
"apmOss.tutorial.specProvider.name": "APM",
"apmOss.tutorial.specProvider.savedObjectsInstallMsg": "APM UI の機能には APM インデックスパターンが必要なものがあります。",
"apmOss.tutorial.startServer.textPre": "サーバーは、Elasticsearch アプリケーションのパフォーマンスメトリックを処理し保存します。",
"apmOss.tutorial.startServer.title": "APM Server の起動",
"apmOss.tutorial.windowsServerInstructions.textPost": "注：システムでスクリプトの実行が無効な場合、スクリプトを実行するために現在のセッションの実行ポリシーの設定が必要となります。例：{command}。",
"apmOss.tutorial.windowsServerInstructions.textPre": "1.[ダウンロードページ] ({downloadPageLink}) から APM Server Windows zip ファイルをダウンロードします。\n2.zip ファイルの内容を {zipFileExtractFolder} に抽出します。\n3.「{apmServerDirectory} ディレクトリの名前を「APM-Server」に変更します。\n4.管理者としてPowerShellプロンプトを開きます (PowerShellアイコンを右クリックして「管理者として実行」を選択します) 。Windows XPをご使用の場合、PowerShellのダウンロードとインストールが必要な場合があります。\n5.PowerShell プロンプトで次のコマンドを実行し、APM Server を Windows サービスとしてインストールします。",
"charts.advancedSettings.visualization.colorMappingText": "<strong>互換性</strong>パレットを使用して、値をグラフの特定の色にマッピングします。",
"charts.advancedSettings.visualization.colorMappingTextDeprecation": "この設定はサポートが終了し、Kibana 8.0 ではサポートされません。",
"charts.advancedSettings.visualization.colorMappingTitle": "カラーマッピング",

127
x-pack/plugins/translations/translations/zh-CN.json
View file

@ -128,133 +128,6 @@
"advancedSettings.voiceAnnouncement.ariaLabel": "“高级设置”的结果信息",
"advancedSettings.voiceAnnouncement.noSearchResultScreenReaderMessage": "{sectionLenght, plural, other {# 个部分}}中有 {optionLenght, plural, other {# 个选项}}",
"advancedSettings.voiceAnnouncement.searchResultScreenReaderMessage": "您搜索了“{query}”。{sectionLenght, plural, other {# 个部分}}中有 {optionLenght, plural, other {# 个选项}}",
"apmOss.tutorial.apmAgents.statusCheck.btnLabel": "检查代理状态",
"apmOss.tutorial.apmAgents.statusCheck.errorMessage": "尚未从代理收到任何数据",
"apmOss.tutorial.apmAgents.statusCheck.successMessage": "已从一个或多个代理成功接收数据",
"apmOss.tutorial.apmAgents.statusCheck.text": "确保您的应用程序正在运行且代理正在发送数据。",
"apmOss.tutorial.apmAgents.statusCheck.title": "代理状态",
"apmOss.tutorial.apmAgents.title": "APM 代理",
"apmOss.tutorial.apmServer.callOut.message": "请确保 APM Server 已更新至 7.0 或更高版本。 还可以使用 Kibana 的管理部分中的迁移助手迁移 6.x 数据。",
"apmOss.tutorial.apmServer.callOut.title": "重要说明：正在更新到 7.0 或更高版本",
"apmOss.tutorial.apmServer.statusCheck.btnLabel": "检查 APM Server 状态",
"apmOss.tutorial.apmServer.statusCheck.errorMessage": "未检测到任何 APM Server。请确保其正在运行并且您已升级到 7.0 或更高版本。",
"apmOss.tutorial.apmServer.statusCheck.successMessage": "您已正确设置 APM Server",
"apmOss.tutorial.apmServer.statusCheck.text": "在开始实施 APM 代理之前，确保 APM Server 正在运行。",
"apmOss.tutorial.apmServer.statusCheck.title": "APM Server 状态",
"apmOss.tutorial.apmServer.title": "APM Server",
"apmOss.tutorial.djangoClient.configure.commands.addAgentComment": "向已安装应用添加代理",
"apmOss.tutorial.djangoClient.configure.commands.addTracingMiddlewareComment": "要发送性能指标，请添加我们的跟踪中间件：",
"apmOss.tutorial.djangoClient.configure.commands.allowedCharactersComment": "a-z、A-Z、0-9、-、_ 以及空格",
"apmOss.tutorial.djangoClient.configure.commands.setCustomApmServerUrlComment": "设置定制 APM Server URL (默认值：{defaultApmServerUrl}) ",
"apmOss.tutorial.djangoClient.configure.commands.setRequiredServiceNameComment": "设置所需的服务名称。允许使用的字符：",
"apmOss.tutorial.djangoClient.configure.commands.setServiceEnvironmentComment": "设置服务环境",
"apmOss.tutorial.djangoClient.configure.commands.useIfApmServerRequiresTokenComment": "APM Server 需要机密令牌时使用",
"apmOss.tutorial.djangoClient.configure.textPost": "有关高级用法，请参阅[文档]({documentationLink})。",
"apmOss.tutorial.djangoClient.configure.textPre": "代理是在您的应用程序进程内运行的库。APM 服务是基于 `SERVICE_NAME` 以编程方式创建的。",
"apmOss.tutorial.djangoClient.configure.title": "配置代理",
"apmOss.tutorial.djangoClient.install.textPre": "将 Python 的 APM 代理安装为依赖项。",
"apmOss.tutorial.djangoClient.install.title": "安装 APM 代理",
"apmOss.tutorial.dotNetClient.configureAgent.textPost": "如果您未将 `IConfiguration` 实例传递给代理 (例如非 ASP.NET Core 应用程序) ， 您还可以通过环境变量配置代理。\n 有关高级用法，请参阅[文档]({documentationLink})。",
"apmOss.tutorial.dotNetClient.configureAgent.title": "样例 appsettings.json 文件：",
"apmOss.tutorial.dotNetClient.configureApplication.textPost": "传递 `IConfiguration` 实例为可选操作，通过此操作，代理将通过此 `IConfiguration` 实例 读取配置设置 (例如，从 `appsettings.json` 文件) 。",
"apmOss.tutorial.dotNetClient.configureApplication.textPre": "对于具有 `Elastic.Apm.NetCoreAll` 软件包的 ASP.NET Core，请在 `Startup.cs` 文件内的 `Configure` 方法中调用 `UseAllElasticApm`。",
"apmOss.tutorial.dotNetClient.configureApplication.title": "将代理添加到应用程序",
"apmOss.tutorial.dotNetClient.download.textPre": "将来自 [NuGet]({allNuGetPackagesLink}) 的代理软件包添加到 .NET 应用程序。有多个 NuGet 软件包可用于不同的用例。\n\n对于具有 Entity Framework Core 的 ASP.NET Core 应用程序，请下载 [Elastic.Apm.NetCoreAll]({netCoreAllApmPackageLink}) 软件包。此软件包将自动将每个 代理组件添加到您的应用程序。\n\n 如果您希望最大程度减少依存关系，您可以将 [Elastic.Apm.AspNetCore]({aspNetCorePackageLink}) 软件包仅用于 ASP.NET Core 监测，或将 [Elastic.Apm.EfCore]({efCorePackageLink}) 软件包仅用于 Entity Framework Core 监测。\n\n 如果仅希望将公共代理 API 用于手动检测，请使用 [Elastic.Apm]({elasticApmPackageLink}) 软件包。",
"apmOss.tutorial.dotNetClient.download.title": "下载 APM 代理",
"apmOss.tutorial.downloadServer.title": "下载并解压缩 APM Server",
"apmOss.tutorial.downloadServerRpm": "寻找 32 位软件包？请参阅[下载页面]({downloadPageLink})。",
"apmOss.tutorial.downloadServerTitle": "寻找 32 位软件包？请参阅[下载页面]({downloadPageLink})。",
"apmOss.tutorial.editConfig.textPre": "如果您正在使用 Elastic Stack 的 X-Pack 安全版本，则必须在 `apm-server.yml` 配置文件中指定凭据。",
"apmOss.tutorial.editConfig.title": "编辑配置",
"apmOss.tutorial.flaskClient.configure.commands.allowedCharactersComment": "a-z、A-Z、0-9、-、_ 以及空格",
"apmOss.tutorial.flaskClient.configure.commands.configureElasticApmComment": "或进行配置以在您的应用程序设置中使用 ELASTIC_APM",
"apmOss.tutorial.flaskClient.configure.commands.initializeUsingEnvironmentVariablesComment": "使用环境变量初始化",
"apmOss.tutorial.flaskClient.configure.commands.setCustomApmServerUrlComment": "设置定制 APM Server URL (默认值：{defaultApmServerUrl}) ",
"apmOss.tutorial.flaskClient.configure.commands.setRequiredServiceNameComment": "设置所需的服务名称。允许使用的字符：",
"apmOss.tutorial.flaskClient.configure.commands.setServiceEnvironmentComment": "设置服务环境",
"apmOss.tutorial.flaskClient.configure.commands.useIfApmServerRequiresTokenComment": "APM Server 需要机密令牌时使用",
"apmOss.tutorial.flaskClient.configure.textPost": "有关高级用法，请参阅[文档]({documentationLink})。",
"apmOss.tutorial.flaskClient.configure.textPre": "代理是在您的应用程序进程内运行的库。APM 服务是基于 `SERVICE_NAME` 以编程方式创建的。",
"apmOss.tutorial.flaskClient.configure.title": "配置代理",
"apmOss.tutorial.flaskClient.install.textPre": "将 Python 的 APM 代理安装为依赖项。",
"apmOss.tutorial.flaskClient.install.title": "安装 APM 代理",
"apmOss.tutorial.goClient.configure.commands.initializeUsingEnvironmentVariablesComment": "使用环境变量初始化：",
"apmOss.tutorial.goClient.configure.commands.setCustomApmServerUrlComment": "设置定制 APM Server URL (默认值：{defaultApmServerUrl}) ",
"apmOss.tutorial.goClient.configure.commands.setServiceEnvironment": "设置服务环境",
"apmOss.tutorial.goClient.configure.commands.setServiceNameComment": "设置服务名称。允许使用的字符：# a-z、A-Z、0-9、-、_ 和空格。",
"apmOss.tutorial.goClient.configure.commands.usedExecutableNameComment": "如果未指定 ELASTIC_APM_SERVICE_NAME，将会使用可执行文件名称。",
"apmOss.tutorial.goClient.configure.commands.useIfApmRequiresTokenComment": "APM Server 需要机密令牌时使用",
"apmOss.tutorial.goClient.configure.textPost": "有关高级配置，请参阅[文档]({documentationLink})。",
"apmOss.tutorial.goClient.configure.textPre": "代理是在您的应用程序进程内运行的库。APM 服务将基于可执行文件名称或 `ELASTIC_APM_SERVICE_NAME` 环境变量以编程方式进行创建。",
"apmOss.tutorial.goClient.configure.title": "配置代理",
"apmOss.tutorial.goClient.install.textPre": "安装 Go 的 APM 代理软件包。",
"apmOss.tutorial.goClient.install.title": "安装 APM 代理",
"apmOss.tutorial.goClient.instrument.textPost": "有关检测 Go 源代码的详细指南，请参阅[文档]({documentationLink})。",
"apmOss.tutorial.goClient.instrument.textPre": "使用以下已提供检测模块之一或直接使用跟踪器 API 来检测 Go 应用程序。",
"apmOss.tutorial.goClient.instrument.title": "检测您的应用程序",
"apmOss.tutorial.introduction": "从您的应用程序内收集深入全面的性能指标和错误。",
"apmOss.tutorial.javaClient.download.textPre": "从 [Maven Central]({mavenCentralLink}) 下载代理 jar。**切勿**将该代理添加为您的应用程序的依赖项。",
"apmOss.tutorial.javaClient.download.title": "下载 APM 代理",
"apmOss.tutorial.javaClient.startApplication.textPost": "有关配置选项和高级用法，请参阅[文档]({documentationLink})。",
"apmOss.tutorial.javaClient.startApplication.textPre": "添加 `-javaagent` 标志并使用系统属性配置代理。\n\n * 设置所需的服务名称 (允许使用的字符：a-z、A-Z、0-9、-、_ 和空格) \n * 设置定制 APM Server URL (默认值：{customApmServerUrl}) \n * 设置 APM Server 机密令牌\n * 设置服务环境\n * 设置您的应用程序的基础软件包",
"apmOss.tutorial.javaClient.startApplication.title": "使用 javaagent 标志启动您的应用程序",
"apmOss.tutorial.jsClient.enableRealUserMonitoring.textPre": "APM Server 默认禁用 RUM 支持。请参阅[文档]({documentationLink})以详细了解如何启用 RUM 支持。",
"apmOss.tutorial.jsClient.enableRealUserMonitoring.title": "在 APM Server 中启用真实用户监测支持",
"apmOss.tutorial.jsClient.installDependency.commands.setCustomApmServerUrlComment": "设置定制 APM Server URL (默认值：{defaultApmServerUrl}) ",
"apmOss.tutorial.jsClient.installDependency.commands.setRequiredServiceNameComment": "设置所需的服务名称 (允许使用的字符：a-z、A-Z、0-9、-、_ 和空格) ",
"apmOss.tutorial.jsClient.installDependency.commands.setServiceEnvironmentComment": "设置服务环境",
"apmOss.tutorial.jsClient.installDependency.commands.setServiceVersionComment": "设置服务版本 (源地图功能要求) ",
"apmOss.tutorial.jsClient.installDependency.textPost": "框架集成 (如 React 或 Angular) 具有定制依赖项。请参阅[集成文档]({docLink})以了解详情。",
"apmOss.tutorial.jsClient.installDependency.textPre": "可以使用 `npm install @elastic/apm-rum --save` 将代理作为依赖项安装到您的应用程序。\n\n然后可以在您的应用程序中初始化和配置代理，如下所示：",
"apmOss.tutorial.jsClient.installDependency.title": "将代理设置为依赖项",
"apmOss.tutorial.jsClient.scriptTags.textPre": "或者，也可以使用 Script 标记设置和配置代理。添加 `<script>` tag to the HTML page and use the `elasticApm` global object to load and initialize the agent. Don't forget to download the latest version of the RUM Agent from [GitHub]({GitHubLink}) or [UNPKG]({UnpkgLink}), and host the file on your Server/CDN before deploying to production.",
"apmOss.tutorial.jsClient.scriptTags.title": "使用 Script 标记设置代理",
"apmOss.tutorial.nodeClient.configure.commands.addThisToTheFileTopComment": "将其添加到您的应用中加载的第一个文件的最上面",
"apmOss.tutorial.nodeClient.configure.commands.allowedCharactersComment": "允许使用的字符：a-z、A-Z、0-9、-、_ 和空格",
"apmOss.tutorial.nodeClient.configure.commands.setCustomApmServerUrlComment": "设置定制 APM Server URL (默认值：{defaultApmServerUrl}) ",
"apmOss.tutorial.nodeClient.configure.commands.setCustomServiceEnvironmentComment": "设置服务环境",
"apmOss.tutorial.nodeClient.configure.commands.setRequiredServiceNameComment": "覆盖来自 package.json 的服务名",
"apmOss.tutorial.nodeClient.configure.commands.useIfApmRequiresTokenComment": "APM Server 需要机密令牌时使用",
"apmOss.tutorial.nodeClient.configure.textPost": "请参阅[文档]({documentationLink})以了解高级用法，包括如何用于 [Babel/ES 模块]({babelEsModulesLink})。",
"apmOss.tutorial.nodeClient.configure.textPre": "代理是在您的应用程序进程内运行的库。APM 服务是基于 `serviceName` 以编程方式创建的。此代理不仅支持各种框架，而且还可与您的定制堆栈结合使用。",
"apmOss.tutorial.nodeClient.configure.title": "配置代理",
"apmOss.tutorial.nodeClient.install.textPre": "将 Node.js 的 APM 代理安装为您的应用程序的依赖项。",
"apmOss.tutorial.nodeClient.install.title": "安装 APM 代理",
"apmOss.tutorial.phpClient.configure.textPost": "有关配置选项和高级用法，请参阅[文档]({documentationLink})。\n\n",
"apmOss.tutorial.phpClient.configureAgent.textPre": "您的应用启动时，APM 自动启动。或者通过 `php.ini` 文件配置代理：",
"apmOss.tutorial.phpClient.configureAgent.title": "配置代理",
"apmOss.tutorial.phpClient.download.textPre": "从 [GitHub 版本]({githubReleasesLink})下载与您的平台对应的软件包。",
"apmOss.tutorial.phpClient.download.title": "下载 APM 代理",
"apmOss.tutorial.phpClient.installPackage.textPost": "有关其他受支持平台和高级安装的安装命令，请参阅[文档]({documentationLink})。",
"apmOss.tutorial.phpClient.installPackage.textPre": "有关 Alpine Linux 使用 APK 软件的示例：",
"apmOss.tutorial.phpClient.installPackage.title": "安装下载的软件包",
"apmOss.tutorial.rackClient.configure.commands.optionalComment": "可选，默认为 config/elastic_apm.yml",
"apmOss.tutorial.rackClient.configure.commands.requiredComment": "必需",
"apmOss.tutorial.rackClient.configure.textPre": "对于 Rack 或兼容的框架 (例如 Sinatra) ，在您的应用中加入中间件，然后启动代理。",
"apmOss.tutorial.rackClient.configure.title": "配置代理",
"apmOss.tutorial.rackClient.createConfig.commands.defaultsToTheNameOfRackAppClassComment": "默认为 Rack 应用的类名称。",
"apmOss.tutorial.rackClient.createConfig.commands.setCustomApmServerComment": "设置定制 APM Server URL (默认值：{defaultServerUrl}) ",
"apmOss.tutorial.rackClient.createConfig.commands.setServiceEnvironment": "设置服务环境",
"apmOss.tutorial.rackClient.createConfig.commands.setServiceNameComment": "设置服务名称 — 允许使用的字符：a-z、A-Z、0-9、-、_ 和空格",
"apmOss.tutorial.rackClient.createConfig.commands.useIfApmServerRequiresTokenComment": "APM Server 需要令牌时使用",
"apmOss.tutorial.rackClient.createConfig.textPost": "有关配置选项和高级用法，请参阅[文档]({documentationLink})。\n\n",
"apmOss.tutorial.rackClient.createConfig.textPre": "创建配置文件 {configFile}：",
"apmOss.tutorial.rackClient.createConfig.title": "创建配置文件",
"apmOss.tutorial.rackClient.install.textPre": "将代理添加您的 Gemfile。",
"apmOss.tutorial.rackClient.install.title": "安装 APM 代理",
"apmOss.tutorial.railsClient.configure.textPost": "有关配置选项和高级用法，请参阅[文档]({documentationLink})。\n\n",
"apmOss.tutorial.railsClient.configure.textPre": "您的应用启动时，APM 自动启动。通过创建配置文件 {configFile} 来配置代理",
"apmOss.tutorial.railsClient.configure.title": "配置代理",
"apmOss.tutorial.railsClient.install.textPre": "将代理添加您的 Gemfile。",
"apmOss.tutorial.railsClient.install.title": "安装 APM 代理",
"apmOss.tutorial.specProvider.artifacts.dashboards.linkLabel": "APM 仪表板",
"apmOss.tutorial.specProvider.longDescription": "应用程序性能监测 (APM) 从您的应用程序内收集深入全面的性能指标和错误。其允许您实时监测数以千计的应用程序的性能。[了解详情]({learnMoreLink})。",
"apmOss.tutorial.specProvider.name": "APM",
"apmOss.tutorial.specProvider.savedObjectsInstallMsg": "APM UI 中的某些功能需要 APM 索引模式。",
"apmOss.tutorial.startServer.textPre": "服务器在 Elasticsearch 中处理并存储应用程序性能指标。",
"apmOss.tutorial.startServer.title": "启动 APM Server",
"apmOss.tutorial.windowsServerInstructions.textPost": "注意：如果您的系统禁用了脚本执行，则需要为当前会话设置执行策略，以允许脚本运行。示例：{command}。",
"apmOss.tutorial.windowsServerInstructions.textPre": "1.从[下载页面]({downloadPageLink})下载 APM Server Windows zip 文件。\n2.将 zip 文件的内容解压缩到 {zipFileExtractFolder}。\n3.将 {apmServerDirectory} 目录重命名为 `APM-Server`。\n4.以管理员身份打开 PowerShell 提示符 (右键单击 PowerShell 图标，然后选择**以管理员身份运行**) 。如果运行的是 Windows XP，则可能需要下载并安装 PowerShell。\n5.从 PowerShell 提示符处，运行以下命令以将 APM Server 安装为 Windows 服务：",
"charts.advancedSettings.visualization.colorMappingText": "使用<strong>兼容性</strong>调色板将值映射到图表中的特定颜色。",
"charts.advancedSettings.visualization.colorMappingTextDeprecation": "此设置已过时，自 8.0 中起不再受支持。",
"charts.advancedSettings.visualization.colorMappingTitle": "颜色映射",