You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 2, 2025. It is now read-only.
:description: Learn how to install the Splunk Observability Cloud AWS integration and monitor you AWS services.
9
9
10
10
.. toctree::
11
11
:hidden:
@@ -14,20 +14,43 @@ Tutorial: Monitor your AWS environment in Splunk Observability Cloud
14
14
tutorial-aws-start
15
15
tutorial-aws-use
16
16
17
-
Install the AWS integration and connect your AWS services with Splunk Observability Cloud.
17
+
If you're using AWS cloud services for your infrastructure, you can integrate these services with Splunk Observability Cloud to monitor metrics and metadata such as tags, labels, and other properties.
18
18
19
19
.. raw:: html
20
20
21
-
<h3> What's in this tutorial </h3>
21
+
<h2> What's in this tutorial </h2>
22
22
23
-
This tutorial covers the following concepts:
23
+
After completing this tutorial, you can accomplish the following tasks:
24
+
25
+
* Poll AWS data using the Splunk Observability Cloud UI.
26
+
* Install the OpenTelemetry Collector.
27
+
* View metrics in Infrastructure Monitoring navigators.
28
+
* View AWS metrics in built-in dashboards.
29
+
* Search for AWS data.
30
+
* Manage your metrics with metrics pipeline management.
31
+
* Create detectors that issue alerts.
32
+
33
+
.. raw:: html
34
+
35
+
<h2> How to use this tutorial </h2>
36
+
37
+
Each part in this tutorial builds on the previous. Follow the tutorial parts in order.
24
38
25
39
1. Install the Splunk Observability Cloud AWS integration. See :ref:`tutorial-aws-start`.
26
40
2. Use Splunk Observability Cloud to monitor your AWS services. See :ref:`tutorial-aws-use`.
27
-
3. (Optional) Learn more about concepts from this tutorial and Splunk Observability Cloud. See :ref:`welcome`.
28
41
29
42
.. raw:: html
30
43
31
-
<h3> Next step </h3>
44
+
<h2> Prerequisites </h2>
45
+
46
+
* Administrator privileges in Splunk Observability Cloud and your AWS accounts.
47
+
* :ref:`AWS authentication rights <aws-authentication>`.
48
+
49
+
* You can authenticate either with an :ref:`External ID (recommended) <aws-authentication>` or using a :ref:`security token <aws-authentication-token>`.
50
+
* For more details about creating organization access tokens, see :ref:`admin-org-tokens`.
51
+
52
+
.. raw:: html
53
+
54
+
<h2> Get started </h2>
32
55
33
56
To get started with the tutorial, see :ref:`tutorial-aws-start`.
:description: Prerequisites for getting Kubernetes data into Splunk Observability Cloud.
9
-
10
-
If you're using AWS cloud services for your infrastructure, you can integrate these services with Splunk Observability Cloud to monitor metrics and metadata such as tags, labels and other properties.
To integrate your AWS services with Splunk Observability Cloud, you need:
16
-
17
-
* Administrator privileges in your Splunk Observability Cloud and your AWS accounts.
18
-
* :ref:`AWS authentication rights <aws-authentication>`.
19
-
20
-
* You can authenticate either with an :ref:`External ID (recommended) <aws-authentication>` or using a :ref:`security token <aws-authentication-token>`.
21
-
* For more details about creating organization access tokens, see :ref:`admin-org-tokens`.
7
+
Install the AWS integration and connect your AWS services with Splunk Observability Cloud. For an overview of the tutorial, see :ref:`about-aws-tutorial`.
By default, send Amazon Web Services data to Splunk Observability Cloud via:ref:`polling (default) <aws-connect-polling>`, which you can set up using Splunk's UI guided install. Optionally, you can also use the Splunk Observability Cloud API.
12
+
Send Amazon Web Services data to Splunk Observability Cloud using:ref:`polling (default) <aws-connect-polling>`, which you can set up using the Splunk Observability Cloud UI guided install. Optionally, you can use the Splunk Observability Cloud API.
27
13
28
-
Alternatively, you can opt for :ref:`data streaming (Splunk-managed) <aws-connect-ms>`, :ref:`data streaming (AWS-managed) <aws-console-ms>`, or to configure the connection using :ref:`Splunk Terraform <terraform-config>`. Learn more at :ref:`aws-compare-connect`.
14
+
Alternatively, you can opt for :ref:`data streaming (Splunk-managed) <aws-connect-ms>`, :ref:`data streaming (AWS-managed) <aws-console-ms>`, or to configure the connection using :ref:`Splunk Terraform <terraform-config>`.
To access the guided setup for the AWS integration:
34
20
35
21
#. Log in to Splunk Observability Cloud.
36
-
#. On the navigation menu, select :menuselection:`Data Management > Add Integration > Amazon Web Services`.
22
+
#. In the navigation menu, select :menuselection:`Data Management`, :menuselection:`Add Integration`, then :menuselection:`Amazon Web Services`. The following window displays:
Follow the steps to configure the different connection options such as:
28
+
Configure the following connection options:
43
29
44
-
* :guilabel:`Overall region`: The region AWS from which AWS manages your resources. See :ref:`aws-regions` for more information.
45
-
* :guilabel:`Authentication type`: How you will authenticate to connect with AWS. Learn more at :ref:`aws-authentication`.
30
+
* :guilabel:`Overall region`: The AWS region from which AWS manages your resources. For more information, see :ref:`aws-regions`.
31
+
* :guilabel:`Authentication type`: How you authenticate to connect with AWS. Learn more at :ref:`aws-authentication`.
46
32
* :guilabel:`Data types`: The types of data and metadata to ingest.
47
-
* In the CloudWatch Metrics option, select :guilabel:`Polling` as the ingestion method, and set up the polling rate at which you want Splunk Observability Cloud to poll CloudWatch for metric data.
33
+
* In the :guilabel:`CloudWatch Metrics` option, select :guilabel:`Polling` as the ingestion method, and set up the polling rate at which you want Splunk Observability Cloud to poll CloudWatch for metric data.
Check the :ref:`list of AWS integrations available in Splunk Observability Cloud <aws-integrations>` to monitor the specific services you're using.
45
+
To monitor the specific services you're using, check the :ref:`list of AWS integrations available in Splunk Observability Cloud <aws-integrations>`.
60
46
61
47
For the list of metrics provided by each service, see the :new-page:`AWS official documentation <https://docs.aws.amazon.com/index.html#general_resourcess>`.
62
48
63
49
Install the OpenTelemetry Collector to send server and cluster data (Optional)
Optionally, you can install the :ref:`Splunk Distribution of OpenTelemetry Collector <otel-intro>` on any hosts or clusters you're using as a part of your infrastructure to send metrics to Infrastructure Monitoring, traces to APM, or logs to the Splunk Platform.
67
53
68
54
One of the benefits of using the Splunk Distribution of OpenTelemetry Collector to send your data to Splunk Observability Cloud is that Related Content, a feature that activates users to seamlessly move between key views in Splunk Observability Cloud, is easier to implement. For more information, see :ref:`get-started-relatedcontent`.
After you've integrated with your AWS services, you can access your data, set up alerts, and enjoy other features of Splunk Observability Cloud.
7
+
Now that you've integrated with your AWS services, you can access your data using navigators and dashboards, search your AWS data, and set up detectors and alerts. For an overview of the tutorial, see :ref:`about-aws-tutorial`.
After you completed :ref:`tutorial-aws-start`, you can explore your Amazon Web Services data using navigators. Navigators are primarily composed of charts. Using charts, you can view details about your metrics and visualize metric time series.
24
+
Navigators are primarily composed of charts. Using charts, you can view details about your metrics and visualize metric time series.
25
25
26
26
Follow these steps:
27
27
28
28
#. Log in to Splunk Observability Cloud.
29
-
#. In the left navigation menu, select :menuselection:`Infrastructure`.
30
-
#. In the :strong:`Public Clouds` section, select :strong:`Amazon AWS`. The :strong:`Amazon AWS` section provides a high-level view of Amazon Web Services data received by Splunk Infrastructure Monitoring.
29
+
#. In the left-side navigation menu, select :menuselection:`Infrastructure`.
30
+
#. In the :guilabel:`Public Clouds` section, select :guilabel:`Amazon AWS`. The :guilabel:`Amazon AWS` section provides a high-level view of the Amazon Web Services data received by Splunk Infrastructure Monitoring.
:alt:This screenshot shows the Amazon AWS section of the Infrastructure page displaying a high-level view of data received by Splunk Infrastructure Monitoring.
35
35
36
36
#. Select a service to access its navigator. For example, you can access a navigator that provides data about your Amazon Elastic Compute Cloud (EC2) nodes.
:alt:This animated GIF shows the EC2 navigator in Splunk Infrastructure Monitoring displaying charts and visualizations of data collected from the EC2 service.
41
-
42
-
For more details about using navigators, see :new-page-ref:`use-navigators-imm`.
43
-
44
-
For more details about working with charts, see :new-page-ref:`data-visualization-charts`.
:alt:This animated GIF shows the EC2 navigator in Splunk Infrastructure Monitoring displaying charts and visualizations of data collected from the EC2 service.
You can search for specific metrics :ref:`using Metric Finder <metric-finder>`, and for metadata using the :ref:`metadata catalog <search-edit-metadata>`.
58
+
-------------------
65
59
66
-
Learn more at :ref:`data-tools-landing`.
60
+
You can search for specific metrics using :ref:`Metric Finder <metric-finder>` and for metadata using the :ref:`metadata catalog <search-edit-metadata>`.
67
61
68
62
.. _tutorial-aws-use-manage:
69
63
70
64
Manage your metrics with metrics pipeline management
Metrics pipeline management allows you to centrally manage metric cardinality, and control how you ingest and store your metrics, so you can lower costs and improve monitoring performance.
74
-
75
-
See more at :ref:`metrics-pipeline-intro`.
67
+
Use :ref:`metrics pipeline management <metrics-pipeline-intro>` to centrally manage metric cardinality and control how you ingest and store your metrics, so you can lower costs and improve monitoring performance.
With alerts you can keep informed about certain conditions in your data.
72
+
With alerts you can stay informed about certain conditions in your data.
81
73
82
-
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.
74
+
To create an alert, you first create a detector that monitors your data for the conditions you want to be alerted about. When such a condition is met, the detector issues an alert.
83
75
84
76
To set up an alert, follow these steps:
85
77
86
78
#. Access the chart you want to create a detector from.
87
79
88
-
#. Select the :strong:`Get Alerts` icon in the upper right of a chart.
80
+
#. Select the :guilabel:`Get Alerts` icon in the upper right of a chart.
:alt:This screenshot shows the New Detector from Chart menu displaying available built-in detctor templates, such as the Memory utilization % greater than historical norm template.
84
+
:alt:This screenshot shows the New Detector from Chart menu displaying available built-in detector templates, such as the Memory utilization % greater than historical norm template.
93
85
94
86
This detector sends an alert when memory usage for the last 10 minutes was significantly higher than normal, as compared to the last 24 hours.
95
87
96
-
#. The :strong:`New Detector` panel displays. Select :strong:`Add Recipients` to add where you want to receive the alert: an email, a :ref:`Splunk Observability Cloud team <admin-manage-teams>`, or a :ref:`webhook <webhook>`.
88
+
#. The :guilabel:`New Detector` panel displays. Select :guilabel:`Add Recipient` to add the location where you want to receive the alert such as an email, a :ref:`Splunk Observability Cloud team <admin-manage-teams>`, or a :ref:`webhook <webhook>`.
:alt:This screenshot shows the New Detector: Memory utilization % greater than historical norm detector template.
101
-
102
-
#. Select :strong:`Activate`. When the data condition is met, Splunk Observability Cloud sends a notification to designated recipients and displays alerts on the Alerts page.
91
+
:width:60%
92
+
:alt:This screenshot shows the New Detector: Memory utilization % greater than historical norm detector template.
103
93
104
-
For more details about using alerts and detectors, see :new-page-ref:`get-started-detectoralert`.
94
+
#. Select :strong:`Activate`. When the data condition is met, Splunk Observability Cloud sends a notification to the designated recipients and displays alerts on the Alerts page.
105
95
106
96
Next steps
107
-
==================
108
-
109
-
You've completed this tutorial!
110
-
111
-
You can now...
97
+
==========
112
98
113
-
- Create your own dashboards and share them with your team. See :ref:`dashboard-create-customize` and :ref:`dashboards-best-practices`.
99
+
This concludes the tutorial. You've connected your AWS services with Splunk Observability Cloud, viewed your data with navigators and dashboards, searched your AWS data, and created a detector.
114
100
115
-
- :ref:`Use Related Content <get-started-relatedcontent>` to jump between components of Splunk Observability Cloud by selecting related data.
101
+
Learn more
102
+
==========
116
103
117
-
- Explore :ref:`even more data sources <supported-data-sources>` that you can monitor using Splunk Observability Cloud, such as Apache Zookeeper, Cassandra, Docker, Heroku, Jenkins, and Redis.
104
+
* For more details about the concepts discussed in this part of the tutorial:
118
105
119
-
- To coordinate team efforts in Splunk Observability Cloud using team alerts and dashboards, see :ref:`admin-manage-teams`.
106
+
* :new-page-ref:`use-navigators-imm`.
107
+
* :new-page-ref:`data-visualization-charts`.
108
+
* :ref:`data-tools-landing`.
109
+
* :new-page-ref:`get-started-detectoralert`.
110
+
* For ideas about what to learn next:
120
111
112
+
* To learn how to create custom dashboards, see :ref:`dashboard-create-customize` and :ref:`dashboards-best-practices`.
113
+
* To learn how to jump between components of Splunk Observability Cloud by selecting related data, see :ref:`get-started-relatedcontent`.
114
+
* To learn about additional data sources that you can monitor using Splunk Observability Cloud, see :ref:`supported-data-sources`.
115
+
* To learn how to coordinate team efforts in Splunk Observability Cloud using team alerts and dashboards, see :ref:`admin-manage-teams`
116
+
* To learn more about the concepts used in this tutorial and Splunk Observability Cloud in general, see :ref:`welcome`.
0 commit comments