Merge pull request #128 from rancher/fix-api-endpoints

Update api endpoints documentation

Author: akashraj4261

docs/latest/modules/en/pages/setup/otel/getting-started/getting-started-k8s-operator.adoc

@@ -158,7 +158,7 @@ spec:
       otlp/suse-observability:
         auth:
           authenticator: bearertokenauth
-        # Put in your own otlp endpoint, for example suse-observability.my.company.com:443
+        # Put in your own otlp endpoint, for example otlp-suse-observability.my.company.com:443
         endpoint: <otlp-suse-observability-endpoint:port>
         compression: snappy
     processors:

docs/latest/modules/en/pages/setup/otel/getting-started/getting-started-k8s.adoc

@@ -97,7 +97,7 @@ config:
     otlp/suse-observability:
       auth:
         authenticator: bearertokenauth
-      # Put in your own otlp endpoint, for example suse-observability.my.company.com:443
+      # Put in your own otlp endpoint, for example otlp-suse-observability.my.company.com:443
       endpoint: <otlp-suse-observability-endpoint:port>
       compression: snappy
   processors:

docs/latest/modules/en/pages/setup/otel/getting-started/getting-started-lambda.adoc

@@ -86,7 +86,7 @@ config:
     otlp:
       auth:
         authenticator: bearertokenauth
-      # Put in your own otlp endpoint, for example suse-observability.my.company.com:443
+      # Put in your own otlp endpoint, for example otlp-suse-observability.my.company.com:443
       endpoint: <otlp-suse-observability-endpoint:port>
 
   service:

docs/latest/modules/en/pages/setup/otel/getting-started/getting-started-linux.adoc

@@ -129,7 +129,7 @@ exporters:
     compression: snappy
     auth:
       authenticator: bearertokenauth
-    # Put in your own otlp endpoint, for example suse-observability.my.company.com:443
+    # Put in your own otlp endpoint, for example otlp-suse-observability.my.company.com:443
     endpoint: <otlp-suse-observability-endpoint:port>
 processors:
   memory_limiter:

docs/latest/modules/en/pages/setup/otel/otlp-apis.adoc

@@ -9,8 +9,8 @@ SUSE Observability supports 2 versions of the OTLP protocol, the `grpc` version
 
 The endpoints for SUSE Cloud Observability are:
 
-* OTLP: `+https://otlp-<your-suse-observability>.app.stackstate.io:443+`
-* OTLP over HTTP: `+https://otlp-http-<your-suse-observability>.app.stackstate.io+`
+* OTLP: `+otlp-<your-suse-observability>.app.stackstate.io:443+` (without the URL scheme)
+* OTLP over HTTP: `+https://otlp-http-<your-suse-observability>.app.stackstate.io+` (with the URL scheme: `https`)
 
 == Self-hosted SUSE Observability
 
@@ -26,6 +26,8 @@ The GRPC protocol does not support sending credentials over an insecure connecti
 
 == Collector configuration
 
+=== OTLP protocol
+
 The examples in the collector configuration use the OTLP protocol like this:
 
 ----
@@ -37,14 +39,17 @@ exporters:
   otlp/suse-observability:
     auth:
       authenticator: bearertokenauth
+    # Put in your own otlp endpoint, for example otlp-suse-observability.my.company.com:443
     endpoint: <otlp-suse-observability-endpoint>
     # Optional TLS configurations:
     #tls:
     # To disable certificate verification (but still use TLS):
     #  insecure_skip_verify: true
 ----
 
-To use the OTLP over HTTP protocol instead use the `otlphttp` exporter instead. Don't forget to update the exporter references, `otlp/suse-observability`, in your pipelines to `otlphttp/suse-observability`!
+=== OTLP HTTP protocol
+
+To use the OTLP over HTTP protocol instead use the `otlphttp` exporter instead. Also update all exporter references in your pipelines from `otlp/suse-observability` to `otlphttp/suse-observability`! Use a find/replace to make sure you change all occurrences.
 
 ----
 extensions:
@@ -55,6 +60,7 @@ exporters:
   otlphttp/stackstate:
     auth:
       authenticator: bearertokenauth
+    # Put in your own otlp-http endpoint, for example https://otlp-http-suse-observability.my.company.com:443
     endpoint: <otlp-http-suse-observability-endpoint>
     # Optional TLS configurations:
     #tls: