OpenSearch Metrics via Telegraf
Ship your OpenSearch Metrics via Telegraf to your Logit.io Stack
Configure Telegraf to ship OpenSearch metrics to your Logit.io stacks via Logstash.
Follow this step by step guide to get 'logs' from your system to Logit.io:
Step 1 - Install Telegraf
This integration allows you to configure a Telegraf agent to send your metrics, in multiple formats, to Logit.io.
Telegraf is a flexible server agent equipped with plug-in support, useful for sending metrics and events from data sources like web servers, APIs, application logs, and cloud services.
To ship your metrics to Logit.io, we will integrate the relevant input and outputs.http plug-in into your Telegraf configuration file.
Choose the install for your operating system below to get started:
Windows
wget https://dl.influxdata.com/telegraf/releases/telegraf-1.19.2_windows_amd64.zip
Download and extract to: C:\Program Files\Logitio\telegraf\
Configuration file: C:\Program Files\Logitio\telegraf\
MacOS
brew install telegraf
Configuration file x86_64 Intel: /usr/local/etc/telegraf.conf
Configuration file ARM (Apple Silicon): /opt/homebrew/etc/telegraf.conf
Ubuntu/Debian
wget -q https://repos.influxdata.com/influxdata-archive_compat.key
echo '393e8779c89ac8d958f81f942f9ad7fb82a25e133faddaf92e15b16e6ac9ce4c influxdata-archive_compat.key' | sha256sum -c && cat influxdata-archive_compat.key | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/influxdata-archive_compat.gpg > /dev/null
echo 'deb [signed-by=/etc/apt/trusted.gpg.d/influxdata-archive_compat.gpg] https://repos.influxdata.com/debian stable main' | sudo tee /etc/apt/sources.list.d/influxdata.list
sudo apt-get update
sudo apt-get install telegraf
Configuration file: /etc/telegraf/telegraf.conf
RedHat and CentOS
cat <<EOF | sudo tee /etc/yum.repos.d/influxdata.repo
[influxdata]
name = InfluxData Repository - Stable
baseurl = https://repos.influxdata.com/stable/\$basearch/main
enabled = 1
gpgcheck = 1
gpgkey = https://repos.influxdata.com/influxdata-archive_compat.key
EOF
sudo yum install telegraf
Configuration file: /etc/telegraf/telegraf.conf
SLES & openSUSE
zypper ar -f obs://devel:languages:go/ go
zypper in telegraf
Configuration file: /etc/telegraf/telegraf.conf
FreeBSD/PC-BSD
sudo pkg install telegraf
Configuration file: /etc/telegraf/telegraf.conf
Step 2 - Configure the Telegraf input plugin
The configuration file below is pre-configured to scrape the system metrics from your hosts, add the following code to the configuration file /etc/telegraf/telegraf.conf
from the previous step.
# Derive metrics from aggregating OpenSearch query results
[[inputs.opensearch_query]]
## OpenSearch cluster endpoint(s). Multiple urls can be specified as part
## of the same cluster. Only one succesful call will be made per interval.
urls = [ "https://node1.os.example.com:9200" ] # required.
## OpenSearch client timeout, defaults to "5s".
# timeout = "5s"
## HTTP basic authentication details
# username = "admin"
# password = "admin"
## Skip TLS validation. Useful for local testing and self-signed certs.
# insecure_skip_verify = false
[[inputs.opensearch_query.aggregation]]
## measurement name for the results of the aggregation query
measurement_name = "measurement"
## OpenSearch index or index pattern to search
index = "index-*"
## The date/time field in the OpenSearch index (mandatory).
date_field = "@timestamp"
## If the field used for the date/time field in OpenSearch is also using
## a custom date/time format it may be required to provide the format to
## correctly parse the field.
##
## If using one of the built in OpenSearch formats this is not required.
## https://opensearch.org/docs/2.4/opensearch/supported-field-types/date/#built-in-formats
# date_field_custom_format = ""
## Time window to query (eg. "1m" to query documents from last minute).
## Normally should be set to same as collection interval
query_period = "1m"
## Lucene query to filter results
# filter_query = "*"
## Fields to aggregate values (must be numeric fields)
# metric_fields = ["metric"]
## Aggregation function to use on the metric fields
## Must be set if 'metric_fields' is set
## Valid values are: avg, sum, min, max, sum
# metric_function = "avg"
## Fields to be used as tags. Must be text, non-analyzed fields. Metric
## aggregations are performed per tag
# tags = ["field.keyword", "field2.keyword"]
## Set to true to not ignore documents when the tag(s) above are missing
# include_missing_tag = false
## String value of the tag when the tag does not exist
## Required when include_missing_tag is true
# missing_tag_value = "null"
Step 3 - Configure the output plugin
Once you have generated the configuration file, you need to set up the output plug-in to allow Telegraf to transmit your data to Logit.io in Prometheus format. This can be accomplished by incorporating the following code into your configuration file:
[[outputs.http]]
url = "https://<your-metrics-username>:<your-metrics-password>@<your-metrics-stack-id>-vm.logit.io:0/api/v1/write"
data_format = "prometheusremotewrite"
[outputs.http.headers]
Content-Type = "application/x-protobuf"
Content-Encoding = "snappy"
Step 4 - Start Telegraf
Windows
telegraf.exe --service start
MacOS
telegraf --config telegraf.conf
Linux
sudo service telegraf start
for systemd installations
systemctl start telegraf
Step 5 - View your metrics
Data should now have been sent to your Stack.
If you don't see metrics take a look at How to diagnose no data in Stack below for how to diagnose common issues.
Step 6 - How to diagnose no data in Stack
If you don't see data appearing in your Stack after following the steps, visit the Help Centre guide for steps to diagnose no data appearing in your Stack or Chat to support now.
Step 7 - Telegraf OpenSearch metrics Overview
For efficient monitoring and analysis of OpenSearch metrics across distributed systems, it's paramount to employ a robust and effective metrics management solution. Telegraf, an open-source server agent designed for collecting and sending telemetry data, is perfectly suited for this role, capable of capturing OpenSearch metrics from numerous sources such as operational OpenSearch clusters, databases, and other relevant applications.
Telegraf offers a broad range of input plugins that allow users to gather metrics from a variety of sources like CPU usage, memory utilization, network traffic, among others - key for understanding OpenSearch performance. To store and sift through these harvested metrics, organizations can turn to Prometheus, an open-source monitoring and alerting toolkit celebrated for its flexible querying language and superior data visualization features.
In order to relay OpenSearch metrics from Telegraf to Prometheus, organizations need to configure Telegraf to output metrics in the Prometheus format, and then arrange for Prometheus to scrape these metrics from the Telegraf server. This involves setting up Telegraf to collect OpenSearch metrics, exporting them in the Prometheus format, adjusting Prometheus to fetch these metrics from the Telegraf server, and subsequently decoding the data using Prometheus's advanced querying and graphical visualization tools.
After the successful integration of metrics into Prometheus, further analysis and visualization can be undertaken using Grafana. A top-tier open-source software renowned for its monitoring and observability functions, Grafana is fully compatible with Prometheus. It enables users to construct dynamic, interactive dashboards for deep-diving into the metrics data, providing a holistic understanding of performance trends and potential challenges in the OpenSearch system.
If you need any further assistance with shipping your log data to Logit.io we're here to help you get started. Feel free to get in contact with our support team by sending us a message via live chat & we'll be happy to assist.