Configuration Filebeat integrate with opensearch dashboard

Versions (relevant - OpenSearch/Dashboard/Server OS/Browser):
Filebeat 7.10.0, Opensearch 2.13.0 Windows

Describe the issue:
my dashboard already running and my filebeat also successfully run but my filebeat are not collecting data from file path i insert and dashboard are not load the logs i want to monitor.

Configuration:

@jymbay Are you getting any errors in Filebeat or OpenSearch?
Please share your Filebeat config.

i run ./filebeat -c filebeat.yml -e in powershell and the error i got

2024-04-29T10:26:12.034+0800    INFO    [publisher_pipeline_output]     pipeline/output.go:145  Attempting to reconnect to backoff(elasticsearch(https://opensearch-node2:9200)) with 32 reconnect attempt(s)
2024-04-29T10:26:12.034+0800    INFO    [publisher]     pipeline/retry.go:213   retryer: send wait signal to consumer
2024-04-29T10:26:12.039+0800    INFO    [publisher]     pipeline/retry.go:217     done
2024-04-29T10:26:13.061+0800    WARN    [transport]     transport/tcp.go:52     DNS lookup failure "opensearch-node2": lookup opensearch-node2: no such host
2024-04-29T10:26:15.459+0800    INFO    [monitoring]    log/log.go:145  Non-zero metrics in the last 30s        {"monitoring": {"metrics": {"beat":{"cpu":{"system":{"ticks":2156,"time":{"ms":31}},"total":{"ticks":3359,"time":{"ms":31},"value":3359},"user":{"ticks":1203}},"handles":{"open":297},"info":{"ephemeral_id":"a7292415-21f4-4364-befe-35023731094f","uptime":{"ms":1320390}},"memstats":{"gc_next":48350256,"memory_alloc":27889448,"memory_total":174743872,"rss":4096},"runtime":{"goroutines":127}},"filebeat":{"harvester":{"open_files":13,"running":47}},"libbeat":{"config":{"module":{"running":0}},"pipeline":{"clients":1,"events":{"active":4117,"retry":100}}},"registrar":{"states":{"current":41}}}}}
2024-04-29T10:26:26.665+0800    ERROR   [publisher_pipeline_output]     pipeline/output.go:154  Failed to connect to backoff(elasticsearch(https://opensearch-node1:9200)): Get "https://opensearch-node1:9200": lookup opensearch-node1: no such host
2024-04-29T10:26:44.551+0800    ERROR   [publisher_pipeline_output]     pipeline/output.go:154  Failed to connect to backoff(elasticsearch(https://localhost:5601)): Get "https://localhost:5601": http: server gave HTTP response to HTTPS client

and here is my filebeat configuration

###################### Filebeat Configuration Example #########################

# This file is an example configuration file highlighting only the most common
# options. The filebeat.reference.yml file from the same directory contains all the
# supported options with more comments. You can use it as a reference.
#
# You can find the full configuration reference here:
# https://www.elastic.co/guide/en/beats/filebeat/index.html

# For more available modules and options, please see the filebeat.reference.yml sample
# configuration file.

# ============================== Filebeat inputs ===============================

filebeat.inputs:

# Each - is an input. Most options can be set at the input level, so
# you can use different inputs for various configurations.
# Below are the input specific configurations.

- type: log

  # Change to true to enable this input configuration.
  enabled: true 

  # Paths that should be crawled and fetched. Glob based paths.
  paths:
    - C:\Users\user\Downloads\whids-v1.7.0-release-bundle\whids-man\windows\data\logs\*
    #- c:\programdata\elasticsearch\logs\*

  #setup.ilm.enabled: false
  
  
  # Exclude lines. A list of regular expressions to match. It drops the lines that are
  # matching any regular expression from the list.
  #exclude_lines: ['^DBG']

  # Include lines. A list of regular expressions to match. It exports the lines that are
  # matching any regular expression from the list.
  #include_lines: ['^ERR', '^WARN']

  # Exclude files. A list of regular expressions to match. Filebeat drops the files that
  # are matching any regular expression from the list. By default, no files are dropped.
  #exclude_files: ['.gz$']

  # Optional additional fields. These fields can be freely picked
  # to add additional information to the crawled log files for filtering
  #fields:
  #  level: debug
  #  review: 1

  ### Multiline options

  # Multiline can be used for log messages spanning multiple lines. This is common
  # for Java Stack Traces or C-Line Continuation

  # The regexp Pattern that has to be matched. The example pattern matches all lines starting with [
  #multiline.pattern: ^\[

  # Defines if the pattern set under pattern should be negated or not. Default is false.
  #multiline.negate: false

  # Match can be set to "after" or "before". It is used to define if lines should be append to a pattern
  # that was (not) matched before or after or as long as a pattern is not matched based on negate.
  # Note: After is the equivalent to previous and before is the equivalent to to next in Logstash
  #multiline.match: after

# filestream is an experimental input. It is going to replace log input in the future.
- type: filestream

  # Change to true to enable this input configuration.
  enabled: false

  # Paths that should be crawled and fetched. Glob based paths.
  paths:
  #  - /var/log/*.log
    #- c:\programdata\elasticsearch\logs\*

  # Exclude lines. A list of regular expressions to match. It drops the lines that are
  # matching any regular expression from the list.
  #exclude_lines: ['^DBG']

  # Include lines. A list of regular expressions to match. It exports the lines that are
  # matching any regular expression from the list.
  #include_lines: ['^ERR', '^WARN']

  # Exclude files. A list of regular expressions to match. Filebeat drops the files that
  # are matching any regular expression from the list. By default, no files are dropped.
  #prospector.scanner.exclude_files: ['.gz$']

  # Optional additional fields. These fields can be freely picked
  # to add additional information to the crawled log files for filtering
  #fields:
  #  level: debug
  #  review: 1

      
# ============================== Filebeat modules ==============================

filebeat.config.modules:
  # Glob pattern for configuration loading
  path: ${path.config}/modules.d/*.yml

  # Set to true to enable config reloading
  reload.enabled: false

  # Period on which files under path should be checked for changes
  #reload.period: 10s

# ======================= Elasticsearch template setting =======================

setup.template.settings:
  index.number_of_shards: 1
  index.number_of_replicas: 1
  #index.codec: best_compression
  #_source.enabled: false


# ================================== General ===================================

# The name of the shipper that publishes the network data. It can be used to group
# all the transactions sent by a single shipper in the web interface.
#name:

# The tags of the shipper are included in their own field with each
# transaction published.
#tags: ["service-X", "web-tier"]

# Optional fields that you can specify to add additional information to the
# output.
#fields:
#  env: staging

# ================================= Dashboards =================================
# These settings control loading the sample dashboards to the Kibana index. Loading
# the dashboards is disabled by default and can be enabled either by setting the
# options here or by using the `setup` command.
setup.dashboards.enabled: false

# The URL from where to download the dashboards archive. By default this URL
# has a value which is computed based on the Beat name and version. For released
# versions, this URL points to the dashboard archive on the artifacts.elastic.co
# website.
#setup.dashboards.url:

# =================================== Kibana ===================================

# Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.
# This requires a Kibana endpoint configuration.
#setup.kibana:

  # Kibana Host
  # Scheme and port can be left out and will be set to the default (http and 5601)
  # In case you specify and additional path, the scheme is required: http://localhost:5601/path
  # IPv6 addresses should always be defined as: https://[2001:db8::1]:5601
  #host: "localhost:5601"

  # Kibana Space ID
  # ID of the Kibana Space into which the dashboards should be loaded. By default,
  # the Default Space will be used.
  #space.id:

# =============================== Elastic Cloud ================================

# These settings simplify using Filebeat with the Elastic Cloud (https://cloud.elastic.co/).

# The cloud.id setting overwrites the `output.elasticsearch.hosts` and
# `setup.kibana.host` options.
# You can find the `cloud.id` in the Elastic Cloud web UI.
#cloud.id:

# The cloud.auth setting overwrites the `output.elasticsearch.username` and
# `output.elasticsearch.password` settings. The format is `<user>:<pass>`.
#cloud.auth:

# ================================== Outputs ===================================

# Configure what output to use when sending the data collected by the beat.

# ---------------------------- Elasticsearch Output ----------------------------
output.elasticsearch:
  # Array of hosts to connect to.
  hosts: ["https://opensearch-node1:9200", "https://opensearch-node2:9200", "https://localhost:5601"]
  #["https://localhost:9200"]

  # Protocol - either `http` (default) or `https`.
  #protocol: "https"

  # Authentication credentials - either API key or username/password.
  #api_key: "id:api_key"
  username: "admin"
  password: "admin"

# ------------------------------ Logstash Output -------------------------------
#output.logstash:
  # The Logstash hosts
  #hosts: ["localhost:5044"]

  # Optional SSL. By default is off.
  # List of root certificates for HTTPS server verifications
  #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]

  # Certificate for SSL client authentication
  #ssl.certificate: "/etc/pki/client/cert.pem"

  # Client Certificate Key
  #ssl.key: "/etc/pki/client/cert.key"

# ================================= Processors =================================
processors:
  - add_host_metadata:
      when.not.contains.tags: forwarded
  - add_cloud_metadata: ~
  - add_docker_metadata: ~
  - add_kubernetes_metadata: ~

# ================================== Logging ===================================

# Sets log level. The default log level is info.
# Available log levels are: error, warning, info, debug
#logging.level: debug

# At debug level, you can selectively enable logging only for some components.
# To enable all selectors use ["*"]. Examples of other selectors are "beat",
# "publish", "service".
#logging.selectors: ["*"]

# ============================= X-Pack Monitoring ==============================
# Filebeat can export internal metrics to a central Elasticsearch monitoring
# cluster.  This requires xpack monitoring to be enabled in Elasticsearch.  The
# reporting is disabled by default.

# Set to true to enable the monitoring reporter.
#monitoring.enabled: false

# Sets the UUID of the Elasticsearch cluster under which monitoring data for this
# Filebeat instance will appear in the Stack Monitoring UI. If output.elasticsearch
# is enabled, the UUID is derived from the Elasticsearch cluster referenced by output.elasticsearch.
#monitoring.cluster_uuid:

# Uncomment to send the metrics to Elasticsearch. Most settings from the
# Elasticsearch output are accepted here as well.
# Note that the settings should point to your Elasticsearch *monitoring* cluster.
# Any setting that is not set is automatically inherited from the Elasticsearch
# output configuration, so if you have the Elasticsearch output configured such
# that it is pointing to your Elasticsearch monitoring cluster, you can simply
# uncomment the following line.
#monitoring.elasticsearch:

# ============================== Instrumentation ===============================

# Instrumentation support for the filebeat.
#instrumentation:
    # Set to true to enable instrumentation of filebeat.
    #enabled: false

    # Environment in which filebeat is running on (eg: staging, production, etc.)
    #environment: ""

    # APM Server hosts to report instrumentation results to.
    #hosts:
    #  - http://localhost:8200

    # API Key for the APM Server(s).
    # If api_key is set then secret_token will be ignored.
    #api_key:

    # Secret token for the APM Server(s).
    #secret_token:


# ================================= Migration ==================================

# This allows to enable 6.7 migration aliases
#migration.6_to_7.enabled: true

hopefully you can help me. i am so sorry because late reply :cry:

Hey @jymbay

I don’t think you can ingest logs like this directly but probably using OpenSearch project logstash will work.

FileBeat ---> Logstash ---> OpenSearch

EDIT: I tried to make Filebeat-7.10 work with OS/OSD 2.13 on Ubuntu and they are running good no issues but the index set doesn’t get created. I created a index template, no joy.

These are All the setting I tried in Filebeat.yml file.

filebeat.inputs:
- type: log
  enabled: false
  paths:
    - /var/log/*.log
- type: filestream
  enabled: false
  paths:
     - /var/log/*.log
filebeat.config.modules:
  path: ${path.config}/modules.d/*.yml
  reload.enabled: true 
setup.template.settings:
    index.number_of_shards: 1
setup.ilm.enabled: false  
setup.template.name: "filebeat"
setup.template.pattern: "filebeat-*"
setup.kibana:
output.elasticsearch:
  hosts: ["127.0.0.1:9200"]
  ssl.certificate_authorities:
    - /etc/filebeat/root-ca.pem
  ssl.certificate: "/etc/filebeat/node1.pem"
  ssl.key: "/etc/filebeat/node1-key.pem" 
  protocol: "https"
  username: "admin"
  password: "password123"
  timeout: 180
  bulk_max_size: 2  
processors:
  - add_host_metadata:
      when.not.contains.tags: forwarded
  - add_cloud_metadata: ~
  - add_docker_metadata: ~
  - add_kubernetes_metadata: ~
logging.level: debug
logging.to_files: true
logging.files:
path: /var/log
name: filebeat.log

So I’m not sure. Maybe @pablo has a better idea.

1 Like

According to the error, logstash can’t resolve the name of the opensearch node.
If you used docker-compose to deploy the OpenSearch Cluster, Filebeat must connect to the same docker network as the OpenSearch cluster to resolve the container name opensearch-node1.

Alternatively, you can point to the docker host and port 9200 instead i.e. localhost:9200.
Please also have a look at the Filebeat configuration provided by @Gsmitt.

Your Filebeat configuration is missing a few options for a secured connection to the OpenSearch node.

You can use either this approach where you provide Filebeat certificate:

or you can fully omit SSL verification.

output.elasticsearch:
  hosts: ["127.0.0.1:9200"]
  ssl.verification_mode: none
  protocol: "https"
  username: "admin"
  password: "password123"

Regarding the second error, OpenSearch Dashboards is running with HTTP on port 5601. Also, you can’t use OpenSearch Dashboards as the output in the elasticsearch output module.

2 Likes

if you dont mind, can you share the documentation for method you mentioned?
FileBeat —> Logstash —> OpenSearch

Hey,
I used this doc

1 Like