-
Notifications
You must be signed in to change notification settings - Fork 70
/
Copy pathcommand-line-options.html
919 lines (890 loc) · 36.4 KB
/
command-line-options.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>APM Server command reference | APM Server Reference [6.3] | Elastic</title>
<meta class="elastic" name="content" content="APM Server command reference | APM Server Reference [6.3]">
<link rel="home" href="index.html" title="APM Server Reference [6.3]"/>
<link rel="up" href="setting-up-and-running.html" title="Setting up and running APM Server"/>
<link rel="prev" href="keystore.html" title="Secrets keystore for secure settings"/>
<link rel="next" href="directory-layout.html" title="Directory layout"/>
<meta class="elastic" name="product_version" content="6.3"/>
<meta class="elastic" name="product_name" content="APM"/>
<meta class="elastic" name="website_area" content="documentation"/>
<meta name="DC.type" content="Learn/Docs/APM Server/Reference/6.3"/>
<meta name="DC.subject" content="APM"/>
<meta name="DC.identifier" content="6.3"/>
<meta name="robots" content="noindex,nofollow"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<script src="https://cdn.optimizely.com/js/18132920325.js"></script>
<link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
<link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
<link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
<link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
<link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
<link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
<link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
<link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
<link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
<link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
<link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
<link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
<link rel="manifest" href="/manifest.json">
<meta name="apple-mobile-web-app-title" content="Elastic">
<meta name="application-name" content="Elastic">
<meta name="msapplication-TileColor" content="#ffffff">
<meta name="msapplication-TileImage" content="/mstile-144x144.png">
<meta name="theme-color" content="#ffffff">
<meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd" />
<meta name="yandex-verification" content="d8a47e95d0972434" />
<meta name="localized" content="true" />
<meta name="st:robots" content="follow,index" />
<meta property="og:image" content="https://static-www.elastic.co/v3/assets/bltefdd0b53724fa2ce/blt280217a63b82a734/6202d3378b1f312528798412/elastic-logo.svg" />
<meta property="og:image:width" content="500" />
<meta property="og:image:height" content="172" />
<link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
<link rel="icon" href="/favicon.ico" type="image/x-icon">
<link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
<link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
<link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
<!-- Give IE8 a fighting chance -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="stylesheet" type="text/css" href="/guide/static/styles-v1.css" />
</head>
<!--© 2015-2025 Elasticsearch B.V. -->
<!-- All Elastic documentation is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. -->
<!-- http://creativecommons.org/licenses/by-nc-nd/4.0/ -->
<body>
<!-- Google Tag Manager -->
<script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
<!-- End Google Tag Manager -->
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-12395217-16');
</script>
<!-- Google Tag Manager for GA4 -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-KNJMG2M');</script>
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KNJMG2M" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager for GA4-->
<div id='elastic-nav' style="display:none;"></div>
<script src='https://www.elastic.co/elastic-nav.js'></script>
<div class="main-container">
<section id="content" >
<div class="content-wrapper">
<section id="guide" lang="en">
<div class="container-fluid">
<div class="row pb-3">
<div class="col-12 order-2 col-md-4 order-md-1 col-lg-3 h-almost-full-md sticky-top-md" id="left_col">
<!-- The TOC is appended here -->
</div>
<div class="col-12 order-1 col-md-8 order-md-2 col-lg-7 order-lg-2 guide-section" id="middle_col">
<!-- start body -->
<div class="page_header">
A newer version is available. For the latest information, see the
<a href="../current/index.html">current release documentation</a>.
</div>
<div class="navheader">
<span class="prev">
<a href="keystore.html">« Secrets keystore for secure settings</a>
</span>
<span class="next">
<a href="directory-layout.html">Directory layout »</a>
</span>
</div>
<div class="book" lang="en">
<div class="titlepage">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="/guide/">Elastic Docs</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link">
<div id="related-products" class="dropdown">
<div class="related-products-title">APM:</div>
<div class="dropdown-anchor" tabindex="0">Server Reference<span class="dropdown-icon"></span></div>
<div class="dropdown-content">
<ul>
<li class="dropdown-category">APM</li>
<ul>
<li><a href="/guide/en/observability/current/apm.html">Observability › APM</a></li>
</ul>
<li class="dropdown-category">APM agents</li>
<ul>
<li><a href="/guide/en/apm/agent/android/current/intro.html">Android Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/go/current/introduction.html">Go Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/swift/current/intro.html">iOS Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/java/current/intro.html">Java Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/dotnet/current/intro.html">.NET Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/nodejs/current/intro.html">Node.js Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/php/current/intro.html">PHP Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/python/current/getting-started.html">Python Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/ruby/current/introduction.html">Ruby Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/rum-js/current/intro.html">Real User Monitoring JavaScript Agent Reference</a></li>
</ul>
<li class="dropdown-category">APM extensions</li>
<ul>
<li><a href="/guide/en/apm/lambda/current/aws-lambda-arch.html">AWS Lambda extension</a></li>
<li><a href="/guide/en/apm/attacher/current/apm-attacher.html">Attacher</a></li>
</ul>
</ul>
</div>
</div>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="setting-up-and-running.html">Setting up and running APM Server</a></span>
</div>
<div>
<div><h1 class="title"><a id="id-1"></a>APM Server command reference</h1><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/command-reference.asciidoc">edit</a></div>
</div>
<!--EXTRA-->
</div>
<div id="content">
<div id="url-to-v3" class="version-warning">
<strong>IMPORTANT</strong>: This documentation is no longer updated. Refer to <a href="https://www.elastic.co/support/eol">Elastic's version policy</a> and the <a href="https://www.elastic.co/docs">latest documentation</a>.
</div>
<div class="section">
<div class="titlepage"><div><div>
<div class="position-relative"><h2 class="title"><a id="command-line-options"></a>APM Server command reference</h2><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/command-reference.asciidoc">edit</a></div>
</div></div></div>
<p>APM Server provides a command-line interface for starting APM Server and
performing common tasks, like testing configuration files and loading
dashboards. The command-line also supports <a class="xref" href="command-line-options.html#global-flags" title="Global flags">global flags</a>
for controlling global behaviors.</p>
<div class="tip admon">
<div class="icon"></div>
<div class="admon_content">
<p>Use <code class="literal">sudo</code> to run the following commands if:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
the config file is owned by <code class="literal">root</code>, or
</li>
<li class="listitem">
APM Server is configured to capture data that requires <code class="literal">root</code> access
</li>
</ul>
</div>
</div>
</div>
<div class="informaltable">
<table border="0" cellpadding="4px">
<colgroup>
<col/>
<col/>
</colgroup>
<tbody valign="top">
<tr>
<td valign="top">
<p>
<a class="xref" href="command-line-options.html#export-command" title="export command"><code class="literal">export</code></a>
</p>
</td>
<td valign="top">
<p>
Exports the configuration or index template to stdout.
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<a class="xref" href="command-line-options.html#help-command" title="help command"><code class="literal">help</code></a>
</p>
</td>
<td valign="top">
<p>
Shows help for any command.
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<a class="xref" href="command-line-options.html#keystore-command" title="keystore command"><code class="literal">keystore</code></a>
</p>
</td>
<td valign="top">
<p>
Manages the <a class="xref" href="keystore.html" title="Secrets keystore for secure settings">secrets keystore</a>.
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<a class="xref" href="command-line-options.html#run-command" title="run command"><code class="literal">run</code></a>
</p>
</td>
<td valign="top">
<p>
Runs APM Server. This command is used by default if you start APM Server without specifying a command.
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<a class="xref" href="command-line-options.html#setup-command" title="setup command"><code class="literal">setup</code></a>
</p>
</td>
<td valign="top">
<p>
Sets up the initial environment, including the index template, Kibana dashboards (when available).
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<a class="xref" href="command-line-options.html#test-command" title="test command"><code class="literal">test</code></a>
</p>
</td>
<td valign="top">
<p>
Tests the configuration.
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<a class="xref" href="command-line-options.html#version-command" title="version command"><code class="literal">version</code></a>
</p>
</td>
<td valign="top">
<p>
Shows information about the current version.
</p>
</td>
</tr>
</tbody>
</table>
</div>
<p>Also see <a class="xref" href="command-line-options.html#global-flags" title="Global flags">Global flags</a>.</p>
<div class="section">
<div class="titlepage"><div><div>
<div class="position-relative"><h3 class="title"><a id="export-command"></a><code class="literal">export</code> command</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/command-reference.asciidoc">edit</a></div>
</div></div></div>
<p>Exports the configuration or index template to stdout. You can use this
command to quickly view your configuration or the contents of the index
template.</p>
<p><span class="strong strong"><strong>SYNOPSIS</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server export SUBCOMMAND [FLAGS]</pre>
</div>
<p><span class="strong strong"><strong>SUBCOMMANDS</strong></span></p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">config</code></strong></span>
</span>
</dt>
<dd>
Exports the current configuration to stdout. If you use the <code class="literal">-c</code> flag, this
command exports the configuration that’s defined in the specified file.
</dd>
</dl>
</div>
<div class="variablelist">
<a id="template-subcommand"></a>
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">template</code></strong></span>
</span>
</dt>
<dd>
Exports the index template to stdout. You can specify the <code class="literal">--es.version</code> and
<code class="literal">--index</code> flags to further define what gets exported.
</dd>
</dl>
</div>
<p><span class="strong strong"><strong>FLAGS</strong></span></p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--es.version VERSION</code></strong></span>
</span>
</dt>
<dd>
When specified along with <a class="xref" href="command-line-options.html#template-subcommand"><code class="literal">template</code></a>, exports an index
template that is compatible with the specified version.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-h, --help</code></strong></span>
</span>
</dt>
<dd>
Shows help for the <code class="literal">export</code> command.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--index BASE_NAME</code></strong></span>
</span>
</dt>
<dd>
When specified along with <a class="xref" href="command-line-options.html#template-subcommand"><code class="literal">template</code></a>, sets the base name
to use for the index template. If this flag is not specified, the default base
name is <code class="literal">apm-server</code>.
</dd>
</dl>
</div>
<p>Also see <a class="xref" href="command-line-options.html#global-flags" title="Global flags">Global flags</a>.</p>
<p><span class="strong strong"><strong>EXAMPLES</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server export config
apm-server export template --es.version 6.3.2 --index myindexname</pre>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div>
<div class="position-relative"><h3 class="title"><a id="help-command"></a><code class="literal">help</code> command</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/command-reference.asciidoc">edit</a></div>
</div></div></div>
<p>Shows help for any command. If no command is specified, shows help for the
<code class="literal">run</code> command.</p>
<p><span class="strong strong"><strong>SYNOPSIS</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server help COMMAND_NAME [FLAGS]</pre>
</div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">COMMAND_NAME</code></strong></span>
</span>
</dt>
<dd>
Specifies the name of the command to show help for.
</dd>
</dl>
</div>
<p><span class="strong strong"><strong>FLAGS</strong></span></p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-h, --help</code></strong></span>
</span>
</dt>
<dd>
Shows help for the <code class="literal">help</code> command.
</dd>
</dl>
</div>
<p>Also see <a class="xref" href="command-line-options.html#global-flags" title="Global flags">Global flags</a>.</p>
<p><span class="strong strong"><strong>EXAMPLE</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server help export</pre>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div>
<div class="position-relative"><h3 class="title"><a id="keystore-command"></a><code class="literal">keystore</code> command</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/command-reference.asciidoc">edit</a></div>
</div></div></div>
<p>Manages the <a class="xref" href="keystore.html" title="Secrets keystore for secure settings">secrets keystore</a>.</p>
<p><span class="strong strong"><strong>SYNOPSIS</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server keystore SUBCOMMAND [FLAGS]</pre>
</div>
<p><span class="strong strong"><strong>SUBCOMMANDS</strong></span></p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">add KEY</code></strong></span>
</span>
</dt>
<dd>
Adds the specified key to the keystore. Use the <code class="literal">--force</code> flag to overwrite an
existing key. Use the <code class="literal">--stdin</code> flag to pass the value through <code class="literal">stdin</code>.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">create</code></strong></span>
</span>
</dt>
<dd>
Creates a keystore to hold secrets. Use the <code class="literal">--force</code> flag to overwrite the
existing keystore.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">list</code></strong></span>
</span>
</dt>
<dd>
Lists the keys in the keystore.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">remove KEY</code></strong></span>
</span>
</dt>
<dd>
Removes the specified key from the keystore.
</dd>
</dl>
</div>
<p><span class="strong strong"><strong>FLAGS</strong></span></p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--force</code></strong></span>
</span>
</dt>
<dd>
Valid with the <code class="literal">add</code> and <code class="literal">create</code> subcommands. When used with <code class="literal">add</code>, overwrites
the specified key. When used with <code class="literal">create</code>, overwrites the keystore.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--stdin</code></strong></span>
</span>
</dt>
<dd>
When used with <code class="literal">add</code>, uses the stdin as the source of the key’s value.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-h, --help</code></strong></span>
</span>
</dt>
<dd>
Shows help for the <code class="literal">keystore</code> command.
</dd>
</dl>
</div>
<p>Also see <a class="xref" href="command-line-options.html#global-flags" title="Global flags">Global flags</a>.</p>
<p><span class="strong strong"><strong>EXAMPLES</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server keystore create
apm-server keystore add ES_PWD
apm-server keystore remove ES_PWD
apm-server keystore list</pre>
</div>
<p>see <a class="xref" href="keystore.html" title="Secrets keystore for secure settings">Secrets keystore</a> for more examples.</p>
</div>
<div class="section">
<div class="titlepage"><div><div>
<div class="position-relative"><h3 class="title"><a id="run-command"></a><code class="literal">run</code> command</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/command-reference.asciidoc">edit</a></div>
</div></div></div>
<p>Runs APM Server. This command is used by default if you start APM Server without specifying a command.</p>
<p><span class="strong strong"><strong>SYNOPSIS</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server run [FLAGS]</pre>
</div>
<p>Or:</p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server [FLAGS]</pre>
</div>
<p><span class="strong strong"><strong>FLAGS</strong></span></p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-N, --N</code></strong></span>
</span>
</dt>
<dd>
Disables the publishing of events to the defined output. This option is useful
only for testing APM Server.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--cpuprofile FILE</code></strong></span>
</span>
</dt>
<dd>
Writes CPU profile data to the specified file. This option is useful for
troubleshooting APM Server.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-h, --help</code></strong></span>
</span>
</dt>
<dd>
Shows help for the <code class="literal">run</code> command.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--httpprof [HOST]:PORT</code></strong></span>
</span>
</dt>
<dd>
Starts an http server for profiling. This option is useful for troubleshooting
and profiling APM Server.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--memprofile FILE</code></strong></span>
</span>
</dt>
<dd>
Writes memory profile data to the specified output file. This option is useful
for troubleshooting APM Server.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--setup</code></strong></span>
</span>
</dt>
<dd>
Loads the sample Kibana dashboards. If you want to load the dashboards without
running APM Server, use the <a class="xref" href="command-line-options.html#setup-command" title="setup command"><code class="literal">setup</code></a> command instead.
</dd>
</dl>
</div>
<p>Also see <a class="xref" href="command-line-options.html#global-flags" title="Global flags">Global flags</a>.</p>
<p><span class="strong strong"><strong>EXAMPLE</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server run -e --setup</pre>
</div>
<p>Or:</p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server -e --setup</pre>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div>
<div class="position-relative"><h3 class="title"><a id="setup-command"></a><code class="literal">setup</code> command</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/command-reference.asciidoc">edit</a></div>
</div></div></div>
<p>Sets up the initial environment, including the index template, Kibana dashboards (when available).</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
The index template ensures that fields are mapped correctly in Elasticsearch.
</li>
<li class="listitem">
The Kibana dashboards make it easier for you to visualize APM Server data
in Kibana.
</li>
<li class="listitem">
The machine learning jobs contain the configuration information and metadata
necessary to analyze data for anomalies.
</li>
</ul>
</div>
<p>Use this command instead of <code class="literal">run --setup</code> when you want to set up the
environment without actually running APM Server and ingesting data.</p>
<p><span class="strong strong"><strong>SYNOPSIS</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server setup [FLAGS]</pre>
</div>
<p><span class="strong strong"><strong>FLAGS</strong></span></p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--dashboards</code></strong></span>
</span>
</dt>
<dd>
Sets up the Kibana dashboards only.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-h, --help</code></strong></span>
</span>
</dt>
<dd>
Shows help for the <code class="literal">setup</code> command.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--machine-learning</code></strong></span>
</span>
</dt>
<dd>
Sets up machine learning job configurations only.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--template</code></strong></span>
</span>
</dt>
<dd>
Sets up the index template only.
</dd>
</dl>
</div>
<p>Also see <a class="xref" href="command-line-options.html#global-flags" title="Global flags">Global flags</a>.</p>
<p><span class="strong strong"><strong>EXAMPLE</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server setup --dashboards</pre>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div>
<div class="position-relative"><h3 class="title"><a id="test-command"></a><code class="literal">test</code> command</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/command-reference.asciidoc">edit</a></div>
</div></div></div>
<p>Tests the configuration.</p>
<p><span class="strong strong"><strong>SYNOPSIS</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server test SUBCOMMAND [FLAGS]</pre>
</div>
<p><span class="strong strong"><strong>SUBCOMMANDS</strong></span></p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">config</code></strong></span>
</span>
</dt>
<dd>
Tests the configuration settings.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">output</code></strong></span>
</span>
</dt>
<dd>
Tests that APM Server can connect to the output by using the
current settings.
</dd>
</dl>
</div>
<p><span class="strong strong"><strong>FLAGS</strong></span></p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-h, --help</code></strong></span>
</span>
</dt>
<dd>
Shows help for the <code class="literal">test</code> command.
</dd>
</dl>
</div>
<p>Also see <a class="xref" href="command-line-options.html#global-flags" title="Global flags">Global flags</a>.</p>
<p><span class="strong strong"><strong>EXAMPLE</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server test config</pre>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div>
<div class="position-relative"><h3 class="title"><a id="version-command"></a><code class="literal">version</code> command</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/command-reference.asciidoc">edit</a></div>
</div></div></div>
<p>Shows information about the current version.</p>
<p><span class="strong strong"><strong>SYNOPSIS</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server version [FLAGS]</pre>
</div>
<p><span class="strong strong"><strong>FLAGS</strong></span></p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-h, --help</code></strong></span>
</span>
</dt>
<dd>
Shows help for the <code class="literal">version</code> command.
</dd>
</dl>
</div>
<p>Also see <a class="xref" href="command-line-options.html#global-flags" title="Global flags">Global flags</a>.</p>
<p><span class="strong strong"><strong>EXAMPLE</strong></span></p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server version</pre>
</div>
<div class="position-relative"><h3><a id="global-flags"></a>Global flags</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.3/docs/copied-from-beats/command-reference.asciidoc">edit</a></div>
<p>These global flags are available whenever you run APM Server.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-E, --E "SETTING_NAME=VALUE"</code></strong></span>
</span>
</dt>
<dd>
<p>
Overrides a specific configuration setting. You can specify multiple overrides.
For example:
</p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server -E "name=mybeat" -E "output.elasticsearch.hosts=['http://myhost:9200']"</pre>
</div>
<p>This setting is applied to the currently running APM Server process.
The APM Server configuration file is not changed.</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-c, --c FILE</code></strong></span>
</span>
</dt>
<dd>
Specifies the configuration file to use for APM Server. The file you specify
here is relative to <code class="literal">path.config</code>. If the <code class="literal">-c</code> flag is not specified, the
default config file, <code class="literal">apm-server.yml</code>, is used.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-d, --d SELECTORS</code></strong></span>
</span>
</dt>
<dd>
Enables debugging for the specified selectors. For the selectors, you can
specify a comma-separated
list of components, or you can use <code class="literal">-d "*"</code> to enable debugging for all
components. For example, <code class="literal">-d "publish"</code> displays all the "publish" related
messages.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-e, --e</code></strong></span>
</span>
</dt>
<dd>
Logs to stderr and disables syslog/file output.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--path.config</code></strong></span>
</span>
</dt>
<dd>
Sets the path for configuration files. See the <a class="xref" href="directory-layout.html" title="Directory layout">Directory layout</a> section for
details.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--path.data</code></strong></span>
</span>
</dt>
<dd>
Sets the path for data files. See the <a class="xref" href="directory-layout.html" title="Directory layout">Directory layout</a> section for details.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--path.home</code></strong></span>
</span>
</dt>
<dd>
Sets the path for miscellaneous files. See the <a class="xref" href="directory-layout.html" title="Directory layout">Directory layout</a> section for
details.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--path.logs</code></strong></span>
</span>
</dt>
<dd>
Sets the path for log files. See the <a class="xref" href="directory-layout.html" title="Directory layout">Directory layout</a> section for details.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">--strict.perms</code></strong></span>
</span>
</dt>
<dd>
Sets strict permission checking on configuration files. The default is
<code class="literal">-strict.perms=true</code>. See
<a href="http://www.elastic.co/guide/en/beats/libbeat/6.3/config-file-permissions.html" class="ulink" target="_top">Config file ownership and permissions</a> in
the <em>Beats Platform Reference</em> for more information.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">-v, --v</code></strong></span>
</span>
</dt>
<dd>
Logs INFO-level messages.
</dd>
</dl>
</div>
</div>
</div>
</div>
</div><div class="navfooter">
<span class="prev">
<a href="keystore.html">« Secrets keystore for secure settings</a>
</span>
<span class="next">
<a href="directory-layout.html">Directory layout »</a>
</span>
</div>
<!-- end body -->
</div>
<div class="col-12 order-3 col-lg-2 order-lg-3 h-almost-full-lg sticky-top-lg" id="right_col">
<div id="sticky_content">
<!-- The OTP is appended here -->
<div class="row">
<div class="col-0 col-md-4 col-lg-0" id="bottom_left_col"></div>
<div class="col-12 col-md-8 col-lg-12">
<div id="rtpcontainer">
<div class="mktg-promo" id="most-popular">
<p class="aside-heading">Most Popular</p>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/getting-started-elasticsearch?page=docs&placement=top-video">
<p class="mb-0">Get Started with Elasticsearch</p>
</a>
</div>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/getting-started-kibana?page=docs&placement=top-video">
<p class="mb-0">Intro to Kibana</p>
</a>
</div>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/introduction-elk-stack?page=docs&placement=top-video">
<p class="mb-0">ELK for Logs & Metrics</p>
</a>
</div>
</div>
</div>
<!-- Feedback widget -->
<div id="feedbackWidgetContainer"></div>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
</div>
<div id='elastic-footer'></div>
<script src='https://www.elastic.co/elastic-footer.js'></script>
<!-- Footer Section end-->
</section>
</div>
<!-- Feedback modal -->
<div id="feedbackModalContainer"></div>
<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs-v1.js"></script>
<script type="text/javascript">
window.initial_state = {}</script>
</body>
</html>