Metricbeat quick start: installation and configuration
https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-installation-configuration.html
Step 1: Install Metricbeatedit Step 1: Install Metricbeat
Install Metricbeat as close as possible to the service you want to monitor.
For example, if you have four servers with MySQL running, it’s recommended that
you run Metricbeat on each server. This allows Metricbeat to access your
service from localhost and does not cause any additional network traffic or
prevent Metricbeat from collecting metrics when there are network problems.
Metrics from multiple Metricbeat instances will be combined on the
Elasticsearch server.
To download and install Metricbeat, use the commands that work with your
system: DEB RPM MacOS Linux Windows curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-8.1.0-amd64.deb
sudo dpkg -i metricbeat-8.1.0-amd64.deb curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-8.1.0-x86_64.rpm
sudo rpm -vi metricbeat-8.1.0-x86_64.rpm curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-8.1.0-darwin-x86_64.tar.gz
tar xzvf metricbeat-8.1.0-darwin-x86_64.tar.gz curl -L -O https://artifacts.elastic.co/downloads/beats/metricbeat/metricbeat-8.1.0-linux-x86_64.tar.gz
tar xzvf metricbeat-8.1.0-linux-x86_64.tar.gz Download the Metricbeat Windows zip file from the
. Extract the contents of the zip file into C:\Program Files. Rename the metricbeat-<version>-windows directory to Metricbeat. Open a PowerShell prompt as an Administrator (right-click the PowerShell icon
and select Run As Administrator). From the PowerShell prompt, run the following commands to install
Metricbeat as a Windows service: PS > cd 'C:\Program Files\Metricbeat'
PS C:\Program Files\Metricbeat> .\install-service-metricbeat.ps1 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:
PowerShell.exe -ExecutionPolicy UnRestricted -File .\install-service-metricbeat.ps1. Other installation optionsStep 2: Connect to the Elastic Stackedit Step 2: Connect to the Elastic Stack
Connections to Elasticsearch and Kibana are required to set up Metricbeat.
Set the connection information in metricbeat.yml. To locate this
configuration file, see . Elasticsearch Service Self-managed Specify the of your Elasticsearch Service, and set to a user who is authorized to
set up Metricbeat. For example: cloud.id: "staging:dXMtZWFzdC0xLmF3cy5mb3VuZC5pbyRjZWM2ZjI2MWE3NGJmMjRjZTMzYmI4ODExYjg0Mjk0ZiRjNmMyY2E2ZDA0MjI0OWFmMGNjN2Q3YTllOTYyNTc0Mw=="
cloud.auth: "metricbeat_setup:YOUR_PASSWORD" This examples shows a hard-coded password, but you should store sensitive
values
in the . Set the host and port where Metricbeat can find the Elasticsearch installation, and
set the username and password of a user who is authorized to set up
Metricbeat. For example: output.elasticsearch: hosts: ["https://myEShost:9200"] username: "metricbeat_internal" password: "YOUR_PASSWORD" ssl: enabled: true ca_trusted_fingerprint: "b9a10bbe64ee9826abeda6546fc988c8bf798b41957c33d05db736716513dc9c" This example shows a hard-coded password, but you should store sensitive
values
in the . This example shows a hard-coded fingerprint, but you should store sensitive
values
in the .
The fingerprint is a HEX encoded SHA-256 of a CA certificate,
when you start Elasticsearch for the first time, security features such as
network encryption (TLS) for Elasticsearch are enabled by default. If you are
using the self-signed certificate generated by Elasticsearch when it is started
for the first time, you will need to add its fingerprint here. The
fingerprint is printed on Elasticsearch start up logs, or you can refer to for other options on retrieving it. If you are
providing your own SSL certificate to Elasticsearch refer to
. If you plan to use our pre-built Kibana dashboards, configure the Kibana
endpoint. Skip this step if Kibana is running on the same host as Elasticsearch. setup.kibana: host: "mykibanahost:5601" username: "my_kibana_user" password: "{pwd}" The hostname and port of the machine where Kibana is running,
for example, mykibanahost:5601. If you specify a path after the port number,
include the scheme and port: http://mykibanahost:5601/path. The username and password settings for Kibana are optional. If you don’t
specify credentials for Kibana, Metricbeat uses the username and password
specified for the Elasticsearch output. To use the pre-built Kibana dashboards, this user must be authorized to
view dashboards or have the
kibana_admin . To learn more about required roles and privileges, see
. You can send data to other ,
such as Logstash,
but that requires additional configuration and setup.Step 3: Enable and configure metrics collection modulesedit Step 3: Enable and configure metrics collection modules
Metricbeat uses modules to collect metrics. Each module defines the basic
logic for collecting data from a specific service, such as Redis or MySQL. A
module consists of metricsets that fetch and structure the data. Read to learn more. Identify the modules you need to enable. To see the list of available
, run: DEB RPM MacOS Linux Windows metricbeat modules list metricbeat modules list ./metricbeat modules list ./metricbeat modules list PS > .\metricbeat.exe modules list From the installation directory, enable one or more modules. If you accept the
default configuration without enabling additional modules, Metricbeat
collects system metrics only.
The following command enables the nginx config in the modules.d
directory: DEB RPM MacOS Linux Windows metricbeat modules enable nginx metricbeat modules enable nginx ./metricbeat modules enable nginx ./metricbeat modules enable nginx PS > .\metricbeat.exe modules enable nginx See the to learn more about this command. If you are using a
Docker image, see . In the module config under modules.d, change the module settings to match
your environment. See for more about available
settings. To test your configuration file, change to the directory where the
Metricbeat binary is installed, and run Metricbeat in the foreground with
the following options specified: ./metricbeat test config -e. Make sure your
config files are in the path expected by Metricbeat (see ),
or use the -c flag to specify the path to the config file. For more information about configuring Metricbeat, also see: : This reference configuration
file shows all non-deprecated options. You’ll find it in the same location as
metricbeat.yml.Step 4: Set up assetsedit Step 4: Set up assets
Metricbeat comes with predefined assets for parsing, indexing, and
visualizing your data. To load these assets: Make sure the user specified in metricbeat.yml is
. From the installation directory, run: DEB RPM MacOS Linux Windows metricbeat setup -e metricbeat setup -e ./metricbeat setup -e ./metricbeat setup -e PS > .\metricbeat.exe setup -e -e is optional and sends output to standard error instead of the configured log output. This step loads the recommended for writing to Elasticsearch
and deploys the sample dashboards for visualizing the data in Kibana. A connection to Elasticsearch (or Elasticsearch Service) is required to set up the initial
environment. If you’re using a different output, such as Logstash, see and .Step 5: Start Metricbeatedit Step 5: Start Metricbeat
Before starting Metricbeat, modify the user credentials in
metricbeat.yml and specify a user who is
.
To start Metricbeat, run: DEB RPM MacOS Linux Windows sudo service metricbeat start If you use an init.d script to start Metricbeat, you can’t specify command
line flags (see ). To specify flags, start Metricbeat in
the foreground. Also see . sudo service metricbeat start If you use an init.d script to start Metricbeat, you can’t specify command
line flags (see ). To specify flags, start Metricbeat in
the foreground. Also see . sudo chown root metricbeat.yml sudo chown root modules.d/nginx.yml sudo ./metricbeat -e You’ll be running Metricbeat as root, so you need to change ownership of the
configuration file and any configurations enabled in the modules.d directory,
or run Metricbeat with --strict.perms=false specified. See
. sudo chown root metricbeat.yml sudo chown root modules.d/nginx.yml sudo ./metricbeat -e You’ll be running Metricbeat as root, so you need to change ownership of the
configuration file and any configurations enabled in the modules.d directory,
or run Metricbeat with --strict.perms=false specified. See
. PS C:\Program Files\metricbeat> Start-Service metricbeat By default, Windows log files are stored in C:\ProgramData\metricbeat\Logs. On Windows, statistics about system load and swap usage are currently
not captured Metricbeat should begin streaming metrics to Elasticsearch.Step 6: View your data in Kibanaedit Step 6: View your data in Kibana
Metricbeat comes with pre-built Kibana dashboards and UIs for visualizing log
data. You loaded the dashboards earlier when you ran the setup command.
To open the dashboards: Launch Kibana: Elasticsearch Service Self-managed to your Elastic Cloud account. Navigate to the Kibana endpoint in your deployment. Point your browser to , replacing
localhost with the name of the Kibana host. In the side navigation, click Discover. To see Metricbeat data, make
sure the predefined metricbeat-* index pattern is selected. If you don’t see data in Kibana, try changing the time filter to a larger
range. By default, Kibana shows the last 15 minutes. In the side navigation, click Dashboard, then select the dashboard that you
want to open. The dashboards are provided as examples. We recommend that you them to meet your needs.
beat go
DA: 10 PA: 66 MOZ Rank: 88
