Merge pull request #235 from calebschoepp/quick-fixes

Quick fixes

Author: calebschoepp

content/en/docs/reference/spin-app-executor.md

@@ -98,7 +98,8 @@ createDeployment is true.<br/>
 <small>[back to parent](#spinappexecutorspec)</small>
 
 
-DeploymentConfig specifies how the deployment should be configured when createDeployment is true.
+DeploymentConfig specifies how the deployment should be configured when
+createDeployment is true.
 
 <table>
     <thead>
@@ -136,10 +137,10 @@ defined in `CACertSecret` the secret name will be `spin-ca`.<br/>
         </td>
         <td>false</td>
       </tr><tr>
-        <td><b>otel</b></td>
-        <td>string</td>
+        <td><b><a href="#spinappexecutorspecdeploymentconfigotel">otel</a></b></td>
+        <td>object</td>
         <td>
-          Otel creates environment variables which configure where and how telemetry data is exported from the Spin app.
+          Otel provides Kubernetes Bindings to Otel Variables.<br/>
         </td>
         <td>false</td>
       </tr></tbody>
@@ -149,7 +150,7 @@ defined in `CACertSecret` the secret name will be `spin-ca`.<br/>
 
 <small>[back to parent](#spinappexecutorspecdeploymentconfig)</small>
 
-Otel creates environment variables which configure where and how telemetry data is exported from the Spin app.
+Otel provides Kubernetes Bindings to Otel Variables.
 
 <table>
     <thead>
@@ -161,32 +162,32 @@ Otel creates environment variables which configure where and how telemetry data
         </tr>
     </thead>
     <tbody><tr>
-      <td><b>exporter_otlp_endpoint</b></td>
-      <td>string</td>
-      <td>
-        Defines an endpoint to where all metrics, log, and trace data are exported.
-      </td>
-      <td>false</td>
-    </tr><tr>
-      <td><b>exporter_otlp_traces_endpoint</b></td>
-      <td>string</td>
-      <td>
-        Defines an endpoint to where all trace data are exported.
-      </td>
-      <td>false</td>
-    </tr><tr>
-      <td><b>exporter_otlp_metrics_endpoint</b></td>
-      <td>string</td>
-      <td>
-        Defines an endpoint to where all metrics data are exported.
-      </td>
-      <td>false</td>
-    </tr><tr>
-      <td><b>exporter_otlp_logs_endpoint</b></td>
-      <td>string</td>
-      <td>
-        Defines an endpoint to where all log data are exported.
-      </td>
-      <td>false</td>
-    </tr>
-
+        <td><b>exporter_otlp_endpoint</b></td>
+        <td>string</td>
+        <td>
+          ExporterOtlpEndpoint configures the default combined otlp endpoint for sending telemetry<br/>
+        </td>
+        <td>false</td>
+      </tr><tr>
+        <td><b>exporter_otlp_logs_endpoint</b></td>
+        <td>string</td>
+        <td>
+          ExporterOtlpLogsEndpoint configures the logs-specific otlp endpoint<br/>
+        </td>
+        <td>false</td>
+      </tr><tr>
+        <td><b>exporter_otlp_metrics_endpoint</b></td>
+        <td>string</td>
+        <td>
+          ExporterOtlpMetricsEndpoint configures the metrics-specific otlp endpoint<br/>
+        </td>
+        <td>false</td>
+      </tr><tr>
+        <td><b>exporter_otlp_traces_endpoint</b></td>
+        <td>string</td>
+        <td>
+          ExporterOtlpTracesEndpoint configures the trace-specific otlp endpoint<br/>
+        </td>
+        <td>false</td>
+      </tr></tbody>
+</table>

content/en/docs/topics/monitoring-your-app.md

@@ -17,14 +17,16 @@ Please ensure you have the following tools installed before continuing:
 ## About OpenTelemetry Collector
 
 From the OpenTelemetry [documentation](https://opentelemetry.io/docs/collector/):
->> The OpenTelemetry Collector offers a vendor-agnostic implementation of how to receive, process and export telemetry data. It removes the need to run, operate, and maintain multiple agents/collectors. This works with improved scalability and supports open source observability data formats (e.g. Jaeger, Prometheus, Fluent Bit, etc.) sending to one or more open source or commercial backends.
+
+> The OpenTelemetry Collector offers a vendor-agnostic implementation of how to receive, process and export telemetry data. It removes the need to run, operate, and maintain multiple agents/collectors. This works with improved scalability and supports open source observability data formats (e.g. Jaeger, Prometheus, Fluent Bit, etc.) sending to one or more open source or commercial backends.
 
 In our case, the OpenTelemetry collector serves as a single endpoint to receive and route telemetry data, letting us to monitor metrics, traces, and logs via our preferred UIs.
 
 ## About Jaeger
 
 From the Jaeger [documentation](https://www.jaegertracing.io/docs/):
->> Jaeger is a distributed tracing platform released as open source by Uber Technologies. With Jaeger you can: Monitor and troubleshoot distributed workflows, Identify performance bottlenecks, Track down root causes, Analyze service dependencies
+
+> Jaeger is a distributed tracing platform released as open source by Uber Technologies. With Jaeger you can: Monitor and troubleshoot distributed workflows, Identify performance bottlenecks, Track down root causes, Analyze service dependencies
 
 Here, we have the OpenTelemetry collector send the trace data to Jaeger.
 
@@ -150,4 +152,4 @@ To view the traces in Jaeger, use the following port-forward command:
 kubectl port-forward svc/jaeger-query 16686:16686
 ```
 
-Then, open your browser and navigate to `localhost:16686` to interact with Jaeger's UI.
+Then, open your browser and navigate to `localhost:16686` to interact with Jaeger's UI.