Merge branch 'main' of github.com:splunk/private-o11y-docs

Author: theletterf

_includes/realm-note.rst

@@ -1,4 +1,4 @@
-.. note:: Note about realms
+.. note:: About realms
 
    A realm is a self-contained deployment of Splunk Observability Cloud in which your organization is hosted. Different realms have different API endpoints. For example, the endpoint for sending data in the ``us1`` realm is ``https://ingest.us1.signalfx.com``, while the endpoint for sending data in the ``eu0`` realm is ``https://ingest.eu0.signalfx.com``.
 

_templates/404.html

@@ -57,11 +57,13 @@
 <script>
     const getBarConfig = () => {
         const customTheme = ``;
+        const language = window.location.pathname.includes('/ja/') ? 'ja' : 'en';
 
         return {
             customTheme,
             env: window.location.hostname.includes('splunk') ? 'prod' : 'dev',
-            language: 'en',
+            language: language,
+            suiLanguage: language,
             layoutTemplate: "docsResultLayout",
             showSearchButton: false,
             searchBarRedirectUrl: 'https://docs.splunk.com/observability/en/search.html',

_templates/banner.html

@@ -102,6 +102,9 @@
         <li class="nav-item">
           <a class="nav-link newnavbar" href="https://www.splunk.com/en_us/training/course-catalog.html?sort=Newest&filters=filterGroup4SplunkObservabilityCloud%2CfilterGroup4SplunkSyntheticMonitoring%2CfilterGroup4SplunkInfrastructureMonitoring%2CfilterGroup4SplunkITSI%2CfilterGroup4SplunkAPM%2CfilterGroup4SplunkOnCall%2CfilterGroup4SplunkRUM%2CfilterGroup4SplunkLogObserver%2CfilterGroup4SplunkInsights" target="_blank">Training</a>
         </li>
+        <li class="nav-item nav-lang">
+          <span class="lang" data-lang="en">EN</span> | <span class="lang" data-lang="ja">JA</span>
+        </li>
         <li class="nav-item">
           <a class="nav-link newnavbar" href="https://www.splunk.com/en_us/download/infrastructure-monitoring.html" target="_blank" style="
           font-size: 12px;
@@ -118,6 +121,78 @@
       </ul>
       </div>
 
+      <style>
+        .nav-lang{
+          margin-top: 18px;
+          color:darkgrey;
+        }
+        .active-lang {
+          font-weight: bold;
+          color: white !important;
+        }
+        .lang{
+          cursor:pointer;
+        }
+      </style>
+      <script>
+        $(document).ready(function() {
+          function setActiveLanguage() {
+            var path = window.location.pathname;
+            $('.lang').each(function() {
+              var lang = $(this).data('lang');
+              if (path.includes('/' + lang + '/')) {
+                $(this).addClass('active-lang').css({
+                  "font-weight": "bold",
+                  "color": "red"
+                });
+                updateLinks(lang);
+              } else {
+                $(this).removeClass('active-lang').removeAttr('style');
+              }
+            });
+          }
+
+          function constructNewPath(lang) {
+            var currentPath = window.location.pathname;
+            var pathSegments = currentPath.split('/');
+            var langIndex = pathSegments.findIndex(segment => $('.lang').map(function() { return $(this).data('lang'); }).get().includes(segment));
+
+            if (langIndex > -1) {
+              pathSegments[langIndex] = lang;
+            } else {
+              pathSegments.splice(1, 0, lang);
+            }
+
+            return pathSegments.join('/');
+          }
+
+          function updateLinks(lang) {
+            var currentPath = window.location.pathname;
+            var lang = "en";
+            if(currentPath.includes('/ja/')) {
+              lang = "ja";
+            }
+
+            $("a.nav-link.newnavbar").each(function() {
+              var href = $(this).attr("href");
+              if(href && (href.includes('observability/en/') || href.includes('Observability/en/'))) {
+                $(this).attr("href", href.replace('observability/en/', 'observability/' + lang + '/'));
+              }
+            });
+          }
+
+          $('.lang').click(function() {
+            var lang = $(this).data('lang');
+            var newPath = constructNewPath(lang);
+            window.location.pathname = newPath;
+
+            setActiveLanguage();
+          });
+
+          setActiveLanguage();
+        });
+      </script>
+
       <div id="mobileSideBar">
         {%- block sidebar2 %}{{ sidebar() }}{% endblock %}
       </div>

_templates/layout.html

@@ -59,11 +59,13 @@
 <script>
     const getBarConfig = () => {
         const customTheme = ``;
+        const language = window.location.pathname.includes('/ja/') ? 'ja' : 'en';
 
         return {
             customTheme,
             env: window.location.hostname.includes('splunk') ? 'prod' : 'dev',
-            language: 'en',
+            language: language,
+            suiLanguage: language,
             layoutTemplate: "docsResultLayout",
             showSearchButton: false,
             searchBarRedirectUrl: 'https://docs.splunk.com/observability/en/search.html',

_templates/search.html

@@ -95,14 +95,16 @@
             eventCallback: parentCallback
         }
 
+        const language = window.location.pathname.includes('/ja/') ? 'ja' : 'en';
         return {
             customTheme,
             sortOptions,
             areas: "docs_observability,dev,main, docs",
             facets: "source_name_s,docProduct_s,docVersion_s",
             enableDateRangeFilter: true,
             env: window.location.hostname.includes('splunk') ? 'prod' : 'dev',
-            language: "en",
+            language: language,
+            suiLanguage: language,
             layoutTemplate: "docsResultLayout",
             analytics,
             analyticsConfig: {

admin/authentication/allow-services.rst

@@ -163,7 +163,13 @@ If your organization's networking security policies require you to individually
 
    \*.<YOUR_REALM>.signalfx.com
 
-If you're unable to allow all URLs as shown here, see :ref:`allow-domains`.
+You also need to allow the following URLs:
+
+* packages.treasuredata.com
+* splunk.jfrog.io 
+* jfrog-prod-use1-shared-virginia-main.s3.amazonaws.com
+
+If you're unable to allow all the URLs listed in this section, see :ref:`allow-domains`.
 
 .. _allow-domains:
 
@@ -202,5 +208,6 @@ If you're unable to allow all URLs as described in :ref:`allow-urls`, ensure tha
    
    # For DEB/RPM collector packages
    splunk.jfrog.io 
+   jfrog-prod-use1-shared-virginia-main.s3.amazonaws.com
    
 .. note:: For more information, see the :new-page:`Endpoint Summary <https://dev.splunk.com/observability/docs/apibasics/api_list>` topic in the Observability Cloud Developer Guide.

apm/set-up-apm/apm-gdi.rst

@@ -121,10 +121,16 @@ In the following table, follow the instrumentation steps for the language that e
    * - PHP
      - OpenTelemetry instrumentation for PHP
      - :ref:`get-started-php`
+   
+   * - Rust
+     - OpenTelemetry instrumentation for Rust
+     - :ref:`get-started-rust`
 
-After you instrument your applications, you're ready to verify that your data is coming in.
+   * - Erlang
+     - OpenTelemetry instrumentation for Erlang
+     - :ref:`get-started-erlang`
 
-.. note:: To instrument applications or services written in languages other than the ones listed here, see :ref:`apm-instrumentation-other-langs`.
+After you instrument your applications, you're ready to verify that your data is coming in.
 
 .. _verify-apm-data:
 

gdi/get-data-in/application/application.rst

@@ -17,7 +17,8 @@ Instrument back-end applications to send spans to Splunk APM
    Instrument a Python application TOGGLE <python/get-started>
    Instrument a Ruby application TOGGLE <ruby/get-started>
    Instrument a PHP application TOGGLE <php/get-started>
-   Instrument applications written in other programming languages <other-languages>
+   Instrument a Rust application TOGGLE <rust/get-started>
+   Instrument an Erlang application TOGGLE <erlang/get-started>
    Send spans from the Istio service mesh <istio/istio>
 
 You can instrument your back-end services and applications to send metrics and traces to Splunk Observability Cloud.
@@ -89,14 +90,11 @@ You can instrument applications in each of these languages using official Splunk
 - :ref:`Python <get-started-python>`
 - :ref:`Ruby <get-started-ruby>`
 - :ref:`PHP <get-started-php>`
+- :ref:`Rust <get-started-rust>`
+- :ref:`Erlang <get-started-erlang>`
 
 To send spans from the Istio service mesh, see :ref:`get-started-istio`.
 
-You can also send traces from applications written in languages for which Splunk instrumentation isn't available:
-
-- :ref:`Erlang <apm-instrumentation-other-langs>`
-- :ref:`Rust <apm-instrumentation-other-langs>`
-
 To learn more about the data collected by Splunk Observability Cloud, see:
 
 - :ref:`data-model`

gdi/get-data-in/application/erlang/get-started.rst

@@ -0,0 +1,21 @@
+.. _get-started-erlang:
+
+*****************************************************************
+Instrument Erlang applications for Splunk Observability Cloud
+*****************************************************************
+
+.. meta:: 
+    :description: Get started with instrumenting your Erlang applications for Splunk Observability Cloud.
+
+.. toctree::
+    :hidden:
+
+    Requirements <requirements>
+    Instrument your Erlang application <instrument-erlang>
+
+You can send application traces and metrics from your Erlang applications to Splunk Observability Cloud using the OpenTelemetry instrumentation for Erlang.
+
+To instrument your Erlang applications, follow these steps:
+
+#. Make sure you've met the prerequisites. See :ref:`requirements-erlang`
+#. Instrument your application. See :ref:`instrument-erlang`

gdi/get-data-in/application/erlang/instrument-erlang.rst

@@ -0,0 +1,105 @@
+.. _instrument-erlang:
+
+*************************************************************************
+Instrument your Erlang application for Splunk Observability Cloud
+*************************************************************************
+
+.. meta:: 
+    :description: Learn how to instrument your Erlang application using the OpenTelemetry instrumentation for Erlang and send your application traces to Splunk Observability Cloud.
+
+You can send traces from your Erlang applications using the OpenTelemetry instrumentation for Erlang. To get started, follow these instructions.
+
+.. _erlang-add-dependencies:
+
+1. Add the required dependencies or packages
+==================================================
+
+To instrument your application for Splunk Observability Cloud, you need to generate traces and spans that follow the OpenTelemetry format and semantic conventions. Add the required OpenTelemetry dependencies to your project, including gRPC communication libraries for communicating with the Splunk OpenTelemetry Collector.
+
+Add the OpenTelemetry packages to the list of dependencies in your rebar.config file:
+
+.. code-block:: Erlang
+
+    %% rebar.config file
+
+    {deps, [opentelemetry_api
+            opentelemetry,
+            opentelemetry_exporter]}.
+
+You also must add them to the ``Applications`` section, together with gRPC libraries:
+
+.. code-block:: erlang
+
+    %% app.src file
+
+    {applications,
+     [kernel,
+     stdlib,
+     opentelemetry_api,
+     opentelemetry,
+     opentelemetry_exporter
+    ]},
+
+.. _erlang-init-tracer:
+
+2. Initialize the OpenTelemetry tracer
+=================================================
+
+In your application code, initialize the OpenTelemetry library and tracer like in the following example:
+
+.. code-block:: erlang
+
+    -module(otel_getting_started).
+
+    -export([hello/0]).
+
+    -include_lib("opentelemetry_api/include/otel_tracer.hrl").
+
+Erlang automatically initializes the tracer.
+
+.. _erlang-generate-spans:
+
+3. Generate spans for your application
+==================================================
+
+In your Erlang application code, create spans for the operations you want to track.
+
+The following example shows how to create spans that have attributes or tags:
+
+.. code-block:: erlang
+
+    hello() ->
+        %% start an active span and run a local function
+        ?with_span(<<"operation">>, #{}, fun nice_operation/1).
+
+    nice_operation(_SpanCtx) ->
+        ?add_event(<<"Nice operation!">>, [{<<"bogons">>, 100}]),
+        ?set_attributes([{another_key, <<"yes">>}]),
+
+        %% start an active span and run an anonymous function
+        ?with_span(<<"Sub operation...">>, #{},
+                fun(_ChildSpanCtx) ->
+                    ?set_attributes([{lemons_key, <<"five">>}]),
+                    ?add_event(<<"Sub span event!">>, [])
+                end).
+
+.. _export-directly-to-olly-cloud-erlang:
+
+Send data directly to Splunk Observability Cloud
+==================================================
+
+By default, all telemetry goes to the local instance of the Splunk Distribution of OpenTelemetry Collector.
+
+If you need to send data directly to Splunk Observability Cloud, set the following environment variables. When instrumenting Rust applications or services you might need to read the values of the environment variables first.
+
+.. code-block:: shell
+
+   OTEL_EXPORTER_OTLP_PROTOCOL=grpc
+   OTEL_EXPORTER_OTLP_TRACES_HEADERS=x-sf-token=<access_token>
+   OTEL_EXPORTER_OTLP_ENDPOINT=https://ingest.<realm>.signalfx.com
+
+To obtain an access token, see :ref:`admin-api-access-tokens`.
+
+To find your Splunk realm, see :ref:`Note about realms <about-realms>`.
+
+.. note:: For more information on the ingest API endpoints, see :new-page:`Send APM traces <https://dev.splunk.com/observability/docs/apm/send_traces/>`.