Logstash TCP 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the logstash-tcp monitor for the Smart Agent Receiver.

Use this integration to monitor the health and performance of Logstash deployments through Logstash Monitoring APIs.

This receiver is available on Linux and Windows.

Benefits 🔗

After you configure the integration, you can access these features:

View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Observability Cloud.
View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Splunk Infrastructure Monitoring navigators.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Use the Metric Finder.

Installation 🔗

Follow these steps to deploy this integration:

Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
Configure the monitor, as described in the Configuration section.
Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

To use this Smart Agent monitor with the Collector, include the smartagent receiver and service pipeline in your configuration file. The Smart Agent receiver is fully supported only on x86_64/amd64 platforms.

Read more in Use Smart Agent monitors with the Collector.
Learn about config options in Collector default configuration.

See the examples below for more details.

receivers:
  smartagent/logstash-tcp:
    type: logstash-tcp
    ... # Additional config

To complete the integration, include the monitor in a metrics pipeline. To do this, add the monitor to the service > pipelines > metrics > receivers section of your configuration file.

service:
  pipelines:
    metrics:
      receivers: [smartagent/logstash-tcp]

Configuration settings 🔗

Option	Required	Type	Description
`host`	no	`string`	The host name of the Logstash monitoring API. The default value is `127.0.0.1`.
`port`	no	`integer`	The port number of Logstash monitoring API. The default value is `9600`.
`useHTTPS`	no	`bool`	If true, the agent connects to the host using HTTPS instead of HTTP. The default value is `false`.
`timeoutSeconds`	no	`integer`	The maximum amount of time to wait for API requests, in seconds. The default value is `5`.

Metrics 🔗

There are no metrics available for this integration.

Get help 🔗

If you are not able to see your data in Splunk Observability Cloud, try these tips:

Submit a case in the Splunk Support Portal
- Available to Splunk Observability Cloud customers
Call Splunk Customer Support
- Available to Splunk Observability Cloud customers
Ask a question and get answers through community support at Splunk Answers
- Available to Splunk Observability Cloud customers and free trial users
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide
- Available to Splunk Observability Cloud customers and free trial users
- To learn how to join, see Get Started with Splunk Community - Chat groups

To learn about even more support options, see Splunk Customer Success.

Related Topics