Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 690775f

Browse files
authored
Merge pull request #2440 from splunk/bhillmer-fix-spans-traces-headers
fix headers and large images
2 parents 55a016d + ca38350 commit 690775f

File tree

2 files changed

+50
-54
lines changed

2 files changed

+50
-54
lines changed

apm/apm-spans-traces/traces-spans.rst

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -39,19 +39,19 @@ Spans and traces form the backbone of application monitoring in Splunk APM. Use
3939

4040

4141
.. raw:: html
42+
43+
<embed>
44+
<h2>What are services?<a name="what-are-services" class="headerlink" href="#what-are-services" title="Permalink to this headline">¶</a></h2>
45+
</embed>
4246

43-
<embed>
44-
<h2>What are services?</h2>
45-
</embed>
4647

4748
Services are the key components of the systems you can monitor with Splunk APM.
4849

49-
5050
.. raw:: html
51-
52-
<embed>
53-
<h2>What are traces and spans?</h2>
54-
</embed>
51+
52+
<embed>
53+
<h2>What are traces and spans?<a name="what-are-traces-spans" class="headerlink" href="#what-are-traces-spans" title="Permalink to this headline">¶</a></h2>
54+
</embed>
5555

5656

5757
A trace is a collection of operations that represents a unique transaction handled by an application and its constituent services. A span represents a single operation within a trace.
@@ -66,13 +66,11 @@ The following image illustrates the relationship between traces and spans:
6666

6767
A span might refer to another span as its parent, indicating a relationship between operations involved in the trace. In the preceding image, span A is a parent span, and span B is a child span. This relationship might indicate that, for example, span A makes a service call that triggers the operation captured by span B. In this image, span C is also a child of span B, and so on.
6868

69-
7069
.. raw:: html
71-
72-
<embed>
73-
<h2>Span metadata</h2>
74-
</embed>
75-
70+
71+
<embed>
72+
<h2>Span metadata<a name="span-metadata" class="headerlink" href="#span-metadata" title="Permalink to this headline">¶</a></h2>
73+
</embed>
7674

7775
Each span contains metadata about the operation captured by the span and the service in which the operation took place.
7876

@@ -117,12 +115,11 @@ Each span contains the following basic metadata:
117115
- Delay between the start of the parent trace and the start of this particular span
118116

119117

120-
121118
.. raw:: html
122-
123-
<embed>
124-
<h2>Span tags</h2>
125-
</embed>
119+
120+
<embed>
121+
<h2>Span tags<a name="span-tags" class="headerlink" href="#span-tags" title="Permalink to this headline">¶</a></h2>
122+
</embed>
126123

127124

128125
Span tags are key-value pairs that provide additional information and context about the operations a span represents. Both the keys and values are strings, and span tag keys for a single span must be unique. You can use span tags to query and filter traces, or to get information about the spans of a trace during troubleshooting.
@@ -133,11 +130,12 @@ Span tags are most useful when they follow a simple, dependable system of naming
133130

134131
.. note:: Span tags in Splunk APM are distinct from metadata tags in Splunk Infrastructure Monitoring, which are searchable labels or keywords you can assign to metric dimensions in the form of strings rather than as key-value pairs. To learn more about metadata tags, see :ref:`metadata-infra-tags`.
135132

136-
.. raw:: html
137133

138-
<embed>
139-
<h2>Identities</h2>
140-
</embed>
134+
.. raw:: html
135+
136+
<embed>
137+
<h2>Identities<a name="identities" class="headerlink" href="#identities" title="Permalink to this headline">¶</a></h2>
138+
</embed>
141139

142140
An identity represents a unique set of indexed span tags for a Splunk APM object, and always includes at least one service.
143141

sp-oncall/notifications/notification-types.rst

Lines changed: 29 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ You can also configure delayed notifications for alerts that may auto-resolve wi
3030

3131

3232
.. raw:: html
33-
34-
<embed>
35-
<h2>Push notification</h2>
36-
</embed>
33+
34+
<embed>
35+
<h2>Push notification<a name="push-notification" class="headerlink" href="#push-notification" title="Permalink to this headline">¶</a></h2>
36+
</embed>
3737

3838

3939
Push notifications are sent through the application. We use push for:
@@ -46,69 +46,67 @@ Push notifications are sent through the application. We use push for:
4646
When a push notification is used to deliver a page, you will have the option to acknowledge, reroute, or snooze the incident straight from the notification.
4747

4848
.. image:: /_images/spoc/notif-types1.png
49-
:width: 100%
49+
:width: 35%
5050
:alt: Splunk On-Call push notification.
5151

52-
5352
.. raw:: html
54-
55-
<embed>
56-
<h2>SMS</h2>
57-
</embed>
53+
54+
<embed>
55+
<h2>SMS<a name="sms" class="headerlink" href="#sms" title="Permalink to this headline">¶</a></h2>
56+
</embed>
5857

5958
SMS notifications can be used in your personal paging policy. The message you receive is, at most, 160 characters, and it displays the
6059
incident number, entity_display_name, and response code if two-way SMS is supported. When you receive an SMS notification, two codes are included in the message so you can acknowledge aor resolve the alert by responding with the correct five-digit code. These response codes expire after 1 hour.
6160

6261
.. image:: /_images/spoc/notif-types2.png
63-
:width: 100%
62+
:width: 35%
6463
:alt: Splunk On-Call SMS notification.
6564

66-
6765
.. raw:: html
68-
69-
<embed>
70-
<h2>SMS Subscription Management</h2>
71-
</embed>
66+
67+
<embed>
68+
<h3>SMS Subscription Management<a name="sms-subscription" class="headerlink" href="#sms-subscription" title="Permalink to this headline">¶</a></h3>
69+
</embed>
7270

7371
You may stop and start our SMS notification subscription by replying to the message with STOP or START. Although, it is best to manage your notifications from the personal profile page in Splunk On-Call.
7472

7573
.. raw:: html
76-
77-
<embed>
78-
<h2>WhatsApp</h2>
79-
</embed>
74+
75+
<embed>
76+
<h2>WhatsApp<a name="whatsapp" class="headerlink" href="#whatsapp" title="Permalink to this headline">¶</a></h2>
77+
</embed>
8078

8179
You can use WhatsApp notifications in your personal paging policy. To enable WhatsApp, download and configure the WhatsApp application from the Apple App Store or Google Play Store. Next, access your user profile in Splunk On-Call and enter and verify your mobile number. After verification, an :guilabel:`Enable WhatsApp` button will appear next to the number and you'll be able to use WhatsApp in your Paging Policy.
8280

8381
.. raw:: html
84-
85-
<embed>
86-
<h2>Email</h2>
87-
</embed>
82+
83+
<embed>
84+
<h2>Email<a name="email" class="headerlink" href="#email" title="Permalink to this headline">¶</a></h2>
85+
</embed>
8886

8987
Emails can be used for pages. Emails can also be used as reminders that your Splunk On-Call instance is in :ref:`maintenance-mode`, or that you have a gap in your schedule due to a :ref:`scheduled-overrides` that is not covered.
9088

9189
.. image:: /_images/spoc/notif-types3.png
92-
:width: 100%
90+
:width: 75%
9391
:alt: Splunk On-Call email notification.
9492

9593
Scheduled Override:
9694

9795
.. image:: /_images/spoc/notif-types4.png
98-
:width: 100%
96+
:width: 75%
9997
:alt: Splunk On-Call scheduled override email.
10098

10199
Maintenance Mode:
102100

103101
.. image:: /_images/spoc/notif-types5.png
104-
:width: 100%
102+
:width: 75%
105103
:alt: Splunk On-Call scheduled maintenance override.
106104

107105
.. raw:: html
108-
109-
<embed>
110-
<h2>Phone</h2>
111-
</embed>
106+
107+
<embed>
108+
<h2>Phone<a name="phone" class="headerlink" href="#phone" title="Permalink to this headline">¶</a></h2>
109+
</embed>
112110

113111
Phone calls are used for paging. The “entity_display_name” field is read
114112
aloud and then an option to acknowledge or resolve the alert is offered.

0 commit comments

Comments
 (0)