Skip to content

Ingest using Elastic Beats

Elasticbeats serves as a lightweight platform for data shippers that transfer information from the source to axiom and other tools based on the configuration. Before shipping data, beats collects metrics and logs from different sources, which later are deployed to your Axiom deployments.

There are different Elastic Beats you could use to ship logs and Axioms documentation provides a detailed step by step procedure on how to use each Beats.

Filebeat

Filebeat is a lightweight shipper for logs, it helps you centralize logs, files and can read files from your system.

Filebeats is useful for workloads, system, application log files, and data logs you would like to ingest to Axiom in some way.

In the logging case, it helps centralize logs and files in a structured pattern by reading from your various applications, services, workloads and VMs, then shipping to your Axiom deployments.


Installation

Visit the Filebeat OSS download page to install Filebeat. For more information, check out Filebeat's official documentation

When downloading Filebeats, install the OSS version being that the non-oss version doesn't work with Axiom


Configuration

Axiom lets you ingest data with the ElasticSearch bulk ingest API.

In order for Filebeat to work, index lifecycle management (ILM) must be disabled. To do so, add setup.ilm.enabled: false to the filebeat.yml configuration file.

setup.ilm.enabled: false
filebeat.inputs:
  - type: log
    # Specify the path of the system log files to be sent to Axiom deployment. 
    paths: 
      - $PATH_TO_LOG_FILE
output.elasticsearch:
  # using the specified Axiom API
  hosts: ["$YOUR_AXIOM_URL:443/api/v1/datasets/<my-datasets>/elastic"]
  # api_key can be your ingest or personal token
  api_key: "user:token"

Metricbeat

Metricbeat is a lightweight shipper for metrics.

Metricbeat is installed on your systems and services and used for monitoring their performance, as well as different remote packages/utilities running on them.


Installation

Visit the MetricBeat OSS download page to install Metricbeat. For more information, check out Metricbeat's official documentation


Configuration

metricbeat.modules:
setup.ilm.enabled: false
metricbeat.config.modules:
  path:
    -$PATH_TO_LOG_FILE 
metricbeat.modules:
- module: system 
  metricsets: 
    - filesystem
    - cpu
    - load
    - fsstat
    - memory
    - network
output.elasticsearch:
  hosts: ["$YOUR_AXIOM_URL:443/api/v1/datasets/<dataset>/elastic"]
  # api_key can be your ingest or personal token
  api_key:  "user:token"

Winlogbeat

Winlogbeat is an open-source Windows specific event-log shipper that is installed as a Windows service. It can be used to collect and send event logs to Axiom.

Winlogbeat reads from one or more event logs using Windows APIs, filters the events based on user-configured criteria, then sends the event data to the configured outputs.

You can Capture:

  • application events
  • hardware events
  • security events
  • system events

Installation

Visit the Winlogbeat download page to install Winlogbeat. For more information, check out Winlogbeat's official documentation

  • Extract the contents of the zip file into C:\Program Files.
  • Rename the winlogbeat- directory to Winlogbeat
  • Open a PowerShell prompt as an Administrator and run
PS C:\Users\Administrator> cd C:\Program Files\Winlogbeat

PS C:\Program Files\Winlogbeat> .\install-service-winlogbeat.ps1

Configuration

Configuration for Winlogbeat Service is found in the winlogbeat.yml file in C:\Program Files\Winlogbeat.

Edit the winlogbeat.yml configuration file found in C:\Program Files\Winlogbeat this will let you send data to Axiom.

What is winlogbeat.yml File? The winlogbeat.yml file contains the configuration on which windows events and service it should monitor and the time required.


winlogbeat.event_logs:
  - name: Application
  - name: System
  - name: Security
logging.to_files: true
logging.files:
  path: C:\ProgramData\Winlogbeat\Logs
logging.level: info
output.elasticsearch:
  hosts: ["$YOUR_AXIOM_URL:443/api/v1/datasets/<dataset>/elastic"]
  # api_key can be your ingest or personal token
  api_key: "user:token"

Validate Configuration

# Check if your configuration is correct 

PS C:\Program Files\Winlogbeat> .\winlogbeat.exe test config -c .\winlogbeat.yml -e

Start Winlogbeat

PS C:\Program Files\Winlogbeat> Start-Service winlogbeat

You can view the status of your service and control it from the Services management console in Windows.

To launch the management console, run this command:

PS C:\Program Files\Winlogbeat> services.msc

Stop Winlogbeat

PS C:\Program Files\Winlogbeat> Stop-Service winlogbeat

For more information on Winlogbeat event logs visit the documentation

Heartbeat

Heartbeat is a lightweight shipper for uptime monitoring.

It Monitor your services, and ship response time to Axiom. It lets you check periodically check the status of your services and determine whether they are available.

Heartbeat is useful when you need to verify that you’re meeting your service level agreements for service uptime.

Heartbeat currently supports monitors for checking hosts via:

  • ICMP (v4 and v6) Echo Requests. Use the icmp monitor when you simply want to check whether a service is available. This monitor requires root access.
  • TCP Use the tcp monitor to connect via TCP. You can optionally configure this monitor to verify the endpoint by sending and/or receiving a custom payload.
  • HTTP. Use the http monitor to connect via HTTP. You can optionally configure this monitor to verify that the service returns the expected response, such as a specific status code, response header, or content.

Installation

Visit the Heartbeat download page to install Heartbeat on your system.


Configuration

Heartbeat provides monitors to check the status of hosts at set intervals. Heartbeat currently provides monitors for ICMP, TCP, and HTTP.

You configure each monitor individually. In heartbeat.yml, specify the list of monitors that you want to enable. Each item in the list begins with a dash (-).

The example below configures Heartbeat to use three monitors: an icmp monitor, a tcp monitor, and an http monitor. deployed instantly to Axiom.

# Disable index lifecycle management (ILM)
setup.ilm.enabled: false
heartbeat.monitors:
- type: icmp
  schedule: '*/5 * * * * * *' 
  hosts: ["myhost"]
  id: my-icmp-service
  name: My ICMP Service
- type: tcp
  schedule: '@every 5s' 
  hosts: ["myhost:12345"]
  mode: any 
  id: my-tcp-service
- type: http
  schedule: '@every 5s'
  urls: ["http://example.net"]
  service.name: apm-service-name 
  id: my-http-service
  name: My HTTP Service
output.elasticsearch:
  hosts: [""$YOUR_AXIOM_URL:443/api/v1/datasets/<dataset>/elastic"]
  # api_key can be your ingest or personal token
  api_key: "user:token"

Auditbeat

Auditbeat is a lightweight shipper that ships events in real time to Axiom for further analysis. It Collects your Linux audit framework data and monitor the integrity of your files. It is also used to evaluate the activities of users and processes on your system.

You can also use Auditbeat to detect changes to critical files, like binaries and configuration files, and identify potential security policy violations.


Installation

Visit the Auditbeat download page to install Auditbeat on your system.


Configuration

Auditbeat uses modules to collect audit information:

  • Auditd
  • File integrity
  • System

By default, Auditbeat uses a configuration that’s tailored to the operating system where Auditbeat is running.

To use a different configuration, change the module settings in auditbeat.yml.

The example below configures Auditbeat to use the file_integrity module configured to generate events whenever a file in one of the specified paths changes on disk. The events contains the file metadata and hashes, and it's deployed instantly to Axiom.

# Disable index lifecycle management (ILM)
setup.ilm.enabled: false
auditbeat.modules:
- module: file_integrity
  paths:
  - /usr/bin
  - /sbin
  - /usr/sbin
  - /etc
  - /bin
  - /usr/local/sbin
output.elasticsearch:
  hosts: ["$YOUR_AXIOM_URL:443/api/v1/datasets/<dataset>/elastic"]
  # api_key can be your ingest or personal token
  api_key: "user:token"

Packetbeat

Packetbeat is a real-time network packet analyzer that you can integrate with Axiom to provide an application monitoring and performance analytics system between the servers of your network.

With Axiom you can use Packetbeat to capture the network traffic between your application servers, decode the application layer protocols (HTTP, MySQL, Redis, pgsql, thrift, mongodb and so on), and correlate the requests with the responses.

Packetbeat sniffs the traffic between your servers, and parses the application-level protocols on the fly directly into Axiom.

Currently, Packetbeat supports the following protocols:

  • ICMP (v4 and v6)
  • DHCP (v4)
  • DNS
  • HTTP
  • AMQP 0.9.1
  • Cassandra
  • Mysql
  • PostgreSQL
  • Redis
  • Thrift-RPC
  • MongoDB
  • Memcache
  • NFS
  • TLS
  • SIP/SDP (beta)

Installation

Visit the Packetbeat download page to install Packetbeat on your system.


Configuration

In packetbeat.yml, configure the network devices and protocols to capture traffic from.

To see a list of available devices for packetbeat.yml configuration , run:

OS type Command
DEB Run packetbeat devices
RPM Run packetbeat devices
MacOS Run ./packetbeat devices
Brew Run packetbeat devices
Linux Run ./packetbeat devices
Windows Run PS C:\Program Files\Packetbeat> .\packetbeat.exe devices

Packetbeat supports these sniffer types:

  • pcap

  • af_packet

In the protocols section, configure the ports where Packetbeat can find each protocol. If you use any non-standard ports, add them here. Otherwise, use the default values:


# Disable index lifecycle management (ILM)
setup.ilm.enabled: false
# network device to capture traffic from
packetbeat.interfaces.device: en0
# Configure the maximum size of the packets to capture
packetbeat.interfaces.snaplen: 44937833987
# Configure Sniffing & traffic capturing options
packetbeat.interfaces.type: pcap
# Configure the maximum size of the shared memory buffer to use
packetbeat.interfaces.buffer_size_mb: 400
packetbeat.interfaces.auto_promisc_mode: true
packetbeat.flows:
  timeout: 30s
  period: 10s
protocols:
  dns:
    ports: [53]
    include_authorities: true
    include_additionals: true
  http:
    ports: [80, 8080, 8081, 5000, 8002]
  memcache:
    ports: [11211]
  mysql:
    ports: [3306]
  pgsql:
    ports: [5432]
  redis:
    ports: [6379]
  thrift:
    ports: [9090]
  mongodb:
    ports: [27017]
output.elasticsearch:
  hosts: [""$YOUR_AXIOM_URL:443/api/v1/datasets/<dataset>/elastic"]
  # api_key can be your ingest or personal token
  api_key: "user:token" 

For more information on configuring Packetbeats, visit the documentation