Metricbeat setup - Linux/MacOS
Before you begin, you’ll need: Metricbeat 7.1 or higher
Download the Logz.io public certificate to your Filebeat server
For HTTPS shipping, download the Logz.io public certificate to your certificate authority folder.
sudo curl https://raw.githubusercontent.com/logzio/public-certificates/master/AAACertificateServices.crt --create-dirs -o /etc/pki/tls/certs/COMODORSADomainValidationSecureServerCA.crt
Add Logz.io configuration
Replace the General configuration in metricbeat.yml
with Logz.io settings.
Replace <<METRICS-SHIPPING-TOKEN>>
with a token for the Metrics account you want to ship to.
Here’s how to look up your Metrics token.
# ===== General =====
fields:
logzio_codec: json
token: <<METRICS-SHIPPING-TOKEN>>
fields_under_root: true
Set Logz.io as the output
If Logz.io is not an output, add it now. Remove all other outputs.
Replace <<LISTENER-HOST>>
with your region’s listener host (for example, listener.logz.io
). For more information on finding your account’s region, see Account region.
# ===== Outputs =====
output.logstash:
hosts: ["<<LISTENER-HOST>>:5015"]
ssl.certificate_authorities: ['/etc/pki/tls/certs/COMODORSADomainValidationSecureServerCA.crt']
(If needed) Enable the system module
The system module is enabled by default. If you’ve disabled it for any reason, re-enable it now.
sudo metricbeat modules enable system
You can change the metrics collected by Metricbeat by modifying modules.d/system.yml
.
If you installed Metricbeat from a package manager, this directory is under /etc/metricbeat
.
Start Metricbeat
Start or restart Metricbeat for the changes to take effect.
Check Logz.io for your metrics
Give your metrics some time to get from your system to ours, and then open Logz.io.
Metricbeat setup - Windows
Before you begin, you’ll need: Metricbeat 7.1 or higher
For HTTPS shipping, download the Logz.io public certificate to your certificate authority folder.
Download the
Logz.io public certificate
to C:\ProgramData\metricbeat\COMODORSADomainValidationSecureServerCA.crt
on your machine.
Add Logz.io configuration
Replace the General configuration in metricbeat.yml
with Logz.io settings.
Replace <<METRICS-SHIPPING-TOKEN>>
with a token for the Metrics account you want to ship to.
Here’s how to look up your Metrics token.
# ===== General =====
fields:
logzio_codec: json
token: <<METRICS-SHIPPING-TOKEN>>
fields_under_root: true
Set Logz.io as the output
If Logz.io is not an output, add it now. Remove all other outputs.
Replace <<LISTENER-HOST>>
with your region’s listener host (for example, listener.logz.io
). For more information on finding your account’s region, see Account region.
# ===== Outputs =====
output.logstash:
hosts: ["<<LISTENER-HOST>>:5015"]
ssl.certificate_authorities: ['C:\ProgramData\metricbeat\COMODORSADomainValidationSecureServerCA.crt']
(If needed) Enable the system module
The system module is enabled by default. If you’ve disabled it for any reason, open powershell re-enable it now.
PS > .\metricbeat.exe modules enable system
You can change the metrics collected by Metricbeat by modifying modules.d\system.yml
in the metricbeat installation folder.
Start Metricbeat
Start or restart Metricbeat for the changes to take effect.
PS C:\Program Files\metricbeat> Start-Service metricbeat
Check Logz.io for your metrics
Give your metrics some time to get from your system to ours, and then open Logz.io.
Docker setup
To simplify shipping metrics from one or many sources, we created Docker Metrics Collector. Docker Metrics Collector is a container that runs Metricbeat with the modules you enable at runtime.
This Docker container monitors Linux system metrics only. For other OSes, we recommend running Metricbeat locally on the system itself.
Configuration
If you’re not already running Docker Metrics Collector, follow these steps.
Otherwise, stop the container, add
system
to the LOGZIO_MODULES
environment variable,
and restart.
You can find the run
command and all parameters
in this procedure.
Pull the Docker image
Download the Docker Metrics Collector image:
docker pull logzio/docker-collector-metrics
Run the container
You’ll set your configuration using environment variables
in the docker run
command.
Each parameter is formatted like this:
--env ENV_VARIABLE_NAME="value"
.
For a complete list of options, see the parameters below the code block.👇
docker run --name docker-collector-metrics \
--env LOGZIO_TOKEN="<<METRICS-SHIPPING-TOKEN>>" \
--env LOGZIO_MODULES="system" \
--volume="/var/run/docker.sock:/var/run/docker.sock:ro" \
--volume="/sys/fs/cgroup:/hostfs/sys/fs/cgroup:ro" \
--volume="/proc:/hostfs/proc:ro" \
--volume="/:/hostfs:ro" \
--net=host \
logzio/docker-collector-metrics
Parameters for all modules
Parameter | Description |
---|---|
LOGZIO_TOKEN (Required) | Replace <<METRICS-SHIPPING-TOKEN>> with a token for the Metrics account you want to ship to. Here’s how to look up your Metrics token. |
LOGZIO_MODULES (Required) | Comma-separated list of Metricbeat modules to be enabled on this container (formatted as "module1,module2,module3" ). To use a custom module configuration file, mount its folder to /logzio/modules . |
LOGZIO_REGION Blank (US East) | Two-letter region code, or blank for US East (Northern Virginia). This determines your listener URL (where you’re shipping the logs to) and API URL. You can find your region code in the Regions and URLs table. |
LOGZIO_TYPE docker-collector-metrics |
This field is needed only if you’re shipping metrics to Kibana and you want to override the default value. In Kibana, this is shown in the type field. Logz.io applies parsing based on type . |
LOGZIO_LOG_LEVEL "INFO" |
The log level the module startup scripts will generate. |
LOGZIO_EXTRA_DIMENSIONS | Semicolon-separated list of dimensions to be included with your metrics (formatted as dimensionName1=value1;dimensionName2=value2 ). To use an environment variable as a value, format as dimensionName=$ENV_VAR_NAME . Environment variables must be the only value in the field. If an environment variable can’t be resolved, the field is omitted. |
HOSTNAME `` | Insert your host name if you want it to appear in the metrics’ host.name . If null, host.name will show the container’s ID. |
Open your System Metrics dashboard in Logz.io
Give your metrics a few minutes to get from your system to ours, and then open Logz.io.
Your metrics should appear in the preconfigured dashboard in your Metrics account. To open it, search your Logz.io Metrics dashboards for System Metrics.