Quick start tutorial for Splunk Infrastructure Monitoring 🔗
This quick start tutorial walks you through the following steps to start monitoring your platform and cloud infrastructure using Splunk Infrastructure Monitoring and related features.
Step 1: Start getting platform infrastructure data into Splunk Observability Cloud by installing the Splunk Distribution of OpenTelemetry Collector on a Windows Server or Linux host or in a Kubernetes cluster. (5 minutes)
Step 2: Start getting cloud provider data into Splunk Observability Cloud by connecting to a cloud provider, such as Amazon Web Services, Google Cloud Platform, or Microsoft Azure. (15 minutes)
Step 3: Monitor your platform and cloud infrastructure using out-of-the-box navigators. (10 minutes)
For example, you can access this Hosts navigator to monitor all hosts where you’ve installed the Splunk Distribution of OpenTelemetry Collector, including Windows Server and Linux hosts.
You can also access navigators that enable you to monitor your cloud provider services, like this one for Amazon Web Services Elastic Block Storage (EBS):
Step 4: Activate an out-of-the-box detector to issue alerts that help you stay informed about the condition of your infrastructure. (2 minutes)
Step 1. Get platform infrastructure data into Splunk Observability Cloud 🔗
This task describes how to install the Splunk Distribution of OpenTelemetry Collector on Windows Server or Linux or in a Kubernetes cluster to start getting platform infrastructure data into Splunk Observability Cloud.
After this data starts flowing into Splunk Observability Cloud, you can:
Activate an out-of-the-box detector to issue alerts about specific conditions in your data
Prerequisites 🔗
You must be an administrator in Splunk Observability Cloud.
You must have an access token for the Splunk Observability Cloud organization you want to get data into. If you are using a free trial account, an access token named Default has already been created for you and you can use it to complete this task. For more details about creating organization access tokens, see Create and manage organization access tokens using Splunk Observability Cloud.
If you want to monitor Windows Server, you must be an administrator on the host and running one of the following versions:
Windows Server 2012 64-bit
Windows Server 2016 64-bit
Windows Server 2019 64-bit
If you want to monitor Linux, you must be an administrator on the host and running one of the following versions:
Amazon Linux 2
CentOS/Red Hat/Oracle 7 or 8
Debian 8, 9, or 10
Ubuntu 16.04, 18.04, or 20.04
You must also have systemd and cURL installed.
If you want to monitor Kubernetes, you must be an administrator of the cluster and have the Helm 3.0 client installed and configured.
Note
To help ensure a seamless flow from this task to Step 3: Monitor your platform and cloud infrastructure, make sure that your infrastructure host or cluster is generating data that can be received by Splunk Observability Cloud. For example, even if a guided setup you use in this task provides a confirmation of a valid connection, the navigators won’t display unless your infrastructure is actively sending data to Splunk Infrastructure Monitoring.
To get platform infrastructure data into Splunk Observability Cloud: 🔗
Log in to Splunk Observability Cloud.
In the left navigation menu, select
to open the Integrate Your Data page.Select the tile for the platform you want to get data in from:
Kubernetes
Linux
Windows
The access screen for your selected guided setup displays. For example, here is the access screen for the Linux guided setup. Select Add Connection.
The Configure Integration screen displays. Enter the values applicable to your platform:
Field
Platform
Description
Access Token
Kubernetes
Linux
Windows Server
Select the access token you want to use to authenticate the connection between Splunk Observability Cloud and your infrastructure platform.
If you are using a free trial account, an access token named Default has already been created for you and you can use it to complete this task.
For information about creating access tokens, see Create and manage organization access tokens using Splunk Observability Cloud.
Mode
Linux
Windows Server
Select the mode you want to run the Splunk Distribution of OpenTelemetry Collector in.
Select Agent if you want to run the Splunk Distribution of OpenTelemetry Collector with the application or on the same host as the application you want to instrument and monitor. This is the most common scenario.
Select Gateway if you want to run the Splunk Distribution of OpenTelemetry Collector as a standalone service in a container or as a separate deployment. Typically, gateway mode is deployed per cluster, data center, or region.
For more details, see Collector deployment modes.
Log Collection
Kubernetes
Linux
Windows Server
This field applies only if you have purchased Splunk Log Observer and are running the Splunk Distribution of OpenTelemetry Collector in agent mode.
By default, Splunk Observability Cloud free trials do not include Splunk Log Observer. If you want to try out Splunk Log Observer, you can register for a free trial.
Select Yes to enable the Splunk Distribution of OpenTelemetry Collector to collect logs from your infrastructure platform and send them to Splunk Log Observer.
Select No if you don’t want to collect logs.
Cluster Name
Kubernetes
Enter a name that enables you to uniquely identify your Kubernetes cluster in Splunk Observability Cloud. This name should correspond to the cluster where you are installing the Splunk Distribution of OpenTelemetry Collector.
For example, in the Kubernetes navigator, you can set the Cluster drop-down value to your cluster name to make the navigator display information about your cluster only.
Provider
Kubernetes
Select the location of the Kubernetes cluster where you are installing the Splunk Distribution of OpenTelemetry Collector:
Amazon Web Services
Microsoft Azure
Google Cloud Platform
Other
Distribution
Kubernetes
Select the Kubernetes distribution you are installing the Splunk Distribution of OpenTelemetry Collector in:
Amazon EKS (Elastic Kubernetes Service)
Azure AKS (Azure Kubernetes Service)
Google GKE (Google Kubernetes Engine)
Other
Add Gateway
Kubernetes
When you install the Splunk Distribution of OpenTelemetry Collector for Kubernetes, it will automatically and always run in agent mode.
Select Yes to deploy a gateway service, in addition to running the Splunk Distribution of OpenTelemetry Collector in agent mode. With this configuration, collectors running in agent mode can send data to the gateway and the gateway sends data to Splunk Observability Cloud. For more information on when to use gateway mode, see Gateway mode. Agents installed with this gateway (using the same Helm chart) are automatically configured to send data to this gateway.
If you have any other Splunk Distribution of OpenTelemetry Collectors running in agent mode in other clusters, you can manually configure them to point to this gateway.
Select No if you don’t want to deploy a gateway service. For example, if you have an existing gateway running in your Kubernetes implementation, you don’t need to deploy another. This option installs the Splunk Distribution of OpenTelemetry Collector running in agent mode. If you have an existing gateway running, you can manually configure the Splunk Distribution of OpenTelemetry Collector installed by this task to point to that gateway.
For more installation details, see Install the Collector for Kubernetes.
Select Next. The Install Integration screen displays.
Based on your entries on the Configure Integration screen, the guided setup provides commands that you can copy and paste to install the Splunk Distribution of OpenTelemetry Collector on your selected platform.
For example, here is what a successful installation looks like for Windows Server in Windows Powershell:
For Windows Server and Linux, once your installation of the Splunk Distribution of OpenTelemetry Collector is complete, select Done. The Infrastructure page displays, where you can monitor Windows Server and Linux host data using the Hosts navigator.
For Kubernetes, select Next. The Review Inventory screen displays. On the Log Events tab, select Explore Log Events to view more details using Splunk Log Observer. This option applies only if you have access to Splunk Log Observer and set Log Collection to Yes earlier in this task. On the Metric Data tab, select Explore Metric Data to access the Kubernetes navigator, where you can monitor Kubernetes cluster data.
Step 2. Get cloud infrastructure data into Splunk Observability Cloud 🔗
This task describes how to connect to a cloud provider, such as Amazon Web Services, Google Cloud Platform, or Microsoft Azure, to start getting data about your cloud infrastructure into Splunk Observability Cloud.
After this data starts flowing into Splunk Observability Cloud, you can:
Prerequisites 🔗
You must be an administrator in Splunk Observability Cloud and in your cloud environment.
If you are connecting to Amazon Web Services, you must have an access token for the Splunk Observability Cloud organization you want to get data into. If you are using a free trial account, an access token named Default has already been created for you and you can use it to complete this task. For more details about creating organization access tokens, see Create and manage organization access tokens using Splunk Observability Cloud.
Note
To help ensure a seamless flow from this task to Step 3: Monitor your platform and cloud infrastructure, make sure that your cloud provider service is generating data that can be received by Splunk Observability Cloud. For example, even if a guided setup you use in this task provides a confirmation of a valid connection, the navigators won’t display unless your cloud provider service is actively sending data to Splunk Infrastructure Monitoring.
To get cloud infrastructure data into Splunk Observability Cloud: 🔗
Log in to Splunk Observability Cloud.
In the left navigation menu, select
to open the Integrate Your Data page.In the integration filter menu, select By Use Case.
Select the Monitor infrastructure use case.
In the Cloud Integrations section, select the cloud provider you want to connect to Splunk Observability Cloud:
Amazon Web Services
Google Cloud Platform
Microsoft Azure
The guided setup for your selected platform displays.
For Amazon Web Services, select Add Connection. For Google Cloud Platform and Microsoft Azure, select Add Integration. Follow the instructions in the guided setup for your selected platform to complete the connection.
For details about connecting Amazon Web Services, see Connect to AWS and send data to Splunk Observability Cloud.
For details about connecting Google Cloud Platform, see Connect to Google Cloud Platform.
For details about connecting Microsoft Azure, see Connect to Azure and send data to Splunk Observability Cloud.
After you successfully connect to your cloud provider, one of the following provider-specific screens displays.
After you successfully connect with Amazon Web Services, the Review Inventory screen displays.
If you have access to Splunk Log Observer and selected Cloudwatch Logs on the Add Filters screen, the Log Events tab displays as follows. Select Explore Log Events to view more details using Splunk Log Observer.
Select the Metric Data tab to see an overview of your Amazon Web Services infrastructure metrics. Select Explore Metric Data to view more details using Splunk Infrastructure Monitoring navigators.
After you successfully connect with Google Cloud Platform, the GOOGLE CLOUD PLATFORM page displays a Validated! message for your connection.
In Step 3: Monitor your platform and cloud infrastructure, we cover how to use Splunk Infrastructure Monitoring navigators to monitor your Google Cloud Platform services.
After you successfully connect with Microsoft Azure, the MICROSOFT AZURE page displays a Validated! message for your connection.
In Step 3: Monitor your platform and cloud infrastructure, we cover how to use Splunk Infrastructure Monitoring navigators to monitor your Microsoft Azure services.
Step 3: Monitor your platform and cloud infrastructure 🔗
Now that you have data about your infrastructure, such as platform hosts, Kubernetes clusters, and cloud provider services, flowing into Splunk Observability Cloud, you can use out-of-the-box navigators to explore your data.
Prerequisites 🔗
Navigators display only if Splunk Infrastructure Monitoring is receiving data from your source.
For example, even if a guided setup you used in Step 1. Get platform infrastructure data into Splunk Observability Cloud or Step 2. Get cloud infrastructure data into Splunk Observability Cloud provided confirmation of a valid connection, the navigators don’t display unless your host, Kubernetes cluster, or cloud provider service is actively sending data to Splunk Infrastructure Monitoring.
If you don’t see a navigator after 15 minutes of making a valid connection, check your source to ensure that it is generating data. For example, ensure that your host, cluster, or service is being used in a way that generates data that it can send to Splunk Infrastructure Monitoring.
Step 4. Activate an out-of-the-box detector to issue alerts 🔗
Now that you have data flowing into Splunk Observability Cloud and you can explore that data using navigators and dashboards, let’s set up an alert that can help keep you informed about certain conditions in your data.
To create an alert, you first create a detector that monitors data for conditions you want to be alerted about. When a condition you want to be alerted about is met, the detector issues an alert.
This task describes how to create a detector directly from a chart in a navigator or dashboard covered in Step 3: Monitor your platform and cloud infrastructure.
Access the chart you want to create a detector from. This example creates a detector based on the Memory Used % chart in the Monitor Windows Server and Linux hosts using the Hosts navigator.
Select the Get Alerts icon in the upper right of a chart. For some chart data, there are built-in templates that make it easy for you create detectors for useful alert conditions. For example, for the Memory Used % chart, we provide a Memory utilization % greater than historical norm detector template.
The New Detector panel displays. Select Add Recipients to add an email, Splunk Observability Cloud team, or webhook that you want to receive the alert.
Select Activate. When the data condition is met, Splunk Observability Cloud sends a notification to designated recipients and displays alerts on the Alerts page.
For more details about using alerts and detectors, see Introduction to alerts and detectors in Splunk Observability Cloud.
Next steps 🔗
Now that you’ve seen some out-of-the-box visualizations, want to create your own dashboards and share them with your team? See Create and customize dashboards and Best practices for creating dashboards in Splunk Observability Cloud.
Use Related Content to jump between components of Splunk Observability Cloud by selecting related data.
Now that you have infrastructure data flowing into Splunk Observability Cloud, consider instrumenting an application to send spans and traces to Splunk Application Performance Monitoring (APM), where you can access dashboards like this one for your services and business workflows.
We provide tools that help you instrument applications written in Java, .NET, Node.js, Python, Ruby, and PHP.
Explore even more data sources that you can monitor using Splunk Observability Cloud, such as Apache Zookeeper, Cassandra, Docker, Heroku, Jenkins, and Redis.
Interested in coordinating team efforts in Splunk Observability Cloud using team alerts and dashboards? See Create and manage teams in Splunk Observability Cloud.